zyphr 0.1.38 → 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 +37 -14
- data/docs/AddWorkflowStep201Response.md +20 -0
- data/docs/AddWorkflowStepRequest.md +30 -0
- data/docs/AuthRegistrationApi.md +73 -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/SignInWithGooglePlayGamesRequest.md +18 -0
- 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 +70 -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/sign_in_with_google_play_games_request.rb +238 -0
- 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 +25 -4
- data/spec/api/auth_registration_api_spec.rb +13 -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/sign_in_with_google_play_games_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 +102 -18
- 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
|
@@ -189,6 +189,7 @@ Class | Method | HTTP request | Description
|
|
|
189
189
|
*Zyphr::AuthRegistrationApi* | [**register_end_user**](docs/AuthRegistrationApi.md#register_end_user) | **POST** /auth/users/register | Register a new end user
|
|
190
190
|
*Zyphr::AuthRegistrationApi* | [**sign_in_anonymously**](docs/AuthRegistrationApi.md#sign_in_anonymously) | **POST** /auth/users/anonymous | Sign in anonymously
|
|
191
191
|
*Zyphr::AuthRegistrationApi* | [**sign_in_with_game_center**](docs/AuthRegistrationApi.md#sign_in_with_game_center) | **POST** /auth/game-center | Sign in with Apple Game Center
|
|
192
|
+
*Zyphr::AuthRegistrationApi* | [**sign_in_with_google_play_games**](docs/AuthRegistrationApi.md#sign_in_with_google_play_games) | **POST** /auth/google-play-games | Sign in with Google Play Games Services
|
|
192
193
|
*Zyphr::AuthSessionsApi* | [**list_end_user_sessions**](docs/AuthSessionsApi.md#list_end_user_sessions) | **GET** /auth/sessions | List active sessions
|
|
193
194
|
*Zyphr::AuthSessionsApi* | [**refresh_end_user_token**](docs/AuthSessionsApi.md#refresh_end_user_token) | **POST** /auth/sessions/refresh | Refresh access token
|
|
194
195
|
*Zyphr::AuthSessionsApi* | [**revoke_all_end_user_sessions**](docs/AuthSessionsApi.md#revoke_all_end_user_sessions) | **POST** /auth/sessions/revoke-all | Revoke all sessions
|
|
@@ -257,17 +258,6 @@ Class | Method | HTTP request | Description
|
|
|
257
258
|
*Zyphr::InboxApi* | [**send_batch_in_app**](docs/InboxApi.md#send_batch_in_app) | **POST** /inbox/send/batch | Send batch in-app notifications
|
|
258
259
|
*Zyphr::InboxApi* | [**send_in_app**](docs/InboxApi.md#send_in_app) | **POST** /inbox/send | Send an in-app notification
|
|
259
260
|
*Zyphr::InboxApi* | [**update_subscriber_preferences**](docs/InboxApi.md#update_subscriber_preferences) | **PUT** /subscriber-inbox/preferences | Update subscriber preferences
|
|
260
|
-
*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
|
|
261
|
-
*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
|
|
262
|
-
*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
|
|
263
|
-
*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
|
|
264
|
-
*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
|
|
265
|
-
*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)
|
|
266
|
-
*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
|
|
267
|
-
*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
|
|
268
|
-
*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
|
|
269
|
-
*Zyphr::MuseApi* | [**v1_muse_usage_get**](docs/MuseApi.md#v1_muse_usage_get) | **GET** /v1/muse/usage | Per-account Zyphr Muse usage + budget tier
|
|
270
|
-
*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
|
|
271
261
|
*Zyphr::PushApi* | [**get_push**](docs/PushApi.md#get_push) | **GET** /push/{id} | Get push notification details
|
|
272
262
|
*Zyphr::PushApi* | [**get_push_stats**](docs/PushApi.md#get_push_stats) | **GET** /push/stats | Get push notification statistics
|
|
273
263
|
*Zyphr::PushApi* | [**list_device_push_topics**](docs/PushApi.md#list_device_push_topics) | **GET** /push/devices/{id}/topics | List topics for a device
|
|
@@ -377,6 +367,18 @@ Class | Method | HTTP request | Description
|
|
|
377
367
|
*Zyphr::WebhooksApi* | [**send_webhook_test_event**](docs/WebhooksApi.md#send_webhook_test_event) | **POST** /v1/webhooks/{id}/test | Send test event
|
|
378
368
|
*Zyphr::WebhooksApi* | [**test_webhook_transform**](docs/WebhooksApi.md#test_webhook_transform) | **POST** /v1/webhooks/{id}/transform/test | Test payload transformation
|
|
379
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
|
|
380
382
|
|
|
381
383
|
|
|
382
384
|
## Documentation for Models
|
|
@@ -386,6 +388,8 @@ Class | Method | HTTP request | Description
|
|
|
386
388
|
- [Zyphr::AddDomainRequest](docs/AddDomainRequest.md)
|
|
387
389
|
- [Zyphr::AddOrganizationMemberRequest](docs/AddOrganizationMemberRequest.md)
|
|
388
390
|
- [Zyphr::AddTopicSubscribersRequest](docs/AddTopicSubscribersRequest.md)
|
|
391
|
+
- [Zyphr::AddWorkflowStep201Response](docs/AddWorkflowStep201Response.md)
|
|
392
|
+
- [Zyphr::AddWorkflowStepRequest](docs/AddWorkflowStepRequest.md)
|
|
389
393
|
- [Zyphr::ApiError](docs/ApiError.md)
|
|
390
394
|
- [Zyphr::ApiErrorError](docs/ApiErrorError.md)
|
|
391
395
|
- [Zyphr::ApiErrorMeta](docs/ApiErrorMeta.md)
|
|
@@ -452,10 +456,16 @@ Class | Method | HTTP request | Description
|
|
|
452
456
|
- [Zyphr::CreateWaaSEventType201Response](docs/CreateWaaSEventType201Response.md)
|
|
453
457
|
- [Zyphr::CreateWaaSEventTypeRequest](docs/CreateWaaSEventTypeRequest.md)
|
|
454
458
|
- [Zyphr::CreateWebhookRequest](docs/CreateWebhookRequest.md)
|
|
459
|
+
- [Zyphr::CreateWorkflow201Response](docs/CreateWorkflow201Response.md)
|
|
460
|
+
- [Zyphr::CreateWorkflowRequest](docs/CreateWorkflowRequest.md)
|
|
455
461
|
- [Zyphr::DeleteDomainResponse](docs/DeleteDomainResponse.md)
|
|
456
462
|
- [Zyphr::DeleteDomainResponseData](docs/DeleteDomainResponseData.md)
|
|
457
463
|
- [Zyphr::DeleteResult](docs/DeleteResult.md)
|
|
458
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)
|
|
459
469
|
- [Zyphr::Device](docs/Device.md)
|
|
460
470
|
- [Zyphr::DeviceListResponse](docs/DeviceListResponse.md)
|
|
461
471
|
- [Zyphr::DevicePushTopic](docs/DevicePushTopic.md)
|
|
@@ -513,6 +523,10 @@ Class | Method | HTTP request | Description
|
|
|
513
523
|
- [Zyphr::ListWaaSEndpointDeliveries200Response](docs/ListWaaSEndpointDeliveries200Response.md)
|
|
514
524
|
- [Zyphr::ListWaaSEndpoints200Response](docs/ListWaaSEndpoints200Response.md)
|
|
515
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)
|
|
516
530
|
- [Zyphr::LoginRequest](docs/LoginRequest.md)
|
|
517
531
|
- [Zyphr::MagicLinkSendRequest](docs/MagicLinkSendRequest.md)
|
|
518
532
|
- [Zyphr::MagicLinkVerifyRequest](docs/MagicLinkVerifyRequest.md)
|
|
@@ -607,6 +621,7 @@ Class | Method | HTTP request | Description
|
|
|
607
621
|
- [Zyphr::RemoveTopicSubscribersRequest](docs/RemoveTopicSubscribersRequest.md)
|
|
608
622
|
- [Zyphr::RenameWebAuthnCredentialRequest](docs/RenameWebAuthnCredentialRequest.md)
|
|
609
623
|
- [Zyphr::RenderTemplateRequest](docs/RenderTemplateRequest.md)
|
|
624
|
+
- [Zyphr::ReorderWorkflowStepsRequest](docs/ReorderWorkflowStepsRequest.md)
|
|
610
625
|
- [Zyphr::ReplayWebhookEventsRequest](docs/ReplayWebhookEventsRequest.md)
|
|
611
626
|
- [Zyphr::RequestMeta](docs/RequestMeta.md)
|
|
612
627
|
- [Zyphr::ResetPasswordRequest](docs/ResetPasswordRequest.md)
|
|
@@ -662,6 +677,7 @@ Class | Method | HTTP request | Description
|
|
|
662
677
|
- [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
|
|
663
678
|
- [Zyphr::SignInAnonymouslyRequest](docs/SignInAnonymouslyRequest.md)
|
|
664
679
|
- [Zyphr::SignInWithGameCenterRequest](docs/SignInWithGameCenterRequest.md)
|
|
680
|
+
- [Zyphr::SignInWithGooglePlayGamesRequest](docs/SignInWithGooglePlayGamesRequest.md)
|
|
665
681
|
- [Zyphr::SlackMessage](docs/SlackMessage.md)
|
|
666
682
|
- [Zyphr::SlackMessageListResponse](docs/SlackMessageListResponse.md)
|
|
667
683
|
- [Zyphr::SlackMessageListResponseMeta](docs/SlackMessageListResponseMeta.md)
|
|
@@ -676,7 +692,6 @@ Class | Method | HTTP request | Description
|
|
|
676
692
|
- [Zyphr::SmsConfigResponse](docs/SmsConfigResponse.md)
|
|
677
693
|
- [Zyphr::SmsDetailResponse](docs/SmsDetailResponse.md)
|
|
678
694
|
- [Zyphr::SmsListResponse](docs/SmsListResponse.md)
|
|
679
|
-
- [Zyphr::SmsListResponseMeta](docs/SmsListResponseMeta.md)
|
|
680
695
|
- [Zyphr::SmsMessage](docs/SmsMessage.md)
|
|
681
696
|
- [Zyphr::SmsMessageDetail](docs/SmsMessageDetail.md)
|
|
682
697
|
- [Zyphr::SubscribePushTopicRequest](docs/SubscribePushTopicRequest.md)
|
|
@@ -698,7 +713,6 @@ Class | Method | HTTP request | Description
|
|
|
698
713
|
- [Zyphr::TestWebhookTransformRequest](docs/TestWebhookTransformRequest.md)
|
|
699
714
|
- [Zyphr::Topic](docs/Topic.md)
|
|
700
715
|
- [Zyphr::TopicDeleteResponse](docs/TopicDeleteResponse.md)
|
|
701
|
-
- [Zyphr::TopicDeleteResponseData](docs/TopicDeleteResponseData.md)
|
|
702
716
|
- [Zyphr::TopicListResponse](docs/TopicListResponse.md)
|
|
703
717
|
- [Zyphr::TopicResponse](docs/TopicResponse.md)
|
|
704
718
|
- [Zyphr::TopicStatsData](docs/TopicStatsData.md)
|
|
@@ -710,6 +724,9 @@ Class | Method | HTTP request | Description
|
|
|
710
724
|
- [Zyphr::TopicSubscribersAddResult](docs/TopicSubscribersAddResult.md)
|
|
711
725
|
- [Zyphr::TopicSubscribersRemoveResponse](docs/TopicSubscribersRemoveResponse.md)
|
|
712
726
|
- [Zyphr::TopicSubscribersRemoveResult](docs/TopicSubscribersRemoveResult.md)
|
|
727
|
+
- [Zyphr::TriggerWorkflow202Response](docs/TriggerWorkflow202Response.md)
|
|
728
|
+
- [Zyphr::TriggerWorkflow202ResponseData](docs/TriggerWorkflow202ResponseData.md)
|
|
729
|
+
- [Zyphr::TriggerWorkflowRequest](docs/TriggerWorkflowRequest.md)
|
|
713
730
|
- [Zyphr::UnreadCountData](docs/UnreadCountData.md)
|
|
714
731
|
- [Zyphr::UnreadCountResponse](docs/UnreadCountResponse.md)
|
|
715
732
|
- [Zyphr::Unsubscribe](docs/Unsubscribe.md)
|
|
@@ -730,11 +747,13 @@ Class | Method | HTTP request | Description
|
|
|
730
747
|
- [Zyphr::UpdateWaaSEndpointRequest](docs/UpdateWaaSEndpointRequest.md)
|
|
731
748
|
- [Zyphr::UpdateWaaSEventTypeRequest](docs/UpdateWaaSEventTypeRequest.md)
|
|
732
749
|
- [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
|
750
|
+
- [Zyphr::UpdateWorkflowRequest](docs/UpdateWorkflowRequest.md)
|
|
751
|
+
- [Zyphr::UpdateWorkflowStatusRequest](docs/UpdateWorkflowStatusRequest.md)
|
|
752
|
+
- [Zyphr::UpdateWorkflowStepRequest](docs/UpdateWorkflowStepRequest.md)
|
|
733
753
|
- [Zyphr::UpsertAuthEmailTemplateRequest](docs/UpsertAuthEmailTemplateRequest.md)
|
|
734
754
|
- [Zyphr::UpsertSmsConfigRequest](docs/UpsertSmsConfigRequest.md)
|
|
735
755
|
- [Zyphr::UserDevicesDeleteResponse](docs/UserDevicesDeleteResponse.md)
|
|
736
756
|
- [Zyphr::UserDevicesDeleteResponseData](docs/UserDevicesDeleteResponseData.md)
|
|
737
|
-
- [Zyphr::V1MuseSubjectsSuggestPostRequest](docs/V1MuseSubjectsSuggestPostRequest.md)
|
|
738
757
|
- [Zyphr::ValidateResetTokenRequest](docs/ValidateResetTokenRequest.md)
|
|
739
758
|
- [Zyphr::ValidateResetTokenResponse](docs/ValidateResetTokenResponse.md)
|
|
740
759
|
- [Zyphr::ValidateResetTokenResponseData](docs/ValidateResetTokenResponseData.md)
|
|
@@ -810,10 +829,14 @@ Class | Method | HTTP request | Description
|
|
|
810
829
|
- [Zyphr::WebhookVersionsResponse](docs/WebhookVersionsResponse.md)
|
|
811
830
|
- [Zyphr::WebhookVersionsResponseData](docs/WebhookVersionsResponseData.md)
|
|
812
831
|
- [Zyphr::WithdrawSubscriberConsentRequest](docs/WithdrawSubscriberConsentRequest.md)
|
|
832
|
+
- [Zyphr::Workflow](docs/Workflow.md)
|
|
813
833
|
- [Zyphr::WorkflowExecution](docs/WorkflowExecution.md)
|
|
814
834
|
- [Zyphr::WorkflowExecutionStatus](docs/WorkflowExecutionStatus.md)
|
|
835
|
+
- [Zyphr::WorkflowStatus](docs/WorkflowStatus.md)
|
|
836
|
+
- [Zyphr::WorkflowStep](docs/WorkflowStep.md)
|
|
815
837
|
- [Zyphr::WorkflowStepExecution](docs/WorkflowStepExecution.md)
|
|
816
838
|
- [Zyphr::WorkflowStepExecutionStatus](docs/WorkflowStepExecutionStatus.md)
|
|
839
|
+
- [Zyphr::WorkflowStepType](docs/WorkflowStepType.md)
|
|
817
840
|
|
|
818
841
|
|
|
819
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
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
|
|
|
8
8
|
| [**register_end_user**](AuthRegistrationApi.md#register_end_user) | **POST** /auth/users/register | Register a new end user |
|
|
9
9
|
| [**sign_in_anonymously**](AuthRegistrationApi.md#sign_in_anonymously) | **POST** /auth/users/anonymous | Sign in anonymously |
|
|
10
10
|
| [**sign_in_with_game_center**](AuthRegistrationApi.md#sign_in_with_game_center) | **POST** /auth/game-center | Sign in with Apple Game Center |
|
|
11
|
+
| [**sign_in_with_google_play_games**](AuthRegistrationApi.md#sign_in_with_google_play_games) | **POST** /auth/google-play-games | Sign in with Google Play Games Services |
|
|
11
12
|
|
|
12
13
|
|
|
13
14
|
## convert_anonymous_user
|
|
@@ -227,7 +228,7 @@ end
|
|
|
227
228
|
|
|
228
229
|
Sign in with Apple Game Center
|
|
229
230
|
|
|
230
|
-
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.
|
|
231
232
|
|
|
232
233
|
### Examples
|
|
233
234
|
|
|
@@ -291,3 +292,74 @@ end
|
|
|
291
292
|
- **Content-Type**: application/json
|
|
292
293
|
- **Accept**: application/json
|
|
293
294
|
|
|
295
|
+
|
|
296
|
+
## sign_in_with_google_play_games
|
|
297
|
+
|
|
298
|
+
> <AuthResultResponse> sign_in_with_google_play_games(sign_in_with_google_play_games_request)
|
|
299
|
+
|
|
300
|
+
Sign in with Google Play Games Services
|
|
301
|
+
|
|
302
|
+
Exchange a Google Play Games Services (GPGS) **server auth code** for a Zyphr end-user session. Unlike Game Center (which submits an Apple-signed assertion), GPGS is verified by Google: Zyphr exchanges the single-use server auth code at Google's OAuth2 token endpoint, then calls the Play Games REST API (`players/me`) server-side to obtain the trusted, tamper-proof `playerId`. The user is provisioned-or-looked-up on that server-fetched `playerId` and tokens are minted. ## Producing the server auth code (Integration) The server auth code is obtained **on-device by the Android app** — there is no server-side way to mint it. The app calls `GamesSignInClient.requestServerSideAccess(serverClientId, …)` using the Google Cloud **web (server) client id** configured for the game, which returns a single-use auth code string. Submit that string here as `serverAuthCode`. The **backend-relayed** shape is the common one: the app forwards the auth code to the customer's own backend, which relays it to this endpoint; the app never holds Zyphr keys. ## Security The `playerId` is derived **only** from Zyphr's own server-side call to Google after the token exchange — a client-supplied player id is never accepted or trusted. On any verification failure the response is a single opaque `401` `invalid_auth_code`; the specific control that failed is never disclosed.
|
|
303
|
+
|
|
304
|
+
### Examples
|
|
305
|
+
|
|
306
|
+
```ruby
|
|
307
|
+
require 'time'
|
|
308
|
+
require 'zyphr'
|
|
309
|
+
# setup authorization
|
|
310
|
+
Zyphr.configure do |config|
|
|
311
|
+
# Configure API key authorization: ApplicationPublicKey
|
|
312
|
+
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
313
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
314
|
+
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
api_instance = Zyphr::AuthRegistrationApi.new
|
|
318
|
+
sign_in_with_google_play_games_request = Zyphr::SignInWithGooglePlayGamesRequest.new({server_auth_code: 'server_auth_code_example'}) # SignInWithGooglePlayGamesRequest |
|
|
319
|
+
|
|
320
|
+
begin
|
|
321
|
+
# Sign in with Google Play Games Services
|
|
322
|
+
result = api_instance.sign_in_with_google_play_games(sign_in_with_google_play_games_request)
|
|
323
|
+
p result
|
|
324
|
+
rescue Zyphr::ApiError => e
|
|
325
|
+
puts "Error when calling AuthRegistrationApi->sign_in_with_google_play_games: #{e}"
|
|
326
|
+
end
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
#### Using the sign_in_with_google_play_games_with_http_info variant
|
|
330
|
+
|
|
331
|
+
This returns an Array which contains the response data, status code and headers.
|
|
332
|
+
|
|
333
|
+
> <Array(<AuthResultResponse>, Integer, Hash)> sign_in_with_google_play_games_with_http_info(sign_in_with_google_play_games_request)
|
|
334
|
+
|
|
335
|
+
```ruby
|
|
336
|
+
begin
|
|
337
|
+
# Sign in with Google Play Games Services
|
|
338
|
+
data, status_code, headers = api_instance.sign_in_with_google_play_games_with_http_info(sign_in_with_google_play_games_request)
|
|
339
|
+
p status_code # => 2xx
|
|
340
|
+
p headers # => { ... }
|
|
341
|
+
p data # => <AuthResultResponse>
|
|
342
|
+
rescue Zyphr::ApiError => e
|
|
343
|
+
puts "Error when calling AuthRegistrationApi->sign_in_with_google_play_games_with_http_info: #{e}"
|
|
344
|
+
end
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
### Parameters
|
|
348
|
+
|
|
349
|
+
| Name | Type | Description | Notes |
|
|
350
|
+
| ---- | ---- | ----------- | ----- |
|
|
351
|
+
| **sign_in_with_google_play_games_request** | [**SignInWithGooglePlayGamesRequest**](SignInWithGooglePlayGamesRequest.md) | | |
|
|
352
|
+
|
|
353
|
+
### Return type
|
|
354
|
+
|
|
355
|
+
[**AuthResultResponse**](AuthResultResponse.md)
|
|
356
|
+
|
|
357
|
+
### Authorization
|
|
358
|
+
|
|
359
|
+
[ApplicationPublicKey](../README.md#ApplicationPublicKey)
|
|
360
|
+
|
|
361
|
+
### HTTP request headers
|
|
362
|
+
|
|
363
|
+
- **Content-Type**: application/json
|
|
364
|
+
- **Accept**: application/json
|
|
365
|
+
|
|
@@ -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. | |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::SignInWithGooglePlayGamesRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **server_auth_code** | **String** | The single-use server auth code from GamesSignInClient.requestServerSideAccess (obtained with the game's web/server client id). Zyphr exchanges it server-side; a client-supplied player id is neither accepted nor trusted. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::SignInWithGooglePlayGamesRequest.new(
|
|
15
|
+
server_auth_code: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
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
|
+
|