zyphr 0.1.19 → 0.1.21

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 (102) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +47 -6
  3. data/docs/AuthEmailTemplate.md +42 -0
  4. data/docs/AuthEmailTemplateDefault.md +26 -0
  5. data/docs/AuthEmailTemplateDefaultResponse.md +20 -0
  6. data/docs/AuthEmailTemplateDeleteResponse.md +20 -0
  7. data/docs/{SuccessResultData.md → AuthEmailTemplateDeleteResponseData.md} +2 -2
  8. data/docs/AuthEmailTemplateListResponse.md +20 -0
  9. data/docs/AuthEmailTemplatePreviewDraft.md +28 -0
  10. data/docs/AuthEmailTemplatePreviewRequest.md +20 -0
  11. data/docs/AuthEmailTemplatePreviewResponse.md +20 -0
  12. data/docs/AuthEmailTemplatePreviewResult.md +26 -0
  13. data/docs/AuthEmailTemplateResponse.md +20 -0
  14. data/docs/AuthEmailTemplateTestRequest.md +20 -0
  15. data/docs/AuthEmailTemplateTestResponse.md +20 -0
  16. data/docs/AuthEmailTemplateTestResult.md +20 -0
  17. data/docs/AuthEmailTemplateVersion.md +38 -0
  18. data/docs/AuthEmailTemplateVersionsResponse.md +20 -0
  19. data/docs/AuthEmailTemplatesApi.md +782 -0
  20. data/docs/AuthEmailType.md +15 -0
  21. data/docs/BulkUpsertAuthEmailTemplatesRequest.md +22 -0
  22. data/docs/BulkUpsertAuthEmailTemplatesResponse.md +20 -0
  23. data/docs/ResubscribeResponse.md +1 -1
  24. data/docs/SendSlackMessageRequest.md +40 -0
  25. data/docs/SendSlackMessageResponse.md +20 -0
  26. data/docs/SendSlackMessageResult.md +28 -0
  27. data/docs/SlackApi.md +233 -0
  28. data/docs/SlackMessage.md +50 -0
  29. data/docs/SlackMessageListResponse.md +20 -0
  30. data/docs/SlackMessageListResponseMeta.md +24 -0
  31. data/docs/SlackMessageResponse.md +20 -0
  32. data/docs/SlackMessageStatus.md +15 -0
  33. data/docs/SlackMessageSummary.md +38 -0
  34. data/docs/SuccessResult.md +1 -1
  35. data/docs/UpsertAuthEmailTemplateRequest.md +34 -0
  36. data/lib/zyphr/api/auth_email_templates_api.rb +688 -0
  37. data/lib/zyphr/api/slack_api.rb +233 -0
  38. data/lib/zyphr/models/auth_email_template.rb +372 -0
  39. data/lib/zyphr/models/auth_email_template_default.rb +281 -0
  40. data/lib/zyphr/models/auth_email_template_default_response.rb +229 -0
  41. data/lib/zyphr/models/auth_email_template_delete_response.rb +229 -0
  42. data/lib/zyphr/models/{success_result_data.rb → auth_email_template_delete_response_data.rb} +3 -3
  43. data/lib/zyphr/models/auth_email_template_list_response.rb +231 -0
  44. data/lib/zyphr/models/auth_email_template_preview_draft.rb +272 -0
  45. data/lib/zyphr/models/auth_email_template_preview_request.rb +232 -0
  46. data/lib/zyphr/models/auth_email_template_preview_response.rb +229 -0
  47. data/lib/zyphr/models/auth_email_template_preview_result.rb +258 -0
  48. data/lib/zyphr/models/auth_email_template_response.rb +229 -0
  49. data/lib/zyphr/models/auth_email_template_test_request.rb +249 -0
  50. data/lib/zyphr/models/auth_email_template_test_response.rb +229 -0
  51. data/lib/zyphr/models/auth_email_template_test_result.rb +229 -0
  52. data/lib/zyphr/models/auth_email_template_version.rb +352 -0
  53. data/lib/zyphr/models/auth_email_template_versions_response.rb +231 -0
  54. data/lib/zyphr/models/auth_email_type.rb +41 -0
  55. data/lib/zyphr/models/bulk_upsert_auth_email_templates_request.rb +239 -0
  56. data/lib/zyphr/models/bulk_upsert_auth_email_templates_response.rb +231 -0
  57. data/lib/zyphr/models/resubscribe_response.rb +1 -1
  58. data/lib/zyphr/models/send_slack_message_request.rb +340 -0
  59. data/lib/zyphr/models/send_slack_message_response.rb +229 -0
  60. data/lib/zyphr/models/send_slack_message_result.rb +289 -0
  61. data/lib/zyphr/models/slack_message.rb +406 -0
  62. data/lib/zyphr/models/slack_message_list_response.rb +231 -0
  63. data/lib/zyphr/models/slack_message_list_response_meta.rb +254 -0
  64. data/lib/zyphr/models/slack_message_response.rb +229 -0
  65. data/lib/zyphr/models/slack_message_status.rb +43 -0
  66. data/lib/zyphr/models/slack_message_summary.rb +340 -0
  67. data/lib/zyphr/models/success_result.rb +1 -1
  68. data/lib/zyphr/models/upsert_auth_email_template_request.rb +335 -0
  69. data/lib/zyphr.rb +31 -1
  70. data/spec/api/auth_email_templates_api_spec.rb +157 -0
  71. data/spec/api/slack_api_spec.rb +75 -0
  72. data/spec/models/auth_email_template_default_response_spec.rb +42 -0
  73. data/spec/models/auth_email_template_default_spec.rb +60 -0
  74. data/spec/models/{success_result_data_spec.rb → auth_email_template_delete_response_data_spec.rb} +6 -6
  75. data/spec/models/auth_email_template_delete_response_spec.rb +42 -0
  76. data/spec/models/auth_email_template_list_response_spec.rb +42 -0
  77. data/spec/models/auth_email_template_preview_draft_spec.rb +66 -0
  78. data/spec/models/auth_email_template_preview_request_spec.rb +42 -0
  79. data/spec/models/auth_email_template_preview_response_spec.rb +42 -0
  80. data/spec/models/auth_email_template_preview_result_spec.rb +60 -0
  81. data/spec/models/auth_email_template_response_spec.rb +42 -0
  82. data/spec/models/auth_email_template_spec.rb +112 -0
  83. data/spec/models/auth_email_template_test_request_spec.rb +42 -0
  84. data/spec/models/auth_email_template_test_response_spec.rb +42 -0
  85. data/spec/models/auth_email_template_test_result_spec.rb +42 -0
  86. data/spec/models/auth_email_template_version_spec.rb +100 -0
  87. data/spec/models/auth_email_template_versions_response_spec.rb +42 -0
  88. data/spec/models/auth_email_type_spec.rb +30 -0
  89. data/spec/models/bulk_upsert_auth_email_templates_request_spec.rb +48 -0
  90. data/spec/models/bulk_upsert_auth_email_templates_response_spec.rb +42 -0
  91. data/spec/models/send_slack_message_request_spec.rb +102 -0
  92. data/spec/models/send_slack_message_response_spec.rb +42 -0
  93. data/spec/models/send_slack_message_result_spec.rb +66 -0
  94. data/spec/models/slack_message_list_response_meta_spec.rb +54 -0
  95. data/spec/models/slack_message_list_response_spec.rb +42 -0
  96. data/spec/models/slack_message_response_spec.rb +42 -0
  97. data/spec/models/slack_message_spec.rb +132 -0
  98. data/spec/models/slack_message_status_spec.rb +30 -0
  99. data/spec/models/slack_message_summary_spec.rb +96 -0
  100. data/spec/models/upsert_auth_email_template_request_spec.rb +88 -0
  101. data/zyphr.gemspec +1 -1
  102. metadata +126 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7fdd3e435ef1d46a572b992085fb931fbcbcdd7bbbb5e7b18acd98a46026b2c3
4
- data.tar.gz: 9fa61d3546fd88327740d55a0f043579ab2b14e381d5292c5ed9d380ff60c45b
3
+ metadata.gz: e75874c981fc43e5c9d062663c83994e0b36056e5900a8cd2c7fb83c6c6b70d1
4
+ data.tar.gz: 27f41a3ec7e4a6c8dba12f7e3f7290badff1452849469d53e2ccdf46a6e9c99d
5
5
  SHA512:
6
- metadata.gz: 75f321d8cf7847769c4c9f1a7f15936c2b55063046bc7be4c022a5cfd7493f89aedcab7d1e215a13c65d3cbf6f2026d98291b27a63b0cc482692d1811d85b748
7
- data.tar.gz: b44f62bc08856f0a35e4978c932b1a12b4a712e53a375126ab2c40c53a81256574181a6bc5fe64114ab3afdade27b3339904e9e613b6b9050327c11eac96d055
6
+ metadata.gz: ffced373257589887f08d647f3363e0dd26b2387481d8f04ced7a5fa5438dba4aca35f1f5d6babcc65ed9bed79887fc57ed8b1d7e8e405b0a9d4f7c8a08c0f0c
7
+ data.tar.gz: f8ac7dafb92a7dee945fe94157a53a6ce81f94f08ef52b3a059bcad76a2722b45b8e8d5854eb4336a5b78668a7d747ef2d37f18f3537c580f66086667417f1b8
data/README.md CHANGED
@@ -110,15 +110,15 @@ Zyphr.configure do |config|
110
110
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
111
111
  end
112
112
 
113
- api_instance = Zyphr::AuthEmailVerificationApi.new
114
- confirm_email_verification_request = Zyphr::ConfirmEmailVerificationRequest.new({token: 'token_example'}) # ConfirmEmailVerificationRequest |
113
+ api_instance = Zyphr::AuthEmailTemplatesApi.new
114
+ bulk_upsert_auth_email_templates_request = Zyphr::BulkUpsertAuthEmailTemplatesRequest.new # BulkUpsertAuthEmailTemplatesRequest |
115
115
 
116
116
  begin
117
- #Confirm email verification
118
- result = api_instance.confirm_email_verification(confirm_email_verification_request)
117
+ #Bulk-upsert auth email templates
118
+ result = api_instance.bulk_upsert_auth_email_templates(bulk_upsert_auth_email_templates_request)
119
119
  p result
120
120
  rescue Zyphr::ApiError => e
121
- puts "Exception when calling AuthEmailVerificationApi->confirm_email_verification: #{e}"
121
+ puts "Exception when calling AuthEmailTemplatesApi->bulk_upsert_auth_email_templates: #{e}"
122
122
  end
123
123
 
124
124
  ```
@@ -129,6 +129,16 @@ All URIs are relative to *https://api.zyphr.dev/v1*
129
129
 
130
130
  Class | Method | HTTP request | Description
131
131
  ------------ | ------------- | ------------- | -------------
132
+ *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
+ *Zyphr::AuthEmailTemplatesApi* | [**delete_auth_email_template**](docs/AuthEmailTemplatesApi.md#delete_auth_email_template) | **DELETE** /auth/email-templates/{type} | Remove a tenant override
134
+ *Zyphr::AuthEmailTemplatesApi* | [**get_auth_email_template**](docs/AuthEmailTemplatesApi.md#get_auth_email_template) | **GET** /auth/email-templates/{type} | Get an auth email template
135
+ *Zyphr::AuthEmailTemplatesApi* | [**get_auth_email_template_default**](docs/AuthEmailTemplatesApi.md#get_auth_email_template_default) | **GET** /auth/email-templates/{type}/default | Get the system default template
136
+ *Zyphr::AuthEmailTemplatesApi* | [**list_auth_email_template_versions**](docs/AuthEmailTemplatesApi.md#list_auth_email_template_versions) | **GET** /auth/email-templates/{type}/versions | List version history for a template
137
+ *Zyphr::AuthEmailTemplatesApi* | [**list_auth_email_templates**](docs/AuthEmailTemplatesApi.md#list_auth_email_templates) | **GET** /auth/email-templates | List auth email templates
138
+ *Zyphr::AuthEmailTemplatesApi* | [**preview_auth_email_template**](docs/AuthEmailTemplatesApi.md#preview_auth_email_template) | **POST** /auth/email-templates/{type}/preview | Render a template with sample variables
139
+ *Zyphr::AuthEmailTemplatesApi* | [**restore_auth_email_template_version**](docs/AuthEmailTemplatesApi.md#restore_auth_email_template_version) | **POST** /auth/email-templates/{type}/versions/{version}/restore | Restore a previous version
140
+ *Zyphr::AuthEmailTemplatesApi* | [**send_auth_email_template_test**](docs/AuthEmailTemplatesApi.md#send_auth_email_template_test) | **POST** /auth/email-templates/{type}/test | Send a test render of a template
141
+ *Zyphr::AuthEmailTemplatesApi* | [**upsert_auth_email_template**](docs/AuthEmailTemplatesApi.md#upsert_auth_email_template) | **PUT** /auth/email-templates/{type} | Create or update an auth email template
132
142
  *Zyphr::AuthEmailVerificationApi* | [**confirm_email_verification**](docs/AuthEmailVerificationApi.md#confirm_email_verification) | **POST** /auth/verify-email/confirm | Confirm email verification
133
143
  *Zyphr::AuthEmailVerificationApi* | [**resend_email_verification**](docs/AuthEmailVerificationApi.md#resend_email_verification) | **POST** /auth/verify-email/resend | Resend email verification
134
144
  *Zyphr::AuthEmailVerificationApi* | [**send_email_verification**](docs/AuthEmailVerificationApi.md#send_email_verification) | **POST** /auth/verify-email/send | Send email verification
@@ -227,6 +237,9 @@ Class | Method | HTTP request | Description
227
237
  *Zyphr::SMSApi* | [**send_test_sms**](docs/SMSApi.md#send_test_sms) | **POST** /sms/test | Send a test SMS
228
238
  *Zyphr::SMSApi* | [**upsert_sms_config**](docs/SMSApi.md#upsert_sms_config) | **POST** /sms/config | Create or update SMS configuration
229
239
  *Zyphr::SMSApi* | [**verify_sms_config**](docs/SMSApi.md#verify_sms_config) | **POST** /sms/config/verify | Verify SMS configuration
240
+ *Zyphr::SlackApi* | [**get_slack_message**](docs/SlackApi.md#get_slack_message) | **GET** /slack/messages/{id} | Get a Slack message
241
+ *Zyphr::SlackApi* | [**list_slack_messages**](docs/SlackApi.md#list_slack_messages) | **GET** /slack/messages | List Slack messages
242
+ *Zyphr::SlackApi* | [**send_slack_message**](docs/SlackApi.md#send_slack_message) | **POST** /slack/send | Send a Slack message
230
243
  *Zyphr::SubscribersApi* | [**create_category**](docs/SubscribersApi.md#create_category) | **POST** /subscribers/categories | Create a notification category
231
244
  *Zyphr::SubscribersApi* | [**create_subscriber**](docs/SubscribersApi.md#create_subscriber) | **POST** /subscribers | Create or update a subscriber
232
245
  *Zyphr::SubscribersApi* | [**delete_category**](docs/SubscribersApi.md#delete_category) | **DELETE** /subscribers/categories/{id} | Delete a category
@@ -322,6 +335,23 @@ Class | Method | HTTP request | Description
322
335
  - [Zyphr::ApiError](docs/ApiError.md)
323
336
  - [Zyphr::ApiErrorError](docs/ApiErrorError.md)
324
337
  - [Zyphr::ApiErrorMeta](docs/ApiErrorMeta.md)
338
+ - [Zyphr::AuthEmailTemplate](docs/AuthEmailTemplate.md)
339
+ - [Zyphr::AuthEmailTemplateDefault](docs/AuthEmailTemplateDefault.md)
340
+ - [Zyphr::AuthEmailTemplateDefaultResponse](docs/AuthEmailTemplateDefaultResponse.md)
341
+ - [Zyphr::AuthEmailTemplateDeleteResponse](docs/AuthEmailTemplateDeleteResponse.md)
342
+ - [Zyphr::AuthEmailTemplateDeleteResponseData](docs/AuthEmailTemplateDeleteResponseData.md)
343
+ - [Zyphr::AuthEmailTemplateListResponse](docs/AuthEmailTemplateListResponse.md)
344
+ - [Zyphr::AuthEmailTemplatePreviewDraft](docs/AuthEmailTemplatePreviewDraft.md)
345
+ - [Zyphr::AuthEmailTemplatePreviewRequest](docs/AuthEmailTemplatePreviewRequest.md)
346
+ - [Zyphr::AuthEmailTemplatePreviewResponse](docs/AuthEmailTemplatePreviewResponse.md)
347
+ - [Zyphr::AuthEmailTemplatePreviewResult](docs/AuthEmailTemplatePreviewResult.md)
348
+ - [Zyphr::AuthEmailTemplateResponse](docs/AuthEmailTemplateResponse.md)
349
+ - [Zyphr::AuthEmailTemplateTestRequest](docs/AuthEmailTemplateTestRequest.md)
350
+ - [Zyphr::AuthEmailTemplateTestResponse](docs/AuthEmailTemplateTestResponse.md)
351
+ - [Zyphr::AuthEmailTemplateTestResult](docs/AuthEmailTemplateTestResult.md)
352
+ - [Zyphr::AuthEmailTemplateVersion](docs/AuthEmailTemplateVersion.md)
353
+ - [Zyphr::AuthEmailTemplateVersionsResponse](docs/AuthEmailTemplateVersionsResponse.md)
354
+ - [Zyphr::AuthEmailType](docs/AuthEmailType.md)
325
355
  - [Zyphr::AuthLoginResponse](docs/AuthLoginResponse.md)
326
356
  - [Zyphr::AuthLoginResult](docs/AuthLoginResult.md)
327
357
  - [Zyphr::AuthLoginResultMfaChallenge](docs/AuthLoginResultMfaChallenge.md)
@@ -334,6 +364,8 @@ Class | Method | HTTP request | Description
334
364
  - [Zyphr::AuthUserResponseData](docs/AuthUserResponseData.md)
335
365
  - [Zyphr::BatchPublishWaaSEvents201Response](docs/BatchPublishWaaSEvents201Response.md)
336
366
  - [Zyphr::BulkRetryWebhookDeliveriesRequest](docs/BulkRetryWebhookDeliveriesRequest.md)
367
+ - [Zyphr::BulkUpsertAuthEmailTemplatesRequest](docs/BulkUpsertAuthEmailTemplatesRequest.md)
368
+ - [Zyphr::BulkUpsertAuthEmailTemplatesResponse](docs/BulkUpsertAuthEmailTemplatesResponse.md)
337
369
  - [Zyphr::Category](docs/Category.md)
338
370
  - [Zyphr::CategoryListResponse](docs/CategoryListResponse.md)
339
371
  - [Zyphr::CategoryResponse](docs/CategoryResponse.md)
@@ -519,6 +551,9 @@ Class | Method | HTTP request | Description
519
551
  - [Zyphr::SendPushToTopicData](docs/SendPushToTopicData.md)
520
552
  - [Zyphr::SendPushToTopicRequest](docs/SendPushToTopicRequest.md)
521
553
  - [Zyphr::SendPushToTopicResponse](docs/SendPushToTopicResponse.md)
554
+ - [Zyphr::SendSlackMessageRequest](docs/SendSlackMessageRequest.md)
555
+ - [Zyphr::SendSlackMessageResponse](docs/SendSlackMessageResponse.md)
556
+ - [Zyphr::SendSlackMessageResult](docs/SendSlackMessageResult.md)
522
557
  - [Zyphr::SendSmsData](docs/SendSmsData.md)
523
558
  - [Zyphr::SendSmsRequest](docs/SendSmsRequest.md)
524
559
  - [Zyphr::SendSmsResponse](docs/SendSmsResponse.md)
@@ -531,6 +566,12 @@ Class | Method | HTTP request | Description
531
566
  - [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
532
567
  - [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
533
568
  - [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
569
+ - [Zyphr::SlackMessage](docs/SlackMessage.md)
570
+ - [Zyphr::SlackMessageListResponse](docs/SlackMessageListResponse.md)
571
+ - [Zyphr::SlackMessageListResponseMeta](docs/SlackMessageListResponseMeta.md)
572
+ - [Zyphr::SlackMessageResponse](docs/SlackMessageResponse.md)
573
+ - [Zyphr::SlackMessageStatus](docs/SlackMessageStatus.md)
574
+ - [Zyphr::SlackMessageSummary](docs/SlackMessageSummary.md)
534
575
  - [Zyphr::SmsBatchResultMessage](docs/SmsBatchResultMessage.md)
535
576
  - [Zyphr::SmsBatchResultSummary](docs/SmsBatchResultSummary.md)
536
577
  - [Zyphr::SmsConfig](docs/SmsConfig.md)
@@ -548,7 +589,6 @@ Class | Method | HTTP request | Description
548
589
  - [Zyphr::SubscriberPreference](docs/SubscriberPreference.md)
549
590
  - [Zyphr::SubscriberResponse](docs/SubscriberResponse.md)
550
591
  - [Zyphr::SuccessResult](docs/SuccessResult.md)
551
- - [Zyphr::SuccessResultData](docs/SuccessResultData.md)
552
592
  - [Zyphr::Template](docs/Template.md)
553
593
  - [Zyphr::TemplateListResponse](docs/TemplateListResponse.md)
554
594
  - [Zyphr::TemplateRenderResponse](docs/TemplateRenderResponse.md)
@@ -586,6 +626,7 @@ Class | Method | HTTP request | Description
586
626
  - [Zyphr::UpdateWaaSEndpointRequest](docs/UpdateWaaSEndpointRequest.md)
587
627
  - [Zyphr::UpdateWaaSEventTypeRequest](docs/UpdateWaaSEventTypeRequest.md)
588
628
  - [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
629
+ - [Zyphr::UpsertAuthEmailTemplateRequest](docs/UpsertAuthEmailTemplateRequest.md)
589
630
  - [Zyphr::UpsertSmsConfigRequest](docs/UpsertSmsConfigRequest.md)
590
631
  - [Zyphr::UserDevicesDeleteResponse](docs/UserDevicesDeleteResponse.md)
591
632
  - [Zyphr::UserDevicesDeleteResponseData](docs/UserDevicesDeleteResponseData.md)
@@ -0,0 +1,42 @@
1
+ # Zyphr::AuthEmailTemplate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email_type** | [**AuthEmailType**](AuthEmailType.md) | | [optional] |
8
+ | **subject** | **String** | | [optional] |
9
+ | **html** | **String** | | [optional] |
10
+ | **text** | **String** | | [optional] |
11
+ | **mjml_source** | **String** | | [optional] |
12
+ | **design_json** | **Hash<String, Object>** | | [optional] |
13
+ | **editor_type** | **String** | | [optional] |
14
+ | **from_name** | **String** | | [optional] |
15
+ | **reply_to** | **String** | | [optional] |
16
+ | **is_enabled** | **Boolean** | | [optional] |
17
+ | **is_default** | **Boolean** | True when the system default is being returned (no override exists) | [optional] |
18
+ | **has_override** | **Boolean** | | [optional] |
19
+ | **version** | **Integer** | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'zyphr'
25
+
26
+ instance = Zyphr::AuthEmailTemplate.new(
27
+ email_type: null,
28
+ subject: null,
29
+ html: null,
30
+ text: null,
31
+ mjml_source: null,
32
+ design_json: null,
33
+ editor_type: null,
34
+ from_name: null,
35
+ reply_to: null,
36
+ is_enabled: null,
37
+ is_default: null,
38
+ has_override: null,
39
+ version: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,26 @@
1
+ # Zyphr::AuthEmailTemplateDefault
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email_type** | [**AuthEmailType**](AuthEmailType.md) | | [optional] |
8
+ | **subject** | **String** | | [optional] |
9
+ | **html** | **String** | | [optional] |
10
+ | **text** | **String** | | [optional] |
11
+ | **variables** | **Array<String>** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zyphr'
17
+
18
+ instance = Zyphr::AuthEmailTemplateDefault.new(
19
+ email_type: null,
20
+ subject: null,
21
+ html: null,
22
+ text: null,
23
+ variables: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateDefaultResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**AuthEmailTemplateDefault**](AuthEmailTemplateDefault.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateDefaultResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateDeleteResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**AuthEmailTemplateDeleteResponseData**](AuthEmailTemplateDeleteResponseData.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateDeleteResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -1,4 +1,4 @@
1
- # Zyphr::SuccessResultData
1
+ # Zyphr::AuthEmailTemplateDeleteResponseData
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'zyphr'
13
13
 
14
- instance = Zyphr::SuccessResultData.new(
14
+ instance = Zyphr::AuthEmailTemplateDeleteResponseData.new(
15
15
  success: null
16
16
  )
17
17
  ```
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<AuthEmailTemplate>**](AuthEmailTemplate.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateListResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,28 @@
1
+ # Zyphr::AuthEmailTemplatePreviewDraft
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subject** | **String** | | [optional] |
8
+ | **html** | **String** | | [optional] |
9
+ | **text** | **String** | | [optional] |
10
+ | **mjml_source** | **String** | | [optional] |
11
+ | **from_name** | **String** | | [optional] |
12
+ | **reply_to** | **String** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zyphr'
18
+
19
+ instance = Zyphr::AuthEmailTemplatePreviewDraft.new(
20
+ subject: null,
21
+ html: null,
22
+ text: null,
23
+ mjml_source: null,
24
+ from_name: null,
25
+ reply_to: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplatePreviewRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **variables** | **Hash<String, Object>** | Variables to interpolate. If omitted, sample values are used. | [optional] |
8
+ | **draft** | [**AuthEmailTemplatePreviewDraft**](AuthEmailTemplatePreviewDraft.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplatePreviewRequest.new(
16
+ variables: null,
17
+ draft: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplatePreviewResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**AuthEmailTemplatePreviewResult**](AuthEmailTemplatePreviewResult.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplatePreviewResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # Zyphr::AuthEmailTemplatePreviewResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subject** | **String** | | [optional] |
8
+ | **html** | **String** | | [optional] |
9
+ | **text** | **String** | | [optional] |
10
+ | **from_name** | **String** | | [optional] |
11
+ | **reply_to** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zyphr'
17
+
18
+ instance = Zyphr::AuthEmailTemplatePreviewResult.new(
19
+ subject: null,
20
+ html: null,
21
+ text: null,
22
+ from_name: null,
23
+ reply_to: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**AuthEmailTemplate**](AuthEmailTemplate.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateTestRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **to** | **String** | Recipient email. Must be in the application's `test_recipients` allowlist. | |
8
+ | **variables** | **Hash<String, Object>** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateTestRequest.new(
16
+ to: null,
17
+ variables: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateTestResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**AuthEmailTemplateTestResult**](AuthEmailTemplateTestResult.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateTestResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateTestResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **success** | **Boolean** | | [optional] |
8
+ | **message_id** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateTestResult.new(
16
+ success: null,
17
+ message_id: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,38 @@
1
+ # Zyphr::AuthEmailTemplateVersion
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **version** | **Integer** | | [optional] |
8
+ | **subject** | **String** | | [optional] |
9
+ | **html** | **String** | | [optional] |
10
+ | **text** | **String** | | [optional] |
11
+ | **mjml_source** | **String** | | [optional] |
12
+ | **design_json** | **Hash<String, Object>** | | [optional] |
13
+ | **editor_type** | **String** | | [optional] |
14
+ | **from_name** | **String** | | [optional] |
15
+ | **reply_to** | **String** | | [optional] |
16
+ | **is_enabled** | **Boolean** | | [optional] |
17
+ | **created_at** | **Time** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'zyphr'
23
+
24
+ instance = Zyphr::AuthEmailTemplateVersion.new(
25
+ version: null,
26
+ subject: null,
27
+ html: null,
28
+ text: null,
29
+ mjml_source: null,
30
+ design_json: null,
31
+ editor_type: null,
32
+ from_name: null,
33
+ reply_to: null,
34
+ is_enabled: null,
35
+ created_at: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::AuthEmailTemplateVersionsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<AuthEmailTemplateVersion>**](AuthEmailTemplateVersion.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::AuthEmailTemplateVersionsResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+