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.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -14
  3. data/docs/AddWorkflowStep201Response.md +20 -0
  4. data/docs/AddWorkflowStepRequest.md +30 -0
  5. data/docs/AuthRegistrationApi.md +73 -1
  6. data/docs/CreateWorkflow201Response.md +20 -0
  7. data/docs/CreateWorkflowRequest.md +26 -0
  8. data/docs/DeleteWorkflow200Response.md +20 -0
  9. data/docs/{TopicDeleteResponseData.md → DeleteWorkflow200ResponseData.md} +2 -2
  10. data/docs/DeleteWorkflowStep200Response.md +20 -0
  11. data/docs/DeleteWorkflowStep200ResponseData.md +22 -0
  12. data/docs/ListWorkflowExecutions200Response.md +20 -0
  13. data/docs/{SmsListResponseMeta.md → ListWorkflowExecutions200ResponseMeta.md} +2 -2
  14. data/docs/ListWorkflows200Response.md +20 -0
  15. data/docs/ListWorkflows200ResponseMeta.md +32 -0
  16. data/docs/ReorderWorkflowStepsRequest.md +18 -0
  17. data/docs/SignInWithGameCenterRequest.md +1 -1
  18. data/docs/SignInWithGooglePlayGamesRequest.md +18 -0
  19. data/docs/SmsListResponse.md +1 -1
  20. data/docs/TopicDeleteResponse.md +1 -1
  21. data/docs/TriggerWorkflow202Response.md +20 -0
  22. data/docs/TriggerWorkflow202ResponseData.md +22 -0
  23. data/docs/TriggerWorkflowRequest.md +24 -0
  24. data/docs/UpdateWorkflowRequest.md +24 -0
  25. data/docs/UpdateWorkflowStatusRequest.md +18 -0
  26. data/docs/UpdateWorkflowStepRequest.md +20 -0
  27. data/docs/Workflow.md +42 -0
  28. data/docs/WorkflowStatus.md +15 -0
  29. data/docs/WorkflowStep.md +38 -0
  30. data/docs/WorkflowStepType.md +15 -0
  31. data/docs/WorkflowsApi.md +901 -0
  32. data/lib/zyphr/api/auth_registration_api.rb +70 -2
  33. data/lib/zyphr/api/workflows_api.rb +897 -0
  34. data/lib/zyphr/models/add_workflow_step201_response.rb +229 -0
  35. data/lib/zyphr/models/add_workflow_step_request.rb +384 -0
  36. data/lib/zyphr/models/create_workflow201_response.rb +229 -0
  37. data/lib/zyphr/models/create_workflow_request.rb +292 -0
  38. data/lib/zyphr/models/delete_workflow200_response.rb +229 -0
  39. data/lib/zyphr/models/{topic_delete_response_data.rb → delete_workflow200_response_data.rb} +3 -3
  40. data/lib/zyphr/models/delete_workflow_step200_response.rb +229 -0
  41. data/lib/zyphr/models/delete_workflow_step200_response_data.rb +238 -0
  42. data/lib/zyphr/models/list_workflow_executions200_response.rb +231 -0
  43. data/lib/zyphr/models/{sms_list_response_meta.rb → list_workflow_executions200_response_meta.rb} +3 -3
  44. data/lib/zyphr/models/list_workflows200_response.rb +231 -0
  45. data/lib/zyphr/models/list_workflows200_response_meta.rb +284 -0
  46. data/lib/zyphr/models/reorder_workflow_steps_request.rb +249 -0
  47. data/lib/zyphr/models/sign_in_with_game_center_request.rb +1 -1
  48. data/lib/zyphr/models/sign_in_with_google_play_games_request.rb +238 -0
  49. data/lib/zyphr/models/sms_list_response.rb +1 -1
  50. data/lib/zyphr/models/topic_delete_response.rb +1 -1
  51. data/lib/zyphr/models/trigger_workflow202_response.rb +229 -0
  52. data/lib/zyphr/models/trigger_workflow202_response_data.rb +240 -0
  53. data/lib/zyphr/models/trigger_workflow_request.rb +272 -0
  54. data/lib/zyphr/models/update_workflow_request.rb +269 -0
  55. data/lib/zyphr/models/{v1_muse_subjects_suggest_post_request.rb → update_workflow_status_request.rb} +19 -86
  56. data/lib/zyphr/models/update_workflow_step_request.rb +232 -0
  57. data/lib/zyphr/models/workflow.rb +514 -0
  58. data/lib/zyphr/models/workflow_status.rb +42 -0
  59. data/lib/zyphr/models/workflow_step.rb +505 -0
  60. data/lib/zyphr/models/workflow_step_type.rb +47 -0
  61. data/lib/zyphr.rb +25 -4
  62. data/spec/api/auth_registration_api_spec.rb +13 -1
  63. data/spec/api/workflows_api_spec.rb +192 -0
  64. data/spec/models/add_workflow_step201_response_spec.rb +42 -0
  65. data/spec/models/add_workflow_step_request_spec.rb +76 -0
  66. data/spec/models/create_workflow201_response_spec.rb +42 -0
  67. data/spec/models/{v1_muse_subjects_suggest_post_request_spec.rb → create_workflow_request_spec.rb} +16 -14
  68. data/spec/models/{topic_delete_response_data_spec.rb → delete_workflow200_response_data_spec.rb} +6 -6
  69. data/spec/models/delete_workflow200_response_spec.rb +42 -0
  70. data/spec/models/delete_workflow_step200_response_data_spec.rb +48 -0
  71. data/spec/models/delete_workflow_step200_response_spec.rb +42 -0
  72. data/spec/models/{sms_list_response_meta_spec.rb → list_workflow_executions200_response_meta_spec.rb} +6 -6
  73. data/spec/models/list_workflow_executions200_response_spec.rb +42 -0
  74. data/spec/models/list_workflows200_response_meta_spec.rb +78 -0
  75. data/spec/models/list_workflows200_response_spec.rb +42 -0
  76. data/spec/models/reorder_workflow_steps_request_spec.rb +36 -0
  77. data/spec/models/sign_in_with_google_play_games_request_spec.rb +36 -0
  78. data/spec/models/trigger_workflow202_response_data_spec.rb +48 -0
  79. data/spec/models/trigger_workflow202_response_spec.rb +42 -0
  80. data/spec/models/trigger_workflow_request_spec.rb +54 -0
  81. data/spec/models/update_workflow_request_spec.rb +54 -0
  82. data/spec/models/update_workflow_status_request_spec.rb +36 -0
  83. data/spec/models/update_workflow_step_request_spec.rb +42 -0
  84. data/spec/models/workflow_spec.rb +108 -0
  85. data/spec/models/workflow_status_spec.rb +30 -0
  86. data/spec/models/workflow_step_spec.rb +100 -0
  87. data/spec/models/workflow_step_type_spec.rb +30 -0
  88. data/zyphr.gemspec +1 -1
  89. metadata +102 -18
  90. data/docs/MuseApi.md +0 -681
  91. data/docs/V1MuseSubjectsSuggestPostRequest.md +0 -24
  92. data/lib/zyphr/api/muse_api.rb +0 -644
  93. data/spec/api/muse_api_spec.rb +0 -156
@@ -0,0 +1,30 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for Zyphr::WorkflowStatus
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zyphr::WorkflowStatus do
21
+ let(:instance) { Zyphr::WorkflowStatus.new }
22
+
23
+ describe 'test an instance of WorkflowStatus' do
24
+ it 'should create an instance of WorkflowStatus' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zyphr::WorkflowStatus)
27
+ end
28
+ end
29
+
30
+ end
@@ -0,0 +1,100 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for Zyphr::WorkflowStep
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zyphr::WorkflowStep do
21
+ let(:instance) { Zyphr::WorkflowStep.new }
22
+
23
+ describe 'test an instance of WorkflowStep' do
24
+ it 'should create an instance of WorkflowStep' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zyphr::WorkflowStep)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "id"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ describe 'test attribute "workflow_id"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
42
+ describe 'test attribute "step_key"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
48
+ describe 'test attribute "name"' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
+ end
52
+ end
53
+
54
+ describe 'test attribute "type"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
+ end
58
+ end
59
+
60
+ describe 'test attribute "position"' do
61
+ it 'should work' do
62
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
63
+ end
64
+ end
65
+
66
+ describe 'test attribute "config"' do
67
+ it 'should work' do
68
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
69
+ end
70
+ end
71
+
72
+ describe 'test attribute "parent_step_id"' do
73
+ it 'should work' do
74
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
75
+ end
76
+ end
77
+
78
+ describe 'test attribute "branch_path"' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
81
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["true", "false"])
82
+ # validator.allowable_values.each do |value|
83
+ # expect { instance.branch_path = value }.not_to raise_error
84
+ # end
85
+ end
86
+ end
87
+
88
+ describe 'test attribute "created_at"' do
89
+ it 'should work' do
90
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
91
+ end
92
+ end
93
+
94
+ describe 'test attribute "updated_at"' do
95
+ it 'should work' do
96
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
97
+ end
98
+ end
99
+
100
+ end
@@ -0,0 +1,30 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for Zyphr::WorkflowStepType
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zyphr::WorkflowStepType do
21
+ let(:instance) { Zyphr::WorkflowStepType.new }
22
+
23
+ describe 'test an instance of WorkflowStepType' do
24
+ it 'should create an instance of WorkflowStepType' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zyphr::WorkflowStepType)
27
+ end
28
+ end
29
+
30
+ end
data/zyphr.gemspec CHANGED
@@ -17,7 +17,7 @@ require "zyphr/version"
17
17
 
18
18
  Gem::Specification.new do |s|
19
19
  s.name = "zyphr"
20
- s.version = '0.1.38'
20
+ s.version = '0.1.40'
21
21
  s.platform = Gem::Platform::RUBY
22
22
  s.authors = ["Zyphr"]
23
23
  s.email = ["support@zyphr.dev"]