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
|
@@ -70,7 +70,7 @@ describe 'AuthRegistrationApi' do
|
|
|
70
70
|
|
|
71
71
|
# unit tests for sign_in_with_game_center
|
|
72
72
|
# Sign in with Apple Game Center
|
|
73
|
-
# 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
|
|
73
|
+
# 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.
|
|
74
74
|
# @param sign_in_with_game_center_request
|
|
75
75
|
# @param [Hash] opts the optional parameters
|
|
76
76
|
# @return [AuthResultResponse]
|
|
@@ -80,4 +80,16 @@ describe 'AuthRegistrationApi' do
|
|
|
80
80
|
end
|
|
81
81
|
end
|
|
82
82
|
|
|
83
|
+
# unit tests for sign_in_with_google_play_games
|
|
84
|
+
# Sign in with Google Play Games Services
|
|
85
|
+
# 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.
|
|
86
|
+
# @param sign_in_with_google_play_games_request
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [AuthResultResponse]
|
|
89
|
+
describe 'sign_in_with_google_play_games test' do
|
|
90
|
+
it 'should work' do
|
|
91
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
|
|
83
95
|
end
|
|
@@ -0,0 +1,192 @@
|
|
|
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
|
+
|
|
16
|
+
# Unit tests for Zyphr::WorkflowsApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'WorkflowsApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Zyphr::WorkflowsApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of WorkflowsApi' do
|
|
30
|
+
it 'should create an instance of WorkflowsApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Zyphr::WorkflowsApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for add_workflow_step
|
|
36
|
+
# Add a workflow step
|
|
37
|
+
# Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`.
|
|
38
|
+
# @param key The workflow key.
|
|
39
|
+
# @param add_workflow_step_request
|
|
40
|
+
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @return [AddWorkflowStep201Response]
|
|
42
|
+
describe 'add_workflow_step test' 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
|
+
# unit tests for create_workflow
|
|
49
|
+
# Create a workflow
|
|
50
|
+
# Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique `key` within the project. If `key` is omitted, one is derived from the `name`.
|
|
51
|
+
# @param create_workflow_request
|
|
52
|
+
# @param [Hash] opts the optional parameters
|
|
53
|
+
# @return [CreateWorkflow201Response]
|
|
54
|
+
describe 'create_workflow test' 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
|
+
# unit tests for delete_workflow
|
|
61
|
+
# Delete a workflow
|
|
62
|
+
# Permanently delete a workflow and all of its steps.
|
|
63
|
+
# @param key The workflow key.
|
|
64
|
+
# @param [Hash] opts the optional parameters
|
|
65
|
+
# @return [DeleteWorkflow200Response]
|
|
66
|
+
describe 'delete_workflow test' 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
|
+
# unit tests for delete_workflow_step
|
|
73
|
+
# Delete a workflow step
|
|
74
|
+
# Remove a step from a workflow.
|
|
75
|
+
# @param key The workflow key.
|
|
76
|
+
# @param step_key The step key.
|
|
77
|
+
# @param [Hash] opts the optional parameters
|
|
78
|
+
# @return [DeleteWorkflowStep200Response]
|
|
79
|
+
describe 'delete_workflow_step test' do
|
|
80
|
+
it 'should work' do
|
|
81
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# unit tests for get_workflow
|
|
86
|
+
# Get a workflow
|
|
87
|
+
# Retrieve a single workflow by its key, including its ordered steps.
|
|
88
|
+
# @param key The workflow key.
|
|
89
|
+
# @param [Hash] opts the optional parameters
|
|
90
|
+
# @return [CreateWorkflow201Response]
|
|
91
|
+
describe 'get_workflow test' do
|
|
92
|
+
it 'should work' do
|
|
93
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# unit tests for list_workflow_executions
|
|
98
|
+
# List workflow executions
|
|
99
|
+
# List the executions of a workflow, most recent first. Supports pagination.
|
|
100
|
+
# @param key The workflow key.
|
|
101
|
+
# @param [Hash] opts the optional parameters
|
|
102
|
+
# @option opts [Integer] :page Page number (1-based).
|
|
103
|
+
# @option opts [Integer] :per_page Number of executions per page (max 100).
|
|
104
|
+
# @return [ListWorkflowExecutions200Response]
|
|
105
|
+
describe 'list_workflow_executions test' do
|
|
106
|
+
it 'should work' do
|
|
107
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# unit tests for list_workflows
|
|
112
|
+
# List workflows
|
|
113
|
+
# List workflows in the project. Supports pagination, free-text search, and status filtering.
|
|
114
|
+
# @param [Hash] opts the optional parameters
|
|
115
|
+
# @option opts [Integer] :page Page number (1-based).
|
|
116
|
+
# @option opts [Integer] :per_page Number of workflows per page (max 100).
|
|
117
|
+
# @option opts [String] :search Free-text search over workflow name and key.
|
|
118
|
+
# @option opts [WorkflowStatus] :status Filter by workflow status.
|
|
119
|
+
# @return [ListWorkflows200Response]
|
|
120
|
+
describe 'list_workflows test' do
|
|
121
|
+
it 'should work' do
|
|
122
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# unit tests for reorder_workflow_steps
|
|
127
|
+
# Reorder workflow steps
|
|
128
|
+
# Reorder a workflow's steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow's existing step keys.
|
|
129
|
+
# @param key The workflow key.
|
|
130
|
+
# @param reorder_workflow_steps_request
|
|
131
|
+
# @param [Hash] opts the optional parameters
|
|
132
|
+
# @return [CreateWorkflow201Response]
|
|
133
|
+
describe 'reorder_workflow_steps test' do
|
|
134
|
+
it 'should work' do
|
|
135
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
136
|
+
end
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# unit tests for trigger_workflow
|
|
140
|
+
# Trigger a workflow
|
|
141
|
+
# Trigger an execution of an active workflow for one or more recipients. The `to` field accepts a single recipient, an array of recipients, or a topic object (`{ \"topic\": \"topic-key\" }`) to trigger for all subscribers of a topic. One execution is created per resolved subscriber.
|
|
142
|
+
# @param key The workflow key.
|
|
143
|
+
# @param trigger_workflow_request
|
|
144
|
+
# @param [Hash] opts the optional parameters
|
|
145
|
+
# @return [TriggerWorkflow202Response]
|
|
146
|
+
describe 'trigger_workflow test' do
|
|
147
|
+
it 'should work' do
|
|
148
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# unit tests for update_workflow
|
|
153
|
+
# Update a workflow
|
|
154
|
+
# Update a workflow's metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
|
|
155
|
+
# @param key The workflow key.
|
|
156
|
+
# @param update_workflow_request
|
|
157
|
+
# @param [Hash] opts the optional parameters
|
|
158
|
+
# @return [CreateWorkflow201Response]
|
|
159
|
+
describe 'update_workflow test' do
|
|
160
|
+
it 'should work' do
|
|
161
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# unit tests for update_workflow_status
|
|
166
|
+
# Update workflow status
|
|
167
|
+
# Change a workflow's lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate `/activate` or `/pause` endpoints. Set `status` to `active` to activate and `paused` to pause.
|
|
168
|
+
# @param key The workflow key.
|
|
169
|
+
# @param update_workflow_status_request
|
|
170
|
+
# @param [Hash] opts the optional parameters
|
|
171
|
+
# @return [CreateWorkflow201Response]
|
|
172
|
+
describe 'update_workflow_status test' do
|
|
173
|
+
it 'should work' do
|
|
174
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
# unit tests for update_workflow_step
|
|
179
|
+
# Update a workflow step
|
|
180
|
+
# Update a step's name and/or config. Only the provided fields are changed.
|
|
181
|
+
# @param key The workflow key.
|
|
182
|
+
# @param step_key The step key.
|
|
183
|
+
# @param update_workflow_step_request
|
|
184
|
+
# @param [Hash] opts the optional parameters
|
|
185
|
+
# @return [AddWorkflowStep201Response]
|
|
186
|
+
describe 'update_workflow_step test' do
|
|
187
|
+
it 'should work' do
|
|
188
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
189
|
+
end
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
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::AddWorkflowStep201Response
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::AddWorkflowStep201Response do
|
|
21
|
+
let(:instance) { Zyphr::AddWorkflowStep201Response.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of AddWorkflowStep201Response' do
|
|
24
|
+
it 'should create an instance of AddWorkflowStep201Response' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::AddWorkflowStep201Response)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "data"' 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 "meta"' 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
|
+
end
|
|
@@ -0,0 +1,76 @@
|
|
|
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::AddWorkflowStepRequest
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::AddWorkflowStepRequest do
|
|
21
|
+
let(:instance) { Zyphr::AddWorkflowStepRequest.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of AddWorkflowStepRequest' do
|
|
24
|
+
it 'should create an instance of AddWorkflowStepRequest' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::AddWorkflowStepRequest)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "step_key"' 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 "name"' 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 "type"' 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 "position"' 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 "config"' 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 "parent_step_id"' 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 "branch_path"' do
|
|
67
|
+
it 'should work' do
|
|
68
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
69
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["true", "false"])
|
|
70
|
+
# validator.allowable_values.each do |value|
|
|
71
|
+
# expect { instance.branch_path = value }.not_to raise_error
|
|
72
|
+
# end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
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::CreateWorkflow201Response
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::CreateWorkflow201Response do
|
|
21
|
+
let(:instance) { Zyphr::CreateWorkflow201Response.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of CreateWorkflow201Response' do
|
|
24
|
+
it 'should create an instance of CreateWorkflow201Response' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::CreateWorkflow201Response)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "data"' 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 "meta"' 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
|
+
end
|
data/spec/models/{v1_muse_subjects_suggest_post_request_spec.rb → create_workflow_request_spec.rb}
RENAMED
|
@@ -14,42 +14,44 @@ require 'spec_helper'
|
|
|
14
14
|
require 'json'
|
|
15
15
|
require 'date'
|
|
16
16
|
|
|
17
|
-
# Unit tests for Zyphr::
|
|
17
|
+
# Unit tests for Zyphr::CreateWorkflowRequest
|
|
18
18
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
19
|
# Please update as you see appropriate
|
|
20
|
-
describe Zyphr::
|
|
21
|
-
let(:instance) { Zyphr::
|
|
20
|
+
describe Zyphr::CreateWorkflowRequest do
|
|
21
|
+
let(:instance) { Zyphr::CreateWorkflowRequest.new }
|
|
22
22
|
|
|
23
|
-
describe 'test an instance of
|
|
24
|
-
it 'should create an instance of
|
|
23
|
+
describe 'test an instance of CreateWorkflowRequest' do
|
|
24
|
+
it 'should create an instance of CreateWorkflowRequest' do
|
|
25
25
|
# uncomment below to test the instance creation
|
|
26
|
-
#expect(instance).to be_instance_of(Zyphr::
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::CreateWorkflowRequest)
|
|
27
27
|
end
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
describe 'test attribute "
|
|
30
|
+
describe 'test attribute "name"' do
|
|
31
31
|
it 'should work' do
|
|
32
32
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
33
33
|
end
|
|
34
34
|
end
|
|
35
35
|
|
|
36
|
-
describe 'test attribute "
|
|
36
|
+
describe 'test attribute "key"' do
|
|
37
37
|
it 'should work' do
|
|
38
38
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
39
39
|
end
|
|
40
40
|
end
|
|
41
41
|
|
|
42
|
-
describe 'test attribute "
|
|
42
|
+
describe 'test attribute "description"' do
|
|
43
43
|
it 'should work' do
|
|
44
44
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
45
|
-
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["email", "push"])
|
|
46
|
-
# validator.allowable_values.each do |value|
|
|
47
|
-
# expect { instance.channel = value }.not_to raise_error
|
|
48
|
-
# end
|
|
49
45
|
end
|
|
50
46
|
end
|
|
51
47
|
|
|
52
|
-
describe 'test attribute "
|
|
48
|
+
describe 'test attribute "is_critical"' 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 "tags"' do
|
|
53
55
|
it 'should work' do
|
|
54
56
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
55
57
|
end
|
data/spec/models/{topic_delete_response_data_spec.rb → delete_workflow200_response_data_spec.rb}
RENAMED
|
@@ -14,16 +14,16 @@ require 'spec_helper'
|
|
|
14
14
|
require 'json'
|
|
15
15
|
require 'date'
|
|
16
16
|
|
|
17
|
-
# Unit tests for Zyphr::
|
|
17
|
+
# Unit tests for Zyphr::DeleteWorkflow200ResponseData
|
|
18
18
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
19
|
# Please update as you see appropriate
|
|
20
|
-
describe Zyphr::
|
|
21
|
-
let(:instance) { Zyphr::
|
|
20
|
+
describe Zyphr::DeleteWorkflow200ResponseData do
|
|
21
|
+
let(:instance) { Zyphr::DeleteWorkflow200ResponseData.new }
|
|
22
22
|
|
|
23
|
-
describe 'test an instance of
|
|
24
|
-
it 'should create an instance of
|
|
23
|
+
describe 'test an instance of DeleteWorkflow200ResponseData' do
|
|
24
|
+
it 'should create an instance of DeleteWorkflow200ResponseData' do
|
|
25
25
|
# uncomment below to test the instance creation
|
|
26
|
-
#expect(instance).to be_instance_of(Zyphr::
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::DeleteWorkflow200ResponseData)
|
|
27
27
|
end
|
|
28
28
|
end
|
|
29
29
|
|
|
@@ -0,0 +1,42 @@
|
|
|
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::DeleteWorkflow200Response
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::DeleteWorkflow200Response do
|
|
21
|
+
let(:instance) { Zyphr::DeleteWorkflow200Response.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of DeleteWorkflow200Response' do
|
|
24
|
+
it 'should create an instance of DeleteWorkflow200Response' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::DeleteWorkflow200Response)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "data"' 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 "meta"' 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
|
+
end
|
|
@@ -0,0 +1,48 @@
|
|
|
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::DeleteWorkflowStep200ResponseData
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::DeleteWorkflowStep200ResponseData do
|
|
21
|
+
let(:instance) { Zyphr::DeleteWorkflowStep200ResponseData.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of DeleteWorkflowStep200ResponseData' do
|
|
24
|
+
it 'should create an instance of DeleteWorkflowStep200ResponseData' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::DeleteWorkflowStep200ResponseData)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "workflow_key"' 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 "step_key"' 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 "deleted"' 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
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
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::DeleteWorkflowStep200Response
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::DeleteWorkflowStep200Response do
|
|
21
|
+
let(:instance) { Zyphr::DeleteWorkflowStep200Response.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of DeleteWorkflowStep200Response' do
|
|
24
|
+
it 'should create an instance of DeleteWorkflowStep200Response' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::DeleteWorkflowStep200Response)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "data"' 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 "meta"' 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
|
+
end
|
|
@@ -14,16 +14,16 @@ require 'spec_helper'
|
|
|
14
14
|
require 'json'
|
|
15
15
|
require 'date'
|
|
16
16
|
|
|
17
|
-
# Unit tests for Zyphr::
|
|
17
|
+
# Unit tests for Zyphr::ListWorkflowExecutions200ResponseMeta
|
|
18
18
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
19
|
# Please update as you see appropriate
|
|
20
|
-
describe Zyphr::
|
|
21
|
-
let(:instance) { Zyphr::
|
|
20
|
+
describe Zyphr::ListWorkflowExecutions200ResponseMeta do
|
|
21
|
+
let(:instance) { Zyphr::ListWorkflowExecutions200ResponseMeta.new }
|
|
22
22
|
|
|
23
|
-
describe 'test an instance of
|
|
24
|
-
it 'should create an instance of
|
|
23
|
+
describe 'test an instance of ListWorkflowExecutions200ResponseMeta' do
|
|
24
|
+
it 'should create an instance of ListWorkflowExecutions200ResponseMeta' do
|
|
25
25
|
# uncomment below to test the instance creation
|
|
26
|
-
#expect(instance).to be_instance_of(Zyphr::
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::ListWorkflowExecutions200ResponseMeta)
|
|
27
27
|
end
|
|
28
28
|
end
|
|
29
29
|
|