zyphr 0.1.39 → 0.1.40
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 +35 -14
- data/docs/AddWorkflowStep201Response.md +20 -0
- data/docs/AddWorkflowStepRequest.md +30 -0
- data/docs/AuthRegistrationApi.md +1 -1
- data/docs/CreateWorkflow201Response.md +20 -0
- data/docs/CreateWorkflowRequest.md +26 -0
- data/docs/DeleteWorkflow200Response.md +20 -0
- data/docs/{TopicDeleteResponseData.md → DeleteWorkflow200ResponseData.md} +2 -2
- data/docs/DeleteWorkflowStep200Response.md +20 -0
- data/docs/DeleteWorkflowStep200ResponseData.md +22 -0
- data/docs/ListWorkflowExecutions200Response.md +20 -0
- data/docs/{SmsListResponseMeta.md → ListWorkflowExecutions200ResponseMeta.md} +2 -2
- data/docs/ListWorkflows200Response.md +20 -0
- data/docs/ListWorkflows200ResponseMeta.md +32 -0
- data/docs/ReorderWorkflowStepsRequest.md +18 -0
- data/docs/SignInWithGameCenterRequest.md +1 -1
- data/docs/SmsListResponse.md +1 -1
- data/docs/TopicDeleteResponse.md +1 -1
- data/docs/TriggerWorkflow202Response.md +20 -0
- data/docs/TriggerWorkflow202ResponseData.md +22 -0
- data/docs/TriggerWorkflowRequest.md +24 -0
- data/docs/UpdateWorkflowRequest.md +24 -0
- data/docs/UpdateWorkflowStatusRequest.md +18 -0
- data/docs/UpdateWorkflowStepRequest.md +20 -0
- data/docs/Workflow.md +42 -0
- data/docs/WorkflowStatus.md +15 -0
- data/docs/WorkflowStep.md +38 -0
- data/docs/WorkflowStepType.md +15 -0
- data/docs/WorkflowsApi.md +901 -0
- data/lib/zyphr/api/auth_registration_api.rb +2 -2
- data/lib/zyphr/api/workflows_api.rb +897 -0
- data/lib/zyphr/models/add_workflow_step201_response.rb +229 -0
- data/lib/zyphr/models/add_workflow_step_request.rb +384 -0
- data/lib/zyphr/models/create_workflow201_response.rb +229 -0
- data/lib/zyphr/models/create_workflow_request.rb +292 -0
- data/lib/zyphr/models/delete_workflow200_response.rb +229 -0
- data/lib/zyphr/models/{topic_delete_response_data.rb → delete_workflow200_response_data.rb} +3 -3
- data/lib/zyphr/models/delete_workflow_step200_response.rb +229 -0
- data/lib/zyphr/models/delete_workflow_step200_response_data.rb +238 -0
- data/lib/zyphr/models/list_workflow_executions200_response.rb +231 -0
- data/lib/zyphr/models/{sms_list_response_meta.rb → list_workflow_executions200_response_meta.rb} +3 -3
- data/lib/zyphr/models/list_workflows200_response.rb +231 -0
- data/lib/zyphr/models/list_workflows200_response_meta.rb +284 -0
- data/lib/zyphr/models/reorder_workflow_steps_request.rb +249 -0
- data/lib/zyphr/models/sign_in_with_game_center_request.rb +1 -1
- data/lib/zyphr/models/sms_list_response.rb +1 -1
- data/lib/zyphr/models/topic_delete_response.rb +1 -1
- data/lib/zyphr/models/trigger_workflow202_response.rb +229 -0
- data/lib/zyphr/models/trigger_workflow202_response_data.rb +240 -0
- data/lib/zyphr/models/trigger_workflow_request.rb +272 -0
- data/lib/zyphr/models/update_workflow_request.rb +269 -0
- data/lib/zyphr/models/{v1_muse_subjects_suggest_post_request.rb → update_workflow_status_request.rb} +19 -86
- data/lib/zyphr/models/update_workflow_step_request.rb +232 -0
- data/lib/zyphr/models/workflow.rb +514 -0
- data/lib/zyphr/models/workflow_status.rb +42 -0
- data/lib/zyphr/models/workflow_step.rb +505 -0
- data/lib/zyphr/models/workflow_step_type.rb +47 -0
- data/lib/zyphr.rb +24 -4
- data/spec/api/auth_registration_api_spec.rb +1 -1
- data/spec/api/workflows_api_spec.rb +192 -0
- data/spec/models/add_workflow_step201_response_spec.rb +42 -0
- data/spec/models/add_workflow_step_request_spec.rb +76 -0
- data/spec/models/create_workflow201_response_spec.rb +42 -0
- data/spec/models/{v1_muse_subjects_suggest_post_request_spec.rb → create_workflow_request_spec.rb} +16 -14
- data/spec/models/{topic_delete_response_data_spec.rb → delete_workflow200_response_data_spec.rb} +6 -6
- data/spec/models/delete_workflow200_response_spec.rb +42 -0
- data/spec/models/delete_workflow_step200_response_data_spec.rb +48 -0
- data/spec/models/delete_workflow_step200_response_spec.rb +42 -0
- data/spec/models/{sms_list_response_meta_spec.rb → list_workflow_executions200_response_meta_spec.rb} +6 -6
- data/spec/models/list_workflow_executions200_response_spec.rb +42 -0
- data/spec/models/list_workflows200_response_meta_spec.rb +78 -0
- data/spec/models/list_workflows200_response_spec.rb +42 -0
- data/spec/models/reorder_workflow_steps_request_spec.rb +36 -0
- data/spec/models/trigger_workflow202_response_data_spec.rb +48 -0
- data/spec/models/trigger_workflow202_response_spec.rb +42 -0
- data/spec/models/trigger_workflow_request_spec.rb +54 -0
- data/spec/models/update_workflow_request_spec.rb +54 -0
- data/spec/models/update_workflow_status_request_spec.rb +36 -0
- data/spec/models/update_workflow_step_request_spec.rb +42 -0
- data/spec/models/workflow_spec.rb +108 -0
- data/spec/models/workflow_status_spec.rb +30 -0
- data/spec/models/workflow_step_spec.rb +100 -0
- data/spec/models/workflow_step_type_spec.rb +30 -0
- data/zyphr.gemspec +1 -1
- metadata +97 -17
- data/docs/MuseApi.md +0 -681
- data/docs/V1MuseSubjectsSuggestPostRequest.md +0 -24
- data/lib/zyphr/api/muse_api.rb +0 -644
- data/spec/api/muse_api_spec.rb +0 -156
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 955eb06e49c1b00cef4b369a618572360989321e4fa6b3e2e263038b39dd533a
|
|
4
|
+
data.tar.gz: bebb75c0a3bdf78029fac2e47e60893eb74b930a2c3f0ccd2a86d3b33424c520
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8fdbcadf17903d8128b8455e0ce94ca7c08f505ef24ef3ea714208927578f7bc045706efe9841a95a2e4e19f8cee1e0b1cf424f8f2fe44a4c80a0f14718f957c
|
|
7
|
+
data.tar.gz: 60a3fa5fdded26f7097702bab309e7c2493d0ccf583949be3869f7f230d1a2e45f1febfd86f14bf6e67df0e9b2722a4900231a40b6a7300eaecd5628716afdd6
|
data/README.md
CHANGED
|
@@ -258,17 +258,6 @@ Class | Method | HTTP request | Description
|
|
|
258
258
|
*Zyphr::InboxApi* | [**send_batch_in_app**](docs/InboxApi.md#send_batch_in_app) | **POST** /inbox/send/batch | Send batch in-app notifications
|
|
259
259
|
*Zyphr::InboxApi* | [**send_in_app**](docs/InboxApi.md#send_in_app) | **POST** /inbox/send | Send an in-app notification
|
|
260
260
|
*Zyphr::InboxApi* | [**update_subscriber_preferences**](docs/InboxApi.md#update_subscriber_preferences) | **PUT** /subscriber-inbox/preferences | Update subscriber preferences
|
|
261
|
-
*Zyphr::MuseApi* | [**v1_muse_audit_log_get**](docs/MuseApi.md#v1_muse_audit_log_get) | **GET** /v1/muse/audit-log | Paginated per-call audit log for Muse
|
|
262
|
-
*Zyphr::MuseApi* | [**v1_muse_broadcasts_analyze_post**](docs/MuseApi.md#v1_muse_broadcasts_analyze_post) | **POST** /v1/muse/broadcasts/analyze | Stream a pre-send advisory for a draft broadcast
|
|
263
|
-
*Zyphr::MuseApi* | [**v1_muse_entitlement_get**](docs/MuseApi.md#v1_muse_entitlement_get) | **GET** /v1/muse/entitlement | Return the current account's Zyphr Muse entitlement
|
|
264
|
-
*Zyphr::MuseApi* | [**v1_muse_eval_baselines_get**](docs/MuseApi.md#v1_muse_eval_baselines_get) | **GET** /v1/muse/eval-baselines | Per-prompt eval baseline snapshots
|
|
265
|
-
*Zyphr::MuseApi* | [**v1_muse_settings_project_id_get**](docs/MuseApi.md#v1_muse_settings_project_id_get) | **GET** /v1/muse/settings/{project_id} | Read Muse settings for a project
|
|
266
|
-
*Zyphr::MuseApi* | [**v1_muse_settings_project_id_patch**](docs/MuseApi.md#v1_muse_settings_project_id_patch) | **PATCH** /v1/muse/settings/{project_id} | Update Muse settings for a project (admin or developer only)
|
|
267
|
-
*Zyphr::MuseApi* | [**v1_muse_subjects_suggest_post**](docs/MuseApi.md#v1_muse_subjects_suggest_post) | **POST** /v1/muse/subjects/suggest | Suggest 5 ranked subject-line candidates for a template
|
|
268
|
-
*Zyphr::MuseApi* | [**v1_muse_templates_draft_post**](docs/MuseApi.md#v1_muse_templates_draft_post) | **POST** /v1/muse/templates/draft | Stream a draft template from a natural-language brief
|
|
269
|
-
*Zyphr::MuseApi* | [**v1_muse_templates_rewrite_post**](docs/MuseApi.md#v1_muse_templates_rewrite_post) | **POST** /v1/muse/templates/rewrite | Stream a rewritten block per the user's instruction
|
|
270
|
-
*Zyphr::MuseApi* | [**v1_muse_usage_get**](docs/MuseApi.md#v1_muse_usage_get) | **GET** /v1/muse/usage | Per-account Zyphr Muse usage + budget tier
|
|
271
|
-
*Zyphr::MuseApi* | [**v1_muse_workflows_generate_post**](docs/MuseApi.md#v1_muse_workflows_generate_post) | **POST** /v1/muse/workflows/generate | Stream a generated workflow from a natural-language description
|
|
272
261
|
*Zyphr::PushApi* | [**get_push**](docs/PushApi.md#get_push) | **GET** /push/{id} | Get push notification details
|
|
273
262
|
*Zyphr::PushApi* | [**get_push_stats**](docs/PushApi.md#get_push_stats) | **GET** /push/stats | Get push notification statistics
|
|
274
263
|
*Zyphr::PushApi* | [**list_device_push_topics**](docs/PushApi.md#list_device_push_topics) | **GET** /push/devices/{id}/topics | List topics for a device
|
|
@@ -378,6 +367,18 @@ Class | Method | HTTP request | Description
|
|
|
378
367
|
*Zyphr::WebhooksApi* | [**send_webhook_test_event**](docs/WebhooksApi.md#send_webhook_test_event) | **POST** /v1/webhooks/{id}/test | Send test event
|
|
379
368
|
*Zyphr::WebhooksApi* | [**test_webhook_transform**](docs/WebhooksApi.md#test_webhook_transform) | **POST** /v1/webhooks/{id}/transform/test | Test payload transformation
|
|
380
369
|
*Zyphr::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /v1/webhooks/{id} | Update webhook
|
|
370
|
+
*Zyphr::WorkflowsApi* | [**add_workflow_step**](docs/WorkflowsApi.md#add_workflow_step) | **POST** /workflows/{key}/steps | Add a workflow step
|
|
371
|
+
*Zyphr::WorkflowsApi* | [**create_workflow**](docs/WorkflowsApi.md#create_workflow) | **POST** /workflows | Create a workflow
|
|
372
|
+
*Zyphr::WorkflowsApi* | [**delete_workflow**](docs/WorkflowsApi.md#delete_workflow) | **DELETE** /workflows/{key} | Delete a workflow
|
|
373
|
+
*Zyphr::WorkflowsApi* | [**delete_workflow_step**](docs/WorkflowsApi.md#delete_workflow_step) | **DELETE** /workflows/{key}/steps/{stepKey} | Delete a workflow step
|
|
374
|
+
*Zyphr::WorkflowsApi* | [**get_workflow**](docs/WorkflowsApi.md#get_workflow) | **GET** /workflows/{key} | Get a workflow
|
|
375
|
+
*Zyphr::WorkflowsApi* | [**list_workflow_executions**](docs/WorkflowsApi.md#list_workflow_executions) | **GET** /workflows/{key}/executions | List workflow executions
|
|
376
|
+
*Zyphr::WorkflowsApi* | [**list_workflows**](docs/WorkflowsApi.md#list_workflows) | **GET** /workflows | List workflows
|
|
377
|
+
*Zyphr::WorkflowsApi* | [**reorder_workflow_steps**](docs/WorkflowsApi.md#reorder_workflow_steps) | **PUT** /workflows/{key}/steps/reorder | Reorder workflow steps
|
|
378
|
+
*Zyphr::WorkflowsApi* | [**trigger_workflow**](docs/WorkflowsApi.md#trigger_workflow) | **POST** /workflows/{key}/trigger | Trigger a workflow
|
|
379
|
+
*Zyphr::WorkflowsApi* | [**update_workflow**](docs/WorkflowsApi.md#update_workflow) | **PATCH** /workflows/{key} | Update a workflow
|
|
380
|
+
*Zyphr::WorkflowsApi* | [**update_workflow_status**](docs/WorkflowsApi.md#update_workflow_status) | **PATCH** /workflows/{key}/status | Update workflow status
|
|
381
|
+
*Zyphr::WorkflowsApi* | [**update_workflow_step**](docs/WorkflowsApi.md#update_workflow_step) | **PATCH** /workflows/{key}/steps/{stepKey} | Update a workflow step
|
|
381
382
|
|
|
382
383
|
|
|
383
384
|
## Documentation for Models
|
|
@@ -387,6 +388,8 @@ Class | Method | HTTP request | Description
|
|
|
387
388
|
- [Zyphr::AddDomainRequest](docs/AddDomainRequest.md)
|
|
388
389
|
- [Zyphr::AddOrganizationMemberRequest](docs/AddOrganizationMemberRequest.md)
|
|
389
390
|
- [Zyphr::AddTopicSubscribersRequest](docs/AddTopicSubscribersRequest.md)
|
|
391
|
+
- [Zyphr::AddWorkflowStep201Response](docs/AddWorkflowStep201Response.md)
|
|
392
|
+
- [Zyphr::AddWorkflowStepRequest](docs/AddWorkflowStepRequest.md)
|
|
390
393
|
- [Zyphr::ApiError](docs/ApiError.md)
|
|
391
394
|
- [Zyphr::ApiErrorError](docs/ApiErrorError.md)
|
|
392
395
|
- [Zyphr::ApiErrorMeta](docs/ApiErrorMeta.md)
|
|
@@ -453,10 +456,16 @@ Class | Method | HTTP request | Description
|
|
|
453
456
|
- [Zyphr::CreateWaaSEventType201Response](docs/CreateWaaSEventType201Response.md)
|
|
454
457
|
- [Zyphr::CreateWaaSEventTypeRequest](docs/CreateWaaSEventTypeRequest.md)
|
|
455
458
|
- [Zyphr::CreateWebhookRequest](docs/CreateWebhookRequest.md)
|
|
459
|
+
- [Zyphr::CreateWorkflow201Response](docs/CreateWorkflow201Response.md)
|
|
460
|
+
- [Zyphr::CreateWorkflowRequest](docs/CreateWorkflowRequest.md)
|
|
456
461
|
- [Zyphr::DeleteDomainResponse](docs/DeleteDomainResponse.md)
|
|
457
462
|
- [Zyphr::DeleteDomainResponseData](docs/DeleteDomainResponseData.md)
|
|
458
463
|
- [Zyphr::DeleteResult](docs/DeleteResult.md)
|
|
459
464
|
- [Zyphr::DeleteResultData](docs/DeleteResultData.md)
|
|
465
|
+
- [Zyphr::DeleteWorkflow200Response](docs/DeleteWorkflow200Response.md)
|
|
466
|
+
- [Zyphr::DeleteWorkflow200ResponseData](docs/DeleteWorkflow200ResponseData.md)
|
|
467
|
+
- [Zyphr::DeleteWorkflowStep200Response](docs/DeleteWorkflowStep200Response.md)
|
|
468
|
+
- [Zyphr::DeleteWorkflowStep200ResponseData](docs/DeleteWorkflowStep200ResponseData.md)
|
|
460
469
|
- [Zyphr::Device](docs/Device.md)
|
|
461
470
|
- [Zyphr::DeviceListResponse](docs/DeviceListResponse.md)
|
|
462
471
|
- [Zyphr::DevicePushTopic](docs/DevicePushTopic.md)
|
|
@@ -514,6 +523,10 @@ Class | Method | HTTP request | Description
|
|
|
514
523
|
- [Zyphr::ListWaaSEndpointDeliveries200Response](docs/ListWaaSEndpointDeliveries200Response.md)
|
|
515
524
|
- [Zyphr::ListWaaSEndpoints200Response](docs/ListWaaSEndpoints200Response.md)
|
|
516
525
|
- [Zyphr::ListWaaSEventTypes200Response](docs/ListWaaSEventTypes200Response.md)
|
|
526
|
+
- [Zyphr::ListWorkflowExecutions200Response](docs/ListWorkflowExecutions200Response.md)
|
|
527
|
+
- [Zyphr::ListWorkflowExecutions200ResponseMeta](docs/ListWorkflowExecutions200ResponseMeta.md)
|
|
528
|
+
- [Zyphr::ListWorkflows200Response](docs/ListWorkflows200Response.md)
|
|
529
|
+
- [Zyphr::ListWorkflows200ResponseMeta](docs/ListWorkflows200ResponseMeta.md)
|
|
517
530
|
- [Zyphr::LoginRequest](docs/LoginRequest.md)
|
|
518
531
|
- [Zyphr::MagicLinkSendRequest](docs/MagicLinkSendRequest.md)
|
|
519
532
|
- [Zyphr::MagicLinkVerifyRequest](docs/MagicLinkVerifyRequest.md)
|
|
@@ -608,6 +621,7 @@ Class | Method | HTTP request | Description
|
|
|
608
621
|
- [Zyphr::RemoveTopicSubscribersRequest](docs/RemoveTopicSubscribersRequest.md)
|
|
609
622
|
- [Zyphr::RenameWebAuthnCredentialRequest](docs/RenameWebAuthnCredentialRequest.md)
|
|
610
623
|
- [Zyphr::RenderTemplateRequest](docs/RenderTemplateRequest.md)
|
|
624
|
+
- [Zyphr::ReorderWorkflowStepsRequest](docs/ReorderWorkflowStepsRequest.md)
|
|
611
625
|
- [Zyphr::ReplayWebhookEventsRequest](docs/ReplayWebhookEventsRequest.md)
|
|
612
626
|
- [Zyphr::RequestMeta](docs/RequestMeta.md)
|
|
613
627
|
- [Zyphr::ResetPasswordRequest](docs/ResetPasswordRequest.md)
|
|
@@ -678,7 +692,6 @@ Class | Method | HTTP request | Description
|
|
|
678
692
|
- [Zyphr::SmsConfigResponse](docs/SmsConfigResponse.md)
|
|
679
693
|
- [Zyphr::SmsDetailResponse](docs/SmsDetailResponse.md)
|
|
680
694
|
- [Zyphr::SmsListResponse](docs/SmsListResponse.md)
|
|
681
|
-
- [Zyphr::SmsListResponseMeta](docs/SmsListResponseMeta.md)
|
|
682
695
|
- [Zyphr::SmsMessage](docs/SmsMessage.md)
|
|
683
696
|
- [Zyphr::SmsMessageDetail](docs/SmsMessageDetail.md)
|
|
684
697
|
- [Zyphr::SubscribePushTopicRequest](docs/SubscribePushTopicRequest.md)
|
|
@@ -700,7 +713,6 @@ Class | Method | HTTP request | Description
|
|
|
700
713
|
- [Zyphr::TestWebhookTransformRequest](docs/TestWebhookTransformRequest.md)
|
|
701
714
|
- [Zyphr::Topic](docs/Topic.md)
|
|
702
715
|
- [Zyphr::TopicDeleteResponse](docs/TopicDeleteResponse.md)
|
|
703
|
-
- [Zyphr::TopicDeleteResponseData](docs/TopicDeleteResponseData.md)
|
|
704
716
|
- [Zyphr::TopicListResponse](docs/TopicListResponse.md)
|
|
705
717
|
- [Zyphr::TopicResponse](docs/TopicResponse.md)
|
|
706
718
|
- [Zyphr::TopicStatsData](docs/TopicStatsData.md)
|
|
@@ -712,6 +724,9 @@ Class | Method | HTTP request | Description
|
|
|
712
724
|
- [Zyphr::TopicSubscribersAddResult](docs/TopicSubscribersAddResult.md)
|
|
713
725
|
- [Zyphr::TopicSubscribersRemoveResponse](docs/TopicSubscribersRemoveResponse.md)
|
|
714
726
|
- [Zyphr::TopicSubscribersRemoveResult](docs/TopicSubscribersRemoveResult.md)
|
|
727
|
+
- [Zyphr::TriggerWorkflow202Response](docs/TriggerWorkflow202Response.md)
|
|
728
|
+
- [Zyphr::TriggerWorkflow202ResponseData](docs/TriggerWorkflow202ResponseData.md)
|
|
729
|
+
- [Zyphr::TriggerWorkflowRequest](docs/TriggerWorkflowRequest.md)
|
|
715
730
|
- [Zyphr::UnreadCountData](docs/UnreadCountData.md)
|
|
716
731
|
- [Zyphr::UnreadCountResponse](docs/UnreadCountResponse.md)
|
|
717
732
|
- [Zyphr::Unsubscribe](docs/Unsubscribe.md)
|
|
@@ -732,11 +747,13 @@ Class | Method | HTTP request | Description
|
|
|
732
747
|
- [Zyphr::UpdateWaaSEndpointRequest](docs/UpdateWaaSEndpointRequest.md)
|
|
733
748
|
- [Zyphr::UpdateWaaSEventTypeRequest](docs/UpdateWaaSEventTypeRequest.md)
|
|
734
749
|
- [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
|
750
|
+
- [Zyphr::UpdateWorkflowRequest](docs/UpdateWorkflowRequest.md)
|
|
751
|
+
- [Zyphr::UpdateWorkflowStatusRequest](docs/UpdateWorkflowStatusRequest.md)
|
|
752
|
+
- [Zyphr::UpdateWorkflowStepRequest](docs/UpdateWorkflowStepRequest.md)
|
|
735
753
|
- [Zyphr::UpsertAuthEmailTemplateRequest](docs/UpsertAuthEmailTemplateRequest.md)
|
|
736
754
|
- [Zyphr::UpsertSmsConfigRequest](docs/UpsertSmsConfigRequest.md)
|
|
737
755
|
- [Zyphr::UserDevicesDeleteResponse](docs/UserDevicesDeleteResponse.md)
|
|
738
756
|
- [Zyphr::UserDevicesDeleteResponseData](docs/UserDevicesDeleteResponseData.md)
|
|
739
|
-
- [Zyphr::V1MuseSubjectsSuggestPostRequest](docs/V1MuseSubjectsSuggestPostRequest.md)
|
|
740
757
|
- [Zyphr::ValidateResetTokenRequest](docs/ValidateResetTokenRequest.md)
|
|
741
758
|
- [Zyphr::ValidateResetTokenResponse](docs/ValidateResetTokenResponse.md)
|
|
742
759
|
- [Zyphr::ValidateResetTokenResponseData](docs/ValidateResetTokenResponseData.md)
|
|
@@ -812,10 +829,14 @@ Class | Method | HTTP request | Description
|
|
|
812
829
|
- [Zyphr::WebhookVersionsResponse](docs/WebhookVersionsResponse.md)
|
|
813
830
|
- [Zyphr::WebhookVersionsResponseData](docs/WebhookVersionsResponseData.md)
|
|
814
831
|
- [Zyphr::WithdrawSubscriberConsentRequest](docs/WithdrawSubscriberConsentRequest.md)
|
|
832
|
+
- [Zyphr::Workflow](docs/Workflow.md)
|
|
815
833
|
- [Zyphr::WorkflowExecution](docs/WorkflowExecution.md)
|
|
816
834
|
- [Zyphr::WorkflowExecutionStatus](docs/WorkflowExecutionStatus.md)
|
|
835
|
+
- [Zyphr::WorkflowStatus](docs/WorkflowStatus.md)
|
|
836
|
+
- [Zyphr::WorkflowStep](docs/WorkflowStep.md)
|
|
817
837
|
- [Zyphr::WorkflowStepExecution](docs/WorkflowStepExecution.md)
|
|
818
838
|
- [Zyphr::WorkflowStepExecutionStatus](docs/WorkflowStepExecutionStatus.md)
|
|
839
|
+
- [Zyphr::WorkflowStepType](docs/WorkflowStepType.md)
|
|
819
840
|
|
|
820
841
|
|
|
821
842
|
## Documentation for Authorization
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::AddWorkflowStep201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WorkflowStep**](WorkflowStep.md) | | [optional] |
|
|
8
|
+
| **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::AddWorkflowStep201Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Zyphr::AddWorkflowStepRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **step_key** | **String** | Unique step identifier within the workflow. | |
|
|
8
|
+
| **name** | **String** | Human-readable step name. | |
|
|
9
|
+
| **type** | [**WorkflowStepType**](WorkflowStepType.md) | | |
|
|
10
|
+
| **position** | **Integer** | Optional ordering position; appended to the end when omitted. | [optional] |
|
|
11
|
+
| **config** | **Hash<String, Object>** | Step configuration whose shape depends on `type`. | |
|
|
12
|
+
| **parent_step_id** | **String** | Parent step id (used for branch children). | [optional] |
|
|
13
|
+
| **branch_path** | **String** | Which branch path this step belongs to (branch children only). | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'zyphr'
|
|
19
|
+
|
|
20
|
+
instance = Zyphr::AddWorkflowStepRequest.new(
|
|
21
|
+
step_key: send-welcome-email,
|
|
22
|
+
name: null,
|
|
23
|
+
type: null,
|
|
24
|
+
position: null,
|
|
25
|
+
config: null,
|
|
26
|
+
parent_step_id: null,
|
|
27
|
+
branch_path: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
data/docs/AuthRegistrationApi.md
CHANGED
|
@@ -228,7 +228,7 @@ end
|
|
|
228
228
|
|
|
229
229
|
Sign in with Apple Game Center
|
|
230
230
|
|
|
231
|
-
Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the
|
|
231
|
+
Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the player's `teamPlayerID` (the id GameKit signs the assertion over). ## Producing the assertion (Integration) The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit's `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player's `teamPlayerID` (NOT `gamePlayerID`) and the app's bundle identifier and submit them here. Two integration shapes are supported: - **client-direct** — the iOS app holds the Zyphr application public key and calls this endpoint itself. - **backend-relayed** — the app forwards the fetched assertion fields to the customer's own backend, which relays them to this endpoint; the app never holds Zyphr keys. (This is the common shape for games.) On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed.
|
|
232
232
|
|
|
233
233
|
### Examples
|
|
234
234
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::CreateWorkflow201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Workflow**](Workflow.md) | | [optional] |
|
|
8
|
+
| **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::CreateWorkflow201Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zyphr::CreateWorkflowRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Human-readable workflow name. | |
|
|
8
|
+
| **key** | **String** | Unique workflow key within the project. Derived from `name` when omitted. | [optional] |
|
|
9
|
+
| **description** | **String** | Optional description of what the workflow does. | [optional] |
|
|
10
|
+
| **is_critical** | **Boolean** | Marks the workflow as critical (bypasses certain preference checks). | [optional][default to false] |
|
|
11
|
+
| **tags** | **Array<String>** | Optional tags for organizing workflows. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zyphr'
|
|
17
|
+
|
|
18
|
+
instance = Zyphr::CreateWorkflowRequest.new(
|
|
19
|
+
name: Welcome Series,
|
|
20
|
+
key: welcome-series,
|
|
21
|
+
description: null,
|
|
22
|
+
is_critical: null,
|
|
23
|
+
tags: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::DeleteWorkflow200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**DeleteWorkflow200ResponseData**](DeleteWorkflow200ResponseData.md) | | [optional] |
|
|
8
|
+
| **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::DeleteWorkflow200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zyphr::
|
|
1
|
+
# Zyphr::DeleteWorkflow200ResponseData
|
|
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::DeleteWorkflow200ResponseData.new(
|
|
16
16
|
key: null,
|
|
17
17
|
deleted: null
|
|
18
18
|
)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::DeleteWorkflowStep200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**DeleteWorkflowStep200ResponseData**](DeleteWorkflowStep200ResponseData.md) | | [optional] |
|
|
8
|
+
| **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::DeleteWorkflowStep200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zyphr::DeleteWorkflowStep200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **workflow_key** | **String** | | [optional] |
|
|
8
|
+
| **step_key** | **String** | | [optional] |
|
|
9
|
+
| **deleted** | **Boolean** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zyphr'
|
|
15
|
+
|
|
16
|
+
instance = Zyphr::DeleteWorkflowStep200ResponseData.new(
|
|
17
|
+
workflow_key: null,
|
|
18
|
+
step_key: null,
|
|
19
|
+
deleted: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::ListWorkflowExecutions200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<WorkflowExecution>**](WorkflowExecution.md) | | [optional] |
|
|
8
|
+
| **meta** | [**ListWorkflowExecutions200ResponseMeta**](ListWorkflowExecutions200ResponseMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::ListWorkflowExecutions200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zyphr::
|
|
1
|
+
# Zyphr::ListWorkflowExecutions200ResponseMeta
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'zyphr'
|
|
17
17
|
|
|
18
|
-
instance = Zyphr::
|
|
18
|
+
instance = Zyphr::ListWorkflowExecutions200ResponseMeta.new(
|
|
19
19
|
request_id: null,
|
|
20
20
|
page: null,
|
|
21
21
|
per_page: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::ListWorkflows200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<Workflow>**](Workflow.md) | | [optional] |
|
|
8
|
+
| **meta** | [**ListWorkflows200ResponseMeta**](ListWorkflows200ResponseMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::ListWorkflows200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zyphr::ListWorkflows200ResponseMeta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request_id** | **String** | | [optional] |
|
|
8
|
+
| **page** | **Integer** | | [optional] |
|
|
9
|
+
| **per_page** | **Integer** | | [optional] |
|
|
10
|
+
| **total** | **Integer** | | [optional] |
|
|
11
|
+
| **total_pages** | **Integer** | | [optional] |
|
|
12
|
+
| **limit** | **Integer** | Maximum workflows allowed on the account's plan. | [optional] |
|
|
13
|
+
| **plan** | **String** | | [optional] |
|
|
14
|
+
| **count** | **Integer** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zyphr'
|
|
20
|
+
|
|
21
|
+
instance = Zyphr::ListWorkflows200ResponseMeta.new(
|
|
22
|
+
request_id: null,
|
|
23
|
+
page: null,
|
|
24
|
+
per_page: null,
|
|
25
|
+
total: null,
|
|
26
|
+
total_pages: null,
|
|
27
|
+
limit: null,
|
|
28
|
+
plan: null,
|
|
29
|
+
count: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::ReorderWorkflowStepsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **step_keys** | **Array<String>** | The workflow's step keys in the new desired order. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::ReorderWorkflowStepsRequest.new(
|
|
15
|
+
step_keys: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **player_id** | **String** | The
|
|
7
|
+
| **player_id** | **String** | The player's `teamPlayerID` from `GKLocalPlayer` (the id GameKit signs the identity assertion over — form `T:_…`). NOT `gamePlayerID` (`A:_…`) and NOT the deprecated legacy `playerID`. Sending any other id yields a verification failure (opaque `401 invalid_assertion`). | |
|
|
8
8
|
| **public_key_url** | **String** | Apple-supplied URL to the public-key certificate. Must be https on an apple.com host; server-side SSRF-guarded before fetch. | |
|
|
9
9
|
| **signature** | **String** | Base64-encoded RSA signature returned by GameKit. | |
|
|
10
10
|
| **salt** | **String** | Base64-encoded salt bytes returned by GameKit. | |
|
data/docs/SmsListResponse.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **data** | [**Array<SmsMessage>**](SmsMessage.md) | | [optional] |
|
|
8
|
-
| **meta** | [**
|
|
8
|
+
| **meta** | [**ListWorkflowExecutions200ResponseMeta**](ListWorkflowExecutions200ResponseMeta.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
data/docs/TopicDeleteResponse.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | [**
|
|
7
|
+
| **data** | [**DeleteWorkflow200ResponseData**](DeleteWorkflow200ResponseData.md) | | [optional] |
|
|
8
8
|
| **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::TriggerWorkflow202Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**TriggerWorkflow202ResponseData**](TriggerWorkflow202ResponseData.md) | | [optional] |
|
|
8
|
+
| **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::TriggerWorkflow202Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zyphr::TriggerWorkflow202ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **execution_ids** | **Array<String>** | | [optional] |
|
|
8
|
+
| **subscriber_count** | **Integer** | | [optional] |
|
|
9
|
+
| **workflow_key** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zyphr'
|
|
15
|
+
|
|
16
|
+
instance = Zyphr::TriggerWorkflow202ResponseData.new(
|
|
17
|
+
execution_ids: null,
|
|
18
|
+
subscriber_count: null,
|
|
19
|
+
workflow_key: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zyphr::TriggerWorkflowRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **to** | **Array<String>** | Recipient(s). An array of subscriber ids. For convenience the API also accepts a single subscriber id string, or a topic fan-out object `{ \"topic\": \"<topic_key>\" }` to deliver to every subscriber of a topic. | |
|
|
8
|
+
| **payload** | **Hash<String, Object>** | Data made available to step templates and branch conditions. | [optional] |
|
|
9
|
+
| **transaction_id** | **String** | Optional idempotency/correlation identifier. | [optional] |
|
|
10
|
+
| **from** | **String** | Optional sender override for email steps (e.g. `noreply@yourdomain.com`). | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zyphr'
|
|
16
|
+
|
|
17
|
+
instance = Zyphr::TriggerWorkflowRequest.new(
|
|
18
|
+
to: ["user_123","user_456"],
|
|
19
|
+
payload: null,
|
|
20
|
+
transaction_id: null,
|
|
21
|
+
from: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zyphr::UpdateWorkflowRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
| **is_critical** | **Boolean** | | [optional] |
|
|
10
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zyphr'
|
|
16
|
+
|
|
17
|
+
instance = Zyphr::UpdateWorkflowRequest.new(
|
|
18
|
+
name: null,
|
|
19
|
+
description: null,
|
|
20
|
+
is_critical: null,
|
|
21
|
+
tags: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::UpdateWorkflowStatusRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | [**WorkflowStatus**](WorkflowStatus.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::UpdateWorkflowStatusRequest.new(
|
|
15
|
+
status: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::UpdateWorkflowStepRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **config** | **Hash<String, Object>** | Step configuration whose shape depends on the step's type. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::UpdateWorkflowStepRequest.new(
|
|
16
|
+
name: null,
|
|
17
|
+
config: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|