@zyphr-dev/node-sdk 0.1.39 → 0.1.41

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 (40) hide show
  1. package/dist/index.cjs +2315 -1220
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +1724 -622
  4. package/dist/index.d.ts +1724 -622
  5. package/dist/index.js +2195 -1203
  6. package/dist/index.js.map +1 -1
  7. package/package.json +1 -1
  8. package/src/.openapi-generator/FILES +24 -4
  9. package/src/src/apis/AuthRegistrationApi.ts +4 -4
  10. package/src/src/apis/WorkflowsApi.ts +912 -0
  11. package/src/src/apis/index.ts +1 -1
  12. package/src/src/models/AddWorkflowStep201Response.ts +88 -0
  13. package/src/src/models/AddWorkflowStepRequest.ts +136 -0
  14. package/src/src/models/CreateWorkflow201Response.ts +88 -0
  15. package/src/src/models/CreateWorkflowRequest.ts +98 -0
  16. package/src/src/models/DeleteWorkflow200Response.ts +88 -0
  17. package/src/src/models/{TopicDeleteResponseData.ts → DeleteWorkflow200ResponseData.ts} +12 -12
  18. package/src/src/models/DeleteWorkflowStep200Response.ts +88 -0
  19. package/src/src/models/DeleteWorkflowStep200ResponseData.ts +81 -0
  20. package/src/src/models/ListWorkflowExecutions200Response.ts +88 -0
  21. package/src/src/models/{SmsListResponseMeta.ts → ListWorkflowExecutions200ResponseMeta.ts} +15 -15
  22. package/src/src/models/ListWorkflows200Response.ts +88 -0
  23. package/src/src/models/ListWorkflows200ResponseMeta.ts +121 -0
  24. package/src/src/models/ReorderWorkflowStepsRequest.ts +66 -0
  25. package/src/src/models/SignInWithGameCenterRequest.ts +1 -1
  26. package/src/src/models/SmsListResponse.ts +10 -10
  27. package/src/src/models/TopicDeleteResponse.ts +10 -10
  28. package/src/src/models/TriggerWorkflow202Response.ts +88 -0
  29. package/src/src/models/TriggerWorkflow202ResponseData.ts +81 -0
  30. package/src/src/models/TriggerWorkflowRequest.ts +90 -0
  31. package/src/src/models/UpdateWorkflowRequest.ts +89 -0
  32. package/src/src/models/UpdateWorkflowStatusRequest.ts +76 -0
  33. package/src/src/models/UpdateWorkflowStepRequest.ts +73 -0
  34. package/src/src/models/Workflow.ts +187 -0
  35. package/src/src/models/WorkflowStatus.ts +55 -0
  36. package/src/src/models/WorkflowStep.ts +176 -0
  37. package/src/src/models/WorkflowStepType.ts +60 -0
  38. package/src/src/models/index.ts +23 -3
  39. package/src/src/apis/MuseApi.ts +0 -531
  40. package/src/src/models/V1MuseSubjectsSuggestPostRequest.ts +0 -105
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zyphr-dev/node-sdk",
3
- "version": "0.1.39",
3
+ "version": "0.1.41",
4
4
  "description": "Official Zyphr SDK for Node.js, React, and React Native",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -23,7 +23,6 @@ src/apis/EmailsApi.ts
23
23
  src/apis/ExecutionsApi.ts
24
24
  src/apis/InboundEmailApi.ts
25
25
  src/apis/InboxApi.ts
26
- src/apis/MuseApi.ts
27
26
  src/apis/PushApi.ts
28
27
  src/apis/SMSApi.ts
29
28
  src/apis/SlackApi.ts
@@ -38,6 +37,7 @@ src/apis/WaaSEventTypesApi.ts
38
37
  src/apis/WaaSEventsApi.ts
39
38
  src/apis/WaaSPortalApi.ts
40
39
  src/apis/WebhooksApi.ts
40
+ src/apis/WorkflowsApi.ts
41
41
  src/apis/index.ts
42
42
  src/index.ts
43
43
  src/models/AddDomain200Response.ts
@@ -45,6 +45,8 @@ src/models/AddDomain200ResponseMeta.ts
45
45
  src/models/AddDomainRequest.ts
46
46
  src/models/AddOrganizationMemberRequest.ts
47
47
  src/models/AddTopicSubscribersRequest.ts
48
+ src/models/AddWorkflowStep201Response.ts
49
+ src/models/AddWorkflowStepRequest.ts
48
50
  src/models/ApiError.ts
49
51
  src/models/ApiErrorError.ts
50
52
  src/models/ApiErrorMeta.ts
@@ -111,10 +113,16 @@ src/models/CreateWaaSEndpointResponse.ts
111
113
  src/models/CreateWaaSEventType201Response.ts
112
114
  src/models/CreateWaaSEventTypeRequest.ts
113
115
  src/models/CreateWebhookRequest.ts
116
+ src/models/CreateWorkflow201Response.ts
117
+ src/models/CreateWorkflowRequest.ts
114
118
  src/models/DeleteDomainResponse.ts
115
119
  src/models/DeleteDomainResponseData.ts
116
120
  src/models/DeleteResult.ts
117
121
  src/models/DeleteResultData.ts
122
+ src/models/DeleteWorkflow200Response.ts
123
+ src/models/DeleteWorkflow200ResponseData.ts
124
+ src/models/DeleteWorkflowStep200Response.ts
125
+ src/models/DeleteWorkflowStep200ResponseData.ts
118
126
  src/models/Device.ts
119
127
  src/models/DeviceListResponse.ts
120
128
  src/models/DevicePushTopic.ts
@@ -172,6 +180,10 @@ src/models/ListWaaSApplications200Response.ts
172
180
  src/models/ListWaaSEndpointDeliveries200Response.ts
173
181
  src/models/ListWaaSEndpoints200Response.ts
174
182
  src/models/ListWaaSEventTypes200Response.ts
183
+ src/models/ListWorkflowExecutions200Response.ts
184
+ src/models/ListWorkflowExecutions200ResponseMeta.ts
185
+ src/models/ListWorkflows200Response.ts
186
+ src/models/ListWorkflows200ResponseMeta.ts
175
187
  src/models/LoginRequest.ts
176
188
  src/models/MagicLinkSendRequest.ts
177
189
  src/models/MagicLinkVerifyRequest.ts
@@ -266,6 +278,7 @@ src/models/RegisterRequest.ts
266
278
  src/models/RemoveTopicSubscribersRequest.ts
267
279
  src/models/RenameWebAuthnCredentialRequest.ts
268
280
  src/models/RenderTemplateRequest.ts
281
+ src/models/ReorderWorkflowStepsRequest.ts
269
282
  src/models/ReplayWebhookEventsRequest.ts
270
283
  src/models/RequestMeta.ts
271
284
  src/models/ResetPasswordRequest.ts
@@ -336,7 +349,6 @@ src/models/SmsConfigDeleteResponseData.ts
336
349
  src/models/SmsConfigResponse.ts
337
350
  src/models/SmsDetailResponse.ts
338
351
  src/models/SmsListResponse.ts
339
- src/models/SmsListResponseMeta.ts
340
352
  src/models/SmsMessage.ts
341
353
  src/models/SmsMessageDetail.ts
342
354
  src/models/SubscribePushTopicRequest.ts
@@ -358,7 +370,6 @@ src/models/TemplateResponse.ts
358
370
  src/models/TestWebhookTransformRequest.ts
359
371
  src/models/Topic.ts
360
372
  src/models/TopicDeleteResponse.ts
361
- src/models/TopicDeleteResponseData.ts
362
373
  src/models/TopicListResponse.ts
363
374
  src/models/TopicResponse.ts
364
375
  src/models/TopicStatsData.ts
@@ -370,6 +381,9 @@ src/models/TopicSubscribersAddResponse.ts
370
381
  src/models/TopicSubscribersAddResult.ts
371
382
  src/models/TopicSubscribersRemoveResponse.ts
372
383
  src/models/TopicSubscribersRemoveResult.ts
384
+ src/models/TriggerWorkflow202Response.ts
385
+ src/models/TriggerWorkflow202ResponseData.ts
386
+ src/models/TriggerWorkflowRequest.ts
373
387
  src/models/UnreadCountData.ts
374
388
  src/models/UnreadCountResponse.ts
375
389
  src/models/Unsubscribe.ts
@@ -390,11 +404,13 @@ src/models/UpdateWaaSApplicationRequest.ts
390
404
  src/models/UpdateWaaSEndpointRequest.ts
391
405
  src/models/UpdateWaaSEventTypeRequest.ts
392
406
  src/models/UpdateWebhookRequest.ts
407
+ src/models/UpdateWorkflowRequest.ts
408
+ src/models/UpdateWorkflowStatusRequest.ts
409
+ src/models/UpdateWorkflowStepRequest.ts
393
410
  src/models/UpsertAuthEmailTemplateRequest.ts
394
411
  src/models/UpsertSmsConfigRequest.ts
395
412
  src/models/UserDevicesDeleteResponse.ts
396
413
  src/models/UserDevicesDeleteResponseData.ts
397
- src/models/V1MuseSubjectsSuggestPostRequest.ts
398
414
  src/models/ValidateResetTokenRequest.ts
399
415
  src/models/ValidateResetTokenResponse.ts
400
416
  src/models/ValidateResetTokenResponseData.ts
@@ -470,10 +486,14 @@ src/models/WebhookVersion.ts
470
486
  src/models/WebhookVersionsResponse.ts
471
487
  src/models/WebhookVersionsResponseData.ts
472
488
  src/models/WithdrawSubscriberConsentRequest.ts
489
+ src/models/Workflow.ts
473
490
  src/models/WorkflowExecution.ts
474
491
  src/models/WorkflowExecutionStatus.ts
492
+ src/models/WorkflowStatus.ts
493
+ src/models/WorkflowStep.ts
475
494
  src/models/WorkflowStepExecution.ts
476
495
  src/models/WorkflowStepExecutionStatus.ts
496
+ src/models/WorkflowStepType.ts
477
497
  src/models/index.ts
478
498
  src/runtime.ts
479
499
  tsconfig.esm.json
@@ -116,7 +116,7 @@ export interface AuthRegistrationApiInterface {
116
116
  signInAnonymously(signInAnonymouslyRequest: SignInAnonymouslyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse>;
117
117
 
118
118
  /**
119
- * 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 modern scoped `playerId` (gamePlayerID). ## 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 `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.
119
+ * 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.
120
120
  * @summary Sign in with Apple Game Center
121
121
  * @param {SignInWithGameCenterRequest} signInWithGameCenterRequest
122
122
  * @param {*} [options] Override http request option.
@@ -126,7 +126,7 @@ export interface AuthRegistrationApiInterface {
126
126
  signInWithGameCenterRaw(requestParameters: AuthRegistrationApiSignInWithGameCenterOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>>;
127
127
 
128
128
  /**
129
- * 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 modern scoped `playerId` (gamePlayerID). ## 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 `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.
129
+ * 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.
130
130
  * Sign in with Apple Game Center
131
131
  */
132
132
  signInWithGameCenter(signInWithGameCenterRequest: SignInWithGameCenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse>;
@@ -281,7 +281,7 @@ export class AuthRegistrationApi extends runtime.BaseAPI implements AuthRegistra
281
281
  }
282
282
 
283
283
  /**
284
- * 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 modern scoped `playerId` (gamePlayerID). ## 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 `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.
284
+ * 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.
285
285
  * Sign in with Apple Game Center
286
286
  */
287
287
  async signInWithGameCenterRaw(requestParameters: AuthRegistrationApiSignInWithGameCenterOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>> {
@@ -314,7 +314,7 @@ export class AuthRegistrationApi extends runtime.BaseAPI implements AuthRegistra
314
314
  }
315
315
 
316
316
  /**
317
- * 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 modern scoped `playerId` (gamePlayerID). ## 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 `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.
317
+ * 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.
318
318
  * Sign in with Apple Game Center
319
319
  */
320
320
  async signInWithGameCenter(signInWithGameCenterRequest: SignInWithGameCenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse> {