zyphr 0.1.18 → 0.1.20
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 +58 -6
- data/docs/AuthEmailTemplate.md +42 -0
- data/docs/AuthEmailTemplateDefault.md +26 -0
- data/docs/AuthEmailTemplateDefaultResponse.md +20 -0
- data/docs/AuthEmailTemplateDeleteResponse.md +20 -0
- data/docs/{SuccessResultData.md → AuthEmailTemplateDeleteResponseData.md} +2 -2
- data/docs/AuthEmailTemplateListResponse.md +20 -0
- data/docs/AuthEmailTemplatePreviewRequest.md +18 -0
- data/docs/AuthEmailTemplatePreviewResponse.md +20 -0
- data/docs/AuthEmailTemplatePreviewResult.md +26 -0
- data/docs/AuthEmailTemplateResponse.md +20 -0
- data/docs/AuthEmailTemplateTestRequest.md +20 -0
- data/docs/AuthEmailTemplateTestResponse.md +20 -0
- data/docs/AuthEmailTemplateTestResult.md +20 -0
- data/docs/AuthEmailTemplateVersion.md +38 -0
- data/docs/AuthEmailTemplateVersionsResponse.md +20 -0
- data/docs/AuthEmailTemplatesApi.md +782 -0
- data/docs/AuthEmailType.md +15 -0
- data/docs/BulkUpsertAuthEmailTemplatesRequest.md +22 -0
- data/docs/BulkUpsertAuthEmailTemplatesResponse.md +20 -0
- data/docs/ExecutionCancelResponse.md +20 -0
- data/docs/ExecutionCancelResponseData.md +20 -0
- data/docs/ExecutionResponse.md +20 -0
- data/docs/ExecutionRetryResponse.md +20 -0
- data/docs/ExecutionRetryResponseData.md +22 -0
- data/docs/ExecutionsApi.md +223 -0
- data/docs/ResubscribeResponse.md +1 -1
- data/docs/SendSlackMessageRequest.md +40 -0
- data/docs/SendSlackMessageResponse.md +20 -0
- data/docs/SendSlackMessageResult.md +28 -0
- data/docs/SlackApi.md +233 -0
- data/docs/SlackMessage.md +50 -0
- data/docs/SlackMessageListResponse.md +20 -0
- data/docs/SlackMessageListResponseMeta.md +24 -0
- data/docs/SlackMessageResponse.md +20 -0
- data/docs/SlackMessageStatus.md +15 -0
- data/docs/SlackMessageSummary.md +38 -0
- data/docs/SuccessResult.md +1 -1
- data/docs/UpsertAuthEmailTemplateRequest.md +34 -0
- data/docs/WorkflowExecution.md +46 -0
- data/docs/WorkflowExecutionStatus.md +15 -0
- data/docs/WorkflowStepExecution.md +40 -0
- data/docs/WorkflowStepExecutionStatus.md +15 -0
- data/lib/zyphr/api/auth_email_templates_api.rb +688 -0
- data/lib/zyphr/api/executions_api.rb +211 -0
- data/lib/zyphr/api/slack_api.rb +233 -0
- data/lib/zyphr/models/auth_email_template.rb +372 -0
- data/lib/zyphr/models/auth_email_template_default.rb +281 -0
- data/lib/zyphr/models/auth_email_template_default_response.rb +229 -0
- data/lib/zyphr/models/auth_email_template_delete_response.rb +229 -0
- data/lib/zyphr/models/{success_result_data.rb → auth_email_template_delete_response_data.rb} +3 -3
- data/lib/zyphr/models/auth_email_template_list_response.rb +231 -0
- data/lib/zyphr/models/auth_email_template_preview_request.rb +223 -0
- data/lib/zyphr/models/auth_email_template_preview_response.rb +229 -0
- data/lib/zyphr/models/auth_email_template_preview_result.rb +259 -0
- data/lib/zyphr/models/auth_email_template_response.rb +229 -0
- data/lib/zyphr/models/auth_email_template_test_request.rb +249 -0
- data/lib/zyphr/models/auth_email_template_test_response.rb +229 -0
- data/lib/zyphr/models/auth_email_template_test_result.rb +229 -0
- data/lib/zyphr/models/auth_email_template_version.rb +352 -0
- data/lib/zyphr/models/auth_email_template_versions_response.rb +231 -0
- data/lib/zyphr/models/auth_email_type.rb +41 -0
- data/lib/zyphr/models/bulk_upsert_auth_email_templates_request.rb +239 -0
- data/lib/zyphr/models/bulk_upsert_auth_email_templates_response.rb +231 -0
- data/lib/zyphr/models/execution_cancel_response.rb +229 -0
- data/lib/zyphr/models/execution_cancel_response_data.rb +263 -0
- data/lib/zyphr/models/execution_response.rb +229 -0
- data/lib/zyphr/models/execution_retry_response.rb +229 -0
- data/lib/zyphr/models/execution_retry_response_data.rb +315 -0
- data/lib/zyphr/models/resubscribe_response.rb +1 -1
- data/lib/zyphr/models/send_slack_message_request.rb +340 -0
- data/lib/zyphr/models/send_slack_message_response.rb +229 -0
- data/lib/zyphr/models/send_slack_message_result.rb +289 -0
- data/lib/zyphr/models/slack_message.rb +406 -0
- data/lib/zyphr/models/slack_message_list_response.rb +231 -0
- data/lib/zyphr/models/slack_message_list_response_meta.rb +254 -0
- data/lib/zyphr/models/slack_message_response.rb +229 -0
- data/lib/zyphr/models/slack_message_status.rb +43 -0
- data/lib/zyphr/models/slack_message_summary.rb +340 -0
- data/lib/zyphr/models/success_result.rb +1 -1
- data/lib/zyphr/models/upsert_auth_email_template_request.rb +335 -0
- data/lib/zyphr/models/workflow_execution.rb +497 -0
- data/lib/zyphr/models/workflow_execution_status.rb +43 -0
- data/lib/zyphr/models/workflow_step_execution.rb +445 -0
- data/lib/zyphr/models/workflow_step_execution_status.rb +44 -0
- data/lib/zyphr.rb +40 -1
- data/spec/api/auth_email_templates_api_spec.rb +157 -0
- data/spec/api/executions_api_spec.rb +71 -0
- data/spec/api/slack_api_spec.rb +75 -0
- data/spec/models/auth_email_template_default_response_spec.rb +42 -0
- data/spec/models/auth_email_template_default_spec.rb +60 -0
- data/spec/models/{success_result_data_spec.rb → auth_email_template_delete_response_data_spec.rb} +6 -6
- data/spec/models/auth_email_template_delete_response_spec.rb +42 -0
- data/spec/models/auth_email_template_list_response_spec.rb +42 -0
- data/spec/models/auth_email_template_preview_request_spec.rb +36 -0
- data/spec/models/auth_email_template_preview_response_spec.rb +42 -0
- data/spec/models/auth_email_template_preview_result_spec.rb +60 -0
- data/spec/models/auth_email_template_response_spec.rb +42 -0
- data/spec/models/auth_email_template_spec.rb +112 -0
- data/spec/models/auth_email_template_test_request_spec.rb +42 -0
- data/spec/models/auth_email_template_test_response_spec.rb +42 -0
- data/spec/models/auth_email_template_test_result_spec.rb +42 -0
- data/spec/models/auth_email_template_version_spec.rb +100 -0
- data/spec/models/auth_email_template_versions_response_spec.rb +42 -0
- data/spec/models/auth_email_type_spec.rb +30 -0
- data/spec/models/bulk_upsert_auth_email_templates_request_spec.rb +48 -0
- data/spec/models/bulk_upsert_auth_email_templates_response_spec.rb +42 -0
- data/spec/models/execution_cancel_response_data_spec.rb +46 -0
- data/spec/models/execution_cancel_response_spec.rb +42 -0
- data/spec/models/execution_response_spec.rb +42 -0
- data/spec/models/execution_retry_response_data_spec.rb +52 -0
- data/spec/models/execution_retry_response_spec.rb +42 -0
- data/spec/models/send_slack_message_request_spec.rb +102 -0
- data/spec/models/send_slack_message_response_spec.rb +42 -0
- data/spec/models/send_slack_message_result_spec.rb +66 -0
- data/spec/models/slack_message_list_response_meta_spec.rb +54 -0
- data/spec/models/slack_message_list_response_spec.rb +42 -0
- data/spec/models/slack_message_response_spec.rb +42 -0
- data/spec/models/slack_message_spec.rb +132 -0
- data/spec/models/slack_message_status_spec.rb +30 -0
- data/spec/models/slack_message_summary_spec.rb +96 -0
- data/spec/models/upsert_auth_email_template_request_spec.rb +88 -0
- data/spec/models/workflow_execution_spec.rb +120 -0
- data/spec/models/workflow_execution_status_spec.rb +30 -0
- data/spec/models/workflow_step_execution_spec.rb +106 -0
- data/spec/models/workflow_step_execution_status_spec.rb +30 -0
- data/zyphr.gemspec +1 -1
- metadata +162 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fc762ee588936e1ec8d39ea372bc0c8986cd201e1672ee0eee54d044570f62dd
|
|
4
|
+
data.tar.gz: b0a9af6a8ab3ed788a093adde023ab5dba58e5a7a30885bb64e36fae250ac0c0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9410b310ef0500325dbb85aa0e04a2dc78d1edc10509628b4ca382e383f189108869f7f2a02f714bf55e75a7ba502fedfe82600047be58bf4acc777c41b8c852
|
|
7
|
+
data.tar.gz: 99fde07f3ba85115df8c8d0ab6e0a6d9a753493ac04a222ae4e238d72f19cd7ac88144f1eebd7f4ad23e842a147c7b3d2c6b759eabf353437b947583054dc516
|
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::
|
|
114
|
-
|
|
113
|
+
api_instance = Zyphr::AuthEmailTemplatesApi.new
|
|
114
|
+
bulk_upsert_auth_email_templates_request = Zyphr::BulkUpsertAuthEmailTemplatesRequest.new # BulkUpsertAuthEmailTemplatesRequest |
|
|
115
115
|
|
|
116
116
|
begin
|
|
117
|
-
#
|
|
118
|
-
result = api_instance.
|
|
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
|
|
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
|
|
@@ -186,6 +196,9 @@ Class | Method | HTTP request | Description
|
|
|
186
196
|
*Zyphr::EmailsApi* | [**list_emails**](docs/EmailsApi.md#list_emails) | **GET** /emails | List emails
|
|
187
197
|
*Zyphr::EmailsApi* | [**send_batch_email**](docs/EmailsApi.md#send_batch_email) | **POST** /emails/batch | Send batch emails
|
|
188
198
|
*Zyphr::EmailsApi* | [**send_email**](docs/EmailsApi.md#send_email) | **POST** /emails | Send an email
|
|
199
|
+
*Zyphr::ExecutionsApi* | [**cancel_execution**](docs/ExecutionsApi.md#cancel_execution) | **POST** /executions/{id}/cancel | Cancel a running execution
|
|
200
|
+
*Zyphr::ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /executions/{id} | Get a workflow execution
|
|
201
|
+
*Zyphr::ExecutionsApi* | [**retry_execution**](docs/ExecutionsApi.md#retry_execution) | **POST** /executions/{id}/retry | Retry a failed or cancelled execution
|
|
189
202
|
*Zyphr::InboxApi* | [**archive_inbox_notification**](docs/InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification
|
|
190
203
|
*Zyphr::InboxApi* | [**archive_subscriber_notification**](docs/InboxApi.md#archive_subscriber_notification) | **POST** /subscriber-inbox/{id}/archive | Archive a notification
|
|
191
204
|
*Zyphr::InboxApi* | [**delete_inbox_notification**](docs/InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification
|
|
@@ -224,6 +237,9 @@ Class | Method | HTTP request | Description
|
|
|
224
237
|
*Zyphr::SMSApi* | [**send_test_sms**](docs/SMSApi.md#send_test_sms) | **POST** /sms/test | Send a test SMS
|
|
225
238
|
*Zyphr::SMSApi* | [**upsert_sms_config**](docs/SMSApi.md#upsert_sms_config) | **POST** /sms/config | Create or update SMS configuration
|
|
226
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
|
|
227
243
|
*Zyphr::SubscribersApi* | [**create_category**](docs/SubscribersApi.md#create_category) | **POST** /subscribers/categories | Create a notification category
|
|
228
244
|
*Zyphr::SubscribersApi* | [**create_subscriber**](docs/SubscribersApi.md#create_subscriber) | **POST** /subscribers | Create or update a subscriber
|
|
229
245
|
*Zyphr::SubscribersApi* | [**delete_category**](docs/SubscribersApi.md#delete_category) | **DELETE** /subscribers/categories/{id} | Delete a category
|
|
@@ -319,6 +335,22 @@ Class | Method | HTTP request | Description
|
|
|
319
335
|
- [Zyphr::ApiError](docs/ApiError.md)
|
|
320
336
|
- [Zyphr::ApiErrorError](docs/ApiErrorError.md)
|
|
321
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::AuthEmailTemplatePreviewRequest](docs/AuthEmailTemplatePreviewRequest.md)
|
|
345
|
+
- [Zyphr::AuthEmailTemplatePreviewResponse](docs/AuthEmailTemplatePreviewResponse.md)
|
|
346
|
+
- [Zyphr::AuthEmailTemplatePreviewResult](docs/AuthEmailTemplatePreviewResult.md)
|
|
347
|
+
- [Zyphr::AuthEmailTemplateResponse](docs/AuthEmailTemplateResponse.md)
|
|
348
|
+
- [Zyphr::AuthEmailTemplateTestRequest](docs/AuthEmailTemplateTestRequest.md)
|
|
349
|
+
- [Zyphr::AuthEmailTemplateTestResponse](docs/AuthEmailTemplateTestResponse.md)
|
|
350
|
+
- [Zyphr::AuthEmailTemplateTestResult](docs/AuthEmailTemplateTestResult.md)
|
|
351
|
+
- [Zyphr::AuthEmailTemplateVersion](docs/AuthEmailTemplateVersion.md)
|
|
352
|
+
- [Zyphr::AuthEmailTemplateVersionsResponse](docs/AuthEmailTemplateVersionsResponse.md)
|
|
353
|
+
- [Zyphr::AuthEmailType](docs/AuthEmailType.md)
|
|
322
354
|
- [Zyphr::AuthLoginResponse](docs/AuthLoginResponse.md)
|
|
323
355
|
- [Zyphr::AuthLoginResult](docs/AuthLoginResult.md)
|
|
324
356
|
- [Zyphr::AuthLoginResultMfaChallenge](docs/AuthLoginResultMfaChallenge.md)
|
|
@@ -331,6 +363,8 @@ Class | Method | HTTP request | Description
|
|
|
331
363
|
- [Zyphr::AuthUserResponseData](docs/AuthUserResponseData.md)
|
|
332
364
|
- [Zyphr::BatchPublishWaaSEvents201Response](docs/BatchPublishWaaSEvents201Response.md)
|
|
333
365
|
- [Zyphr::BulkRetryWebhookDeliveriesRequest](docs/BulkRetryWebhookDeliveriesRequest.md)
|
|
366
|
+
- [Zyphr::BulkUpsertAuthEmailTemplatesRequest](docs/BulkUpsertAuthEmailTemplatesRequest.md)
|
|
367
|
+
- [Zyphr::BulkUpsertAuthEmailTemplatesResponse](docs/BulkUpsertAuthEmailTemplatesResponse.md)
|
|
334
368
|
- [Zyphr::Category](docs/Category.md)
|
|
335
369
|
- [Zyphr::CategoryListResponse](docs/CategoryListResponse.md)
|
|
336
370
|
- [Zyphr::CategoryResponse](docs/CategoryResponse.md)
|
|
@@ -380,6 +414,11 @@ Class | Method | HTTP request | Description
|
|
|
380
414
|
- [Zyphr::EmailTrackingResponse](docs/EmailTrackingResponse.md)
|
|
381
415
|
- [Zyphr::EndUserDeleteResponse](docs/EndUserDeleteResponse.md)
|
|
382
416
|
- [Zyphr::EndUserDeleteResponseData](docs/EndUserDeleteResponseData.md)
|
|
417
|
+
- [Zyphr::ExecutionCancelResponse](docs/ExecutionCancelResponse.md)
|
|
418
|
+
- [Zyphr::ExecutionCancelResponseData](docs/ExecutionCancelResponseData.md)
|
|
419
|
+
- [Zyphr::ExecutionResponse](docs/ExecutionResponse.md)
|
|
420
|
+
- [Zyphr::ExecutionRetryResponse](docs/ExecutionRetryResponse.md)
|
|
421
|
+
- [Zyphr::ExecutionRetryResponseData](docs/ExecutionRetryResponseData.md)
|
|
383
422
|
- [Zyphr::ForgotPasswordRequest](docs/ForgotPasswordRequest.md)
|
|
384
423
|
- [Zyphr::GenerateSubscriberToken200Response](docs/GenerateSubscriberToken200Response.md)
|
|
385
424
|
- [Zyphr::GenerateSubscriberToken200ResponseData](docs/GenerateSubscriberToken200ResponseData.md)
|
|
@@ -511,6 +550,9 @@ Class | Method | HTTP request | Description
|
|
|
511
550
|
- [Zyphr::SendPushToTopicData](docs/SendPushToTopicData.md)
|
|
512
551
|
- [Zyphr::SendPushToTopicRequest](docs/SendPushToTopicRequest.md)
|
|
513
552
|
- [Zyphr::SendPushToTopicResponse](docs/SendPushToTopicResponse.md)
|
|
553
|
+
- [Zyphr::SendSlackMessageRequest](docs/SendSlackMessageRequest.md)
|
|
554
|
+
- [Zyphr::SendSlackMessageResponse](docs/SendSlackMessageResponse.md)
|
|
555
|
+
- [Zyphr::SendSlackMessageResult](docs/SendSlackMessageResult.md)
|
|
514
556
|
- [Zyphr::SendSmsData](docs/SendSmsData.md)
|
|
515
557
|
- [Zyphr::SendSmsRequest](docs/SendSmsRequest.md)
|
|
516
558
|
- [Zyphr::SendSmsResponse](docs/SendSmsResponse.md)
|
|
@@ -523,6 +565,12 @@ Class | Method | HTTP request | Description
|
|
|
523
565
|
- [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
|
|
524
566
|
- [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
|
|
525
567
|
- [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
|
|
568
|
+
- [Zyphr::SlackMessage](docs/SlackMessage.md)
|
|
569
|
+
- [Zyphr::SlackMessageListResponse](docs/SlackMessageListResponse.md)
|
|
570
|
+
- [Zyphr::SlackMessageListResponseMeta](docs/SlackMessageListResponseMeta.md)
|
|
571
|
+
- [Zyphr::SlackMessageResponse](docs/SlackMessageResponse.md)
|
|
572
|
+
- [Zyphr::SlackMessageStatus](docs/SlackMessageStatus.md)
|
|
573
|
+
- [Zyphr::SlackMessageSummary](docs/SlackMessageSummary.md)
|
|
526
574
|
- [Zyphr::SmsBatchResultMessage](docs/SmsBatchResultMessage.md)
|
|
527
575
|
- [Zyphr::SmsBatchResultSummary](docs/SmsBatchResultSummary.md)
|
|
528
576
|
- [Zyphr::SmsConfig](docs/SmsConfig.md)
|
|
@@ -540,7 +588,6 @@ Class | Method | HTTP request | Description
|
|
|
540
588
|
- [Zyphr::SubscriberPreference](docs/SubscriberPreference.md)
|
|
541
589
|
- [Zyphr::SubscriberResponse](docs/SubscriberResponse.md)
|
|
542
590
|
- [Zyphr::SuccessResult](docs/SuccessResult.md)
|
|
543
|
-
- [Zyphr::SuccessResultData](docs/SuccessResultData.md)
|
|
544
591
|
- [Zyphr::Template](docs/Template.md)
|
|
545
592
|
- [Zyphr::TemplateListResponse](docs/TemplateListResponse.md)
|
|
546
593
|
- [Zyphr::TemplateRenderResponse](docs/TemplateRenderResponse.md)
|
|
@@ -578,6 +625,7 @@ Class | Method | HTTP request | Description
|
|
|
578
625
|
- [Zyphr::UpdateWaaSEndpointRequest](docs/UpdateWaaSEndpointRequest.md)
|
|
579
626
|
- [Zyphr::UpdateWaaSEventTypeRequest](docs/UpdateWaaSEventTypeRequest.md)
|
|
580
627
|
- [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
|
628
|
+
- [Zyphr::UpsertAuthEmailTemplateRequest](docs/UpsertAuthEmailTemplateRequest.md)
|
|
581
629
|
- [Zyphr::UpsertSmsConfigRequest](docs/UpsertSmsConfigRequest.md)
|
|
582
630
|
- [Zyphr::UserDevicesDeleteResponse](docs/UserDevicesDeleteResponse.md)
|
|
583
631
|
- [Zyphr::UserDevicesDeleteResponseData](docs/UserDevicesDeleteResponseData.md)
|
|
@@ -650,6 +698,10 @@ Class | Method | HTTP request | Description
|
|
|
650
698
|
- [Zyphr::WebhookVersionsResponse](docs/WebhookVersionsResponse.md)
|
|
651
699
|
- [Zyphr::WebhookVersionsResponseData](docs/WebhookVersionsResponseData.md)
|
|
652
700
|
- [Zyphr::WithdrawSubscriberConsentRequest](docs/WithdrawSubscriberConsentRequest.md)
|
|
701
|
+
- [Zyphr::WorkflowExecution](docs/WorkflowExecution.md)
|
|
702
|
+
- [Zyphr::WorkflowExecutionStatus](docs/WorkflowExecutionStatus.md)
|
|
703
|
+
- [Zyphr::WorkflowStepExecution](docs/WorkflowStepExecution.md)
|
|
704
|
+
- [Zyphr::WorkflowStepExecutionStatus](docs/WorkflowStepExecutionStatus.md)
|
|
653
705
|
|
|
654
706
|
|
|
655
707
|
## Documentation for Authorization
|
|
@@ -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::
|
|
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::
|
|
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,18 @@
|
|
|
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
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::AuthEmailTemplatePreviewRequest.new(
|
|
15
|
+
variables: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -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
|
+
|