@novu/api 3.12.0-rc.0 → 3.12.0
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.
- package/README.md +25 -23
- package/_speakeasy/.github/action-inputs-config.json +53 -0
- package/_speakeasy/.github/action-security-config.json +88 -0
- package/examples/package-lock.json +1 -1
- package/funcs/channelConnectionsCreate.d.ts +1 -1
- package/funcs/channelConnectionsCreate.js +1 -1
- package/funcs/channelConnectionsDelete.d.ts +1 -1
- package/funcs/channelConnectionsDelete.js +1 -1
- package/funcs/channelConnectionsList.d.ts +2 -2
- package/funcs/channelConnectionsList.js +2 -2
- package/funcs/channelConnectionsRetrieve.d.ts +1 -1
- package/funcs/channelConnectionsRetrieve.js +1 -1
- package/funcs/channelConnectionsUpdate.d.ts +1 -1
- package/funcs/channelConnectionsUpdate.js +1 -1
- package/funcs/channelEndpointsCreate.d.ts +1 -1
- package/funcs/channelEndpointsCreate.js +1 -1
- package/funcs/channelEndpointsDelete.d.ts +1 -1
- package/funcs/channelEndpointsDelete.js +1 -1
- package/funcs/channelEndpointsList.d.ts +2 -2
- package/funcs/channelEndpointsList.js +2 -2
- package/funcs/channelEndpointsRetrieve.d.ts +1 -1
- package/funcs/channelEndpointsRetrieve.js +1 -1
- package/funcs/channelEndpointsUpdate.d.ts +1 -1
- package/funcs/channelEndpointsUpdate.js +1 -1
- package/funcs/notificationsList.js +1 -0
- package/funcs/notificationsList.js.map +1 -1
- package/funcs/topicsSubscriptionsGetSubscription.d.ts +18 -0
- package/funcs/topicsSubscriptionsGetSubscription.d.ts.map +1 -0
- package/funcs/topicsSubscriptionsGetSubscription.js +160 -0
- package/funcs/topicsSubscriptionsGetSubscription.js.map +1 -0
- package/funcs/topicsSubscriptionsUpdate.d.ts +1 -1
- package/funcs/topicsSubscriptionsUpdate.js +6 -3
- package/funcs/topicsSubscriptionsUpdate.js.map +1 -1
- package/funcs/trigger.d.ts +1 -1
- package/funcs/trigger.js +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/models/components/delaystepresponsedto.d.ts +1 -1
- package/models/components/delaystepresponsedto.d.ts.map +1 -1
- package/models/components/emailstepresponsedto.d.ts +3 -3
- package/models/components/emailstepresponsedto.d.ts.map +1 -1
- package/models/components/generatechatoauthurlrequestdto.d.ts +1 -1
- package/models/components/inappcontroldto.d.ts +1 -1
- package/models/components/inappstepresponsedto.d.ts +2 -2
- package/models/components/inappstepresponsedto.d.ts.map +1 -1
- package/models/components/notificationfeeditemdto.d.ts +4 -0
- package/models/components/notificationfeeditemdto.d.ts.map +1 -1
- package/models/components/notificationfeeditemdto.js +1 -0
- package/models/components/notificationfeeditemdto.js.map +1 -1
- package/models/components/redirectdto.d.ts +1 -1
- package/models/components/throttlestepresponsedto.d.ts +2 -2
- package/models/components/throttlestepresponsedto.d.ts.map +1 -1
- package/models/components/topicsubscriptionresponsedto.d.ts +4 -0
- package/models/components/topicsubscriptionresponsedto.d.ts.map +1 -1
- package/models/components/topicsubscriptionresponsedto.js +1 -0
- package/models/components/topicsubscriptionresponsedto.js.map +1 -1
- package/models/components/triggereventrequestdto.d.ts +2 -2
- package/models/components/workflowresponsedto.d.ts +2 -2
- package/models/components/workflowresponsedto.d.ts.map +1 -1
- package/models/operations/index.d.ts +1 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/notificationscontrollerlistnotifications.d.ts +5 -0
- package/models/operations/notificationscontrollerlistnotifications.d.ts.map +1 -1
- package/models/operations/notificationscontrollerlistnotifications.js +1 -0
- package/models/operations/notificationscontrollerlistnotifications.js.map +1 -1
- package/models/operations/topicscontrollergettopicsubscription.d.ts +37 -0
- package/models/operations/topicscontrollergettopicsubscription.d.ts.map +1 -0
- package/models/operations/topicscontrollergettopicsubscription.js +72 -0
- package/models/operations/topicscontrollergettopicsubscription.js.map +1 -0
- package/models/operations/topicscontrollerupdatetopicsubscription.d.ts +2 -2
- package/models/operations/topicscontrollerupdatetopicsubscription.d.ts.map +1 -1
- package/models/operations/topicscontrollerupdatetopicsubscription.js +1 -1
- package/models/operations/topicscontrollerupdatetopicsubscription.js.map +1 -1
- package/package.json +1 -1
- package/sdk/channelconnections.d.ts +6 -6
- package/sdk/channelconnections.js +6 -6
- package/sdk/channelendpoints.d.ts +6 -6
- package/sdk/channelendpoints.js +6 -6
- package/sdk/sdk.d.ts +1 -1
- package/sdk/sdk.js +1 -1
- package/sdk/subscriptions.d.ts +8 -1
- package/sdk/subscriptions.d.ts.map +1 -1
- package/sdk/subscriptions.js +11 -1
- package/sdk/subscriptions.js.map +1 -1
- package/sources/json-development.json +848 -309
- package/src/funcs/channelConnectionsCreate.ts +1 -1
- package/src/funcs/channelConnectionsDelete.ts +1 -1
- package/src/funcs/channelConnectionsList.ts +2 -2
- package/src/funcs/channelConnectionsRetrieve.ts +1 -1
- package/src/funcs/channelConnectionsUpdate.ts +1 -1
- package/src/funcs/channelEndpointsCreate.ts +1 -1
- package/src/funcs/channelEndpointsDelete.ts +1 -1
- package/src/funcs/channelEndpointsList.ts +2 -2
- package/src/funcs/channelEndpointsRetrieve.ts +1 -1
- package/src/funcs/channelEndpointsUpdate.ts +1 -1
- package/src/funcs/notificationsList.ts +1 -0
- package/src/funcs/topicsSubscriptionsGetSubscription.ts +242 -0
- package/src/funcs/topicsSubscriptionsUpdate.ts +8 -9
- package/src/funcs/trigger.ts +1 -1
- package/src/lib/config.ts +3 -3
- package/src/models/components/delaystepresponsedto.ts +1 -1
- package/src/models/components/emailstepresponsedto.ts +3 -3
- package/src/models/components/generatechatoauthurlrequestdto.ts +1 -1
- package/src/models/components/inappcontroldto.ts +1 -1
- package/src/models/components/inappstepresponsedto.ts +2 -2
- package/src/models/components/notificationfeeditemdto.ts +5 -0
- package/src/models/components/redirectdto.ts +1 -1
- package/src/models/components/throttlestepresponsedto.ts +2 -2
- package/src/models/components/topicsubscriptionresponsedto.ts +5 -0
- package/src/models/components/triggereventrequestdto.ts +2 -2
- package/src/models/components/workflowresponsedto.ts +2 -2
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/notificationscontrollerlistnotifications.ts +6 -0
- package/src/models/operations/topicscontrollergettopicsubscription.ts +96 -0
- package/src/models/operations/topicscontrollerupdatetopicsubscription.ts +3 -3
- package/src/sdk/channelconnections.ts +6 -6
- package/src/sdk/channelendpoints.ts +6 -6
- package/src/sdk/sdk.ts +1 -1
- package/src/sdk/subscriptions.ts +23 -1
|
@@ -15603,13 +15603,506 @@
|
|
|
15603
15603
|
]
|
|
15604
15604
|
}
|
|
15605
15605
|
},
|
|
15606
|
-
"/v2/topics/{topicKey}/subscriptions/{
|
|
15606
|
+
"/v2/topics/{topicKey}/subscriptions/{identifier}": {
|
|
15607
|
+
"get": {
|
|
15608
|
+
"operationId": "TopicsController_getTopicSubscription",
|
|
15609
|
+
"x-speakeasy-name-override": "getSubscription",
|
|
15610
|
+
"x-speakeasy-group": "Topics.Subscriptions",
|
|
15611
|
+
"summary": "Get a topic subscription",
|
|
15612
|
+
"description": "Get a subscription by its unique identifier for a topic.",
|
|
15613
|
+
"parameters": [
|
|
15614
|
+
{
|
|
15615
|
+
"name": "topicKey",
|
|
15616
|
+
"required": true,
|
|
15617
|
+
"in": "path",
|
|
15618
|
+
"description": "The key identifier of the topic",
|
|
15619
|
+
"schema": {
|
|
15620
|
+
"type": "string"
|
|
15621
|
+
}
|
|
15622
|
+
},
|
|
15623
|
+
{
|
|
15624
|
+
"name": "identifier",
|
|
15625
|
+
"required": true,
|
|
15626
|
+
"in": "path",
|
|
15627
|
+
"description": "The unique identifier of the subscription",
|
|
15628
|
+
"schema": {
|
|
15629
|
+
"type": "string"
|
|
15630
|
+
}
|
|
15631
|
+
},
|
|
15632
|
+
{
|
|
15633
|
+
"name": "idempotency-key",
|
|
15634
|
+
"in": "header",
|
|
15635
|
+
"description": "A header for idempotency purposes",
|
|
15636
|
+
"required": false,
|
|
15637
|
+
"schema": {
|
|
15638
|
+
"type": "string"
|
|
15639
|
+
}
|
|
15640
|
+
}
|
|
15641
|
+
],
|
|
15642
|
+
"responses": {
|
|
15643
|
+
"200": {
|
|
15644
|
+
"description": "OK",
|
|
15645
|
+
"headers": {
|
|
15646
|
+
"Content-Type": {
|
|
15647
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15648
|
+
},
|
|
15649
|
+
"RateLimit-Limit": {
|
|
15650
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15651
|
+
},
|
|
15652
|
+
"RateLimit-Remaining": {
|
|
15653
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15654
|
+
},
|
|
15655
|
+
"RateLimit-Reset": {
|
|
15656
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15657
|
+
},
|
|
15658
|
+
"RateLimit-Policy": {
|
|
15659
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15660
|
+
},
|
|
15661
|
+
"Idempotency-Key": {
|
|
15662
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15663
|
+
},
|
|
15664
|
+
"Idempotency-Replay": {
|
|
15665
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15666
|
+
}
|
|
15667
|
+
},
|
|
15668
|
+
"content": {
|
|
15669
|
+
"application/json": {
|
|
15670
|
+
"schema": {
|
|
15671
|
+
"$ref": "#/components/schemas/SubscriptionResponseDto"
|
|
15672
|
+
}
|
|
15673
|
+
}
|
|
15674
|
+
}
|
|
15675
|
+
},
|
|
15676
|
+
"400": {
|
|
15677
|
+
"description": "Bad Request",
|
|
15678
|
+
"headers": {
|
|
15679
|
+
"Content-Type": {
|
|
15680
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15681
|
+
},
|
|
15682
|
+
"RateLimit-Limit": {
|
|
15683
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15684
|
+
},
|
|
15685
|
+
"RateLimit-Remaining": {
|
|
15686
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15687
|
+
},
|
|
15688
|
+
"RateLimit-Reset": {
|
|
15689
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15690
|
+
},
|
|
15691
|
+
"RateLimit-Policy": {
|
|
15692
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15693
|
+
},
|
|
15694
|
+
"Idempotency-Key": {
|
|
15695
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15696
|
+
},
|
|
15697
|
+
"Idempotency-Replay": {
|
|
15698
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15699
|
+
}
|
|
15700
|
+
},
|
|
15701
|
+
"content": {
|
|
15702
|
+
"application/json": {
|
|
15703
|
+
"schema": {
|
|
15704
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15705
|
+
}
|
|
15706
|
+
}
|
|
15707
|
+
}
|
|
15708
|
+
},
|
|
15709
|
+
"401": {
|
|
15710
|
+
"description": "Unauthorized",
|
|
15711
|
+
"headers": {
|
|
15712
|
+
"Content-Type": {
|
|
15713
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15714
|
+
},
|
|
15715
|
+
"RateLimit-Limit": {
|
|
15716
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15717
|
+
},
|
|
15718
|
+
"RateLimit-Remaining": {
|
|
15719
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15720
|
+
},
|
|
15721
|
+
"RateLimit-Reset": {
|
|
15722
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15723
|
+
},
|
|
15724
|
+
"RateLimit-Policy": {
|
|
15725
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15726
|
+
},
|
|
15727
|
+
"Idempotency-Key": {
|
|
15728
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15729
|
+
},
|
|
15730
|
+
"Idempotency-Replay": {
|
|
15731
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15732
|
+
}
|
|
15733
|
+
},
|
|
15734
|
+
"content": {
|
|
15735
|
+
"application/json": {
|
|
15736
|
+
"schema": {
|
|
15737
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15738
|
+
}
|
|
15739
|
+
}
|
|
15740
|
+
}
|
|
15741
|
+
},
|
|
15742
|
+
"403": {
|
|
15743
|
+
"description": "Forbidden",
|
|
15744
|
+
"headers": {
|
|
15745
|
+
"Content-Type": {
|
|
15746
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15747
|
+
},
|
|
15748
|
+
"RateLimit-Limit": {
|
|
15749
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15750
|
+
},
|
|
15751
|
+
"RateLimit-Remaining": {
|
|
15752
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15753
|
+
},
|
|
15754
|
+
"RateLimit-Reset": {
|
|
15755
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15756
|
+
},
|
|
15757
|
+
"RateLimit-Policy": {
|
|
15758
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15759
|
+
},
|
|
15760
|
+
"Idempotency-Key": {
|
|
15761
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15762
|
+
},
|
|
15763
|
+
"Idempotency-Replay": {
|
|
15764
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15765
|
+
}
|
|
15766
|
+
},
|
|
15767
|
+
"content": {
|
|
15768
|
+
"application/json": {
|
|
15769
|
+
"schema": {
|
|
15770
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15771
|
+
}
|
|
15772
|
+
}
|
|
15773
|
+
}
|
|
15774
|
+
},
|
|
15775
|
+
"404": {
|
|
15776
|
+
"description": "Not Found",
|
|
15777
|
+
"headers": {
|
|
15778
|
+
"Content-Type": {
|
|
15779
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15780
|
+
},
|
|
15781
|
+
"RateLimit-Limit": {
|
|
15782
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15783
|
+
},
|
|
15784
|
+
"RateLimit-Remaining": {
|
|
15785
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15786
|
+
},
|
|
15787
|
+
"RateLimit-Reset": {
|
|
15788
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15789
|
+
},
|
|
15790
|
+
"RateLimit-Policy": {
|
|
15791
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15792
|
+
},
|
|
15793
|
+
"Idempotency-Key": {
|
|
15794
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15795
|
+
},
|
|
15796
|
+
"Idempotency-Replay": {
|
|
15797
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15798
|
+
}
|
|
15799
|
+
},
|
|
15800
|
+
"content": {
|
|
15801
|
+
"application/json": {
|
|
15802
|
+
"schema": {
|
|
15803
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15804
|
+
}
|
|
15805
|
+
}
|
|
15806
|
+
}
|
|
15807
|
+
},
|
|
15808
|
+
"405": {
|
|
15809
|
+
"description": "Method Not Allowed",
|
|
15810
|
+
"headers": {
|
|
15811
|
+
"Content-Type": {
|
|
15812
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15813
|
+
},
|
|
15814
|
+
"RateLimit-Limit": {
|
|
15815
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15816
|
+
},
|
|
15817
|
+
"RateLimit-Remaining": {
|
|
15818
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15819
|
+
},
|
|
15820
|
+
"RateLimit-Reset": {
|
|
15821
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15822
|
+
},
|
|
15823
|
+
"RateLimit-Policy": {
|
|
15824
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15825
|
+
},
|
|
15826
|
+
"Idempotency-Key": {
|
|
15827
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15828
|
+
},
|
|
15829
|
+
"Idempotency-Replay": {
|
|
15830
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15831
|
+
}
|
|
15832
|
+
},
|
|
15833
|
+
"content": {
|
|
15834
|
+
"application/json": {
|
|
15835
|
+
"schema": {
|
|
15836
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15837
|
+
}
|
|
15838
|
+
}
|
|
15839
|
+
}
|
|
15840
|
+
},
|
|
15841
|
+
"409": {
|
|
15842
|
+
"description": "Conflict",
|
|
15843
|
+
"headers": {
|
|
15844
|
+
"Content-Type": {
|
|
15845
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15846
|
+
},
|
|
15847
|
+
"RateLimit-Limit": {
|
|
15848
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15849
|
+
},
|
|
15850
|
+
"RateLimit-Remaining": {
|
|
15851
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15852
|
+
},
|
|
15853
|
+
"RateLimit-Reset": {
|
|
15854
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15855
|
+
},
|
|
15856
|
+
"RateLimit-Policy": {
|
|
15857
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15858
|
+
},
|
|
15859
|
+
"Idempotency-Key": {
|
|
15860
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15861
|
+
},
|
|
15862
|
+
"Idempotency-Replay": {
|
|
15863
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15864
|
+
}
|
|
15865
|
+
},
|
|
15866
|
+
"content": {
|
|
15867
|
+
"application/json": {
|
|
15868
|
+
"schema": {
|
|
15869
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15870
|
+
}
|
|
15871
|
+
}
|
|
15872
|
+
}
|
|
15873
|
+
},
|
|
15874
|
+
"413": {
|
|
15875
|
+
"description": "Payload Too Large",
|
|
15876
|
+
"headers": {
|
|
15877
|
+
"Content-Type": {
|
|
15878
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15879
|
+
},
|
|
15880
|
+
"RateLimit-Limit": {
|
|
15881
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15882
|
+
},
|
|
15883
|
+
"RateLimit-Remaining": {
|
|
15884
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15885
|
+
},
|
|
15886
|
+
"RateLimit-Reset": {
|
|
15887
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15888
|
+
},
|
|
15889
|
+
"RateLimit-Policy": {
|
|
15890
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15891
|
+
},
|
|
15892
|
+
"Idempotency-Key": {
|
|
15893
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15894
|
+
},
|
|
15895
|
+
"Idempotency-Replay": {
|
|
15896
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15897
|
+
}
|
|
15898
|
+
},
|
|
15899
|
+
"content": {
|
|
15900
|
+
"application/json": {
|
|
15901
|
+
"schema": {
|
|
15902
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15903
|
+
}
|
|
15904
|
+
}
|
|
15905
|
+
}
|
|
15906
|
+
},
|
|
15907
|
+
"414": {
|
|
15908
|
+
"description": "URI Too Long",
|
|
15909
|
+
"content": {
|
|
15910
|
+
"application/json": {
|
|
15911
|
+
"schema": {
|
|
15912
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15913
|
+
}
|
|
15914
|
+
}
|
|
15915
|
+
}
|
|
15916
|
+
},
|
|
15917
|
+
"415": {
|
|
15918
|
+
"description": "Unsupported Media Type",
|
|
15919
|
+
"headers": {
|
|
15920
|
+
"Content-Type": {
|
|
15921
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15922
|
+
},
|
|
15923
|
+
"RateLimit-Limit": {
|
|
15924
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15925
|
+
},
|
|
15926
|
+
"RateLimit-Remaining": {
|
|
15927
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15928
|
+
},
|
|
15929
|
+
"RateLimit-Reset": {
|
|
15930
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15931
|
+
},
|
|
15932
|
+
"RateLimit-Policy": {
|
|
15933
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15934
|
+
},
|
|
15935
|
+
"Idempotency-Key": {
|
|
15936
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15937
|
+
},
|
|
15938
|
+
"Idempotency-Replay": {
|
|
15939
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15940
|
+
}
|
|
15941
|
+
},
|
|
15942
|
+
"content": {
|
|
15943
|
+
"application/json": {
|
|
15944
|
+
"schema": {
|
|
15945
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
15946
|
+
}
|
|
15947
|
+
}
|
|
15948
|
+
}
|
|
15949
|
+
},
|
|
15950
|
+
"422": {
|
|
15951
|
+
"description": "Unprocessable Entity",
|
|
15952
|
+
"headers": {
|
|
15953
|
+
"Content-Type": {
|
|
15954
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15955
|
+
},
|
|
15956
|
+
"RateLimit-Limit": {
|
|
15957
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15958
|
+
},
|
|
15959
|
+
"RateLimit-Remaining": {
|
|
15960
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15961
|
+
},
|
|
15962
|
+
"RateLimit-Reset": {
|
|
15963
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15964
|
+
},
|
|
15965
|
+
"RateLimit-Policy": {
|
|
15966
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
15967
|
+
},
|
|
15968
|
+
"Idempotency-Key": {
|
|
15969
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
15970
|
+
},
|
|
15971
|
+
"Idempotency-Replay": {
|
|
15972
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
15973
|
+
}
|
|
15974
|
+
},
|
|
15975
|
+
"content": {
|
|
15976
|
+
"application/json": {
|
|
15977
|
+
"schema": {
|
|
15978
|
+
"$ref": "#/components/schemas/ValidationErrorDto"
|
|
15979
|
+
}
|
|
15980
|
+
}
|
|
15981
|
+
}
|
|
15982
|
+
},
|
|
15983
|
+
"429": {
|
|
15984
|
+
"description": "The client has sent too many requests in a given amount of time. ",
|
|
15985
|
+
"headers": {
|
|
15986
|
+
"Content-Type": {
|
|
15987
|
+
"$ref": "#/components/headers/Content-Type"
|
|
15988
|
+
},
|
|
15989
|
+
"RateLimit-Limit": {
|
|
15990
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
15991
|
+
},
|
|
15992
|
+
"RateLimit-Remaining": {
|
|
15993
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
15994
|
+
},
|
|
15995
|
+
"RateLimit-Reset": {
|
|
15996
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
15997
|
+
},
|
|
15998
|
+
"RateLimit-Policy": {
|
|
15999
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
16000
|
+
},
|
|
16001
|
+
"Idempotency-Key": {
|
|
16002
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
16003
|
+
},
|
|
16004
|
+
"Idempotency-Replay": {
|
|
16005
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
16006
|
+
},
|
|
16007
|
+
"Retry-After": {
|
|
16008
|
+
"$ref": "#/components/headers/Retry-After"
|
|
16009
|
+
}
|
|
16010
|
+
},
|
|
16011
|
+
"content": {
|
|
16012
|
+
"application/json": {
|
|
16013
|
+
"schema": {
|
|
16014
|
+
"type": "string",
|
|
16015
|
+
"example": "API rate limit exceeded"
|
|
16016
|
+
}
|
|
16017
|
+
}
|
|
16018
|
+
}
|
|
16019
|
+
},
|
|
16020
|
+
"500": {
|
|
16021
|
+
"description": "Internal Server Error",
|
|
16022
|
+
"headers": {
|
|
16023
|
+
"Content-Type": {
|
|
16024
|
+
"$ref": "#/components/headers/Content-Type"
|
|
16025
|
+
},
|
|
16026
|
+
"RateLimit-Limit": {
|
|
16027
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
16028
|
+
},
|
|
16029
|
+
"RateLimit-Remaining": {
|
|
16030
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
16031
|
+
},
|
|
16032
|
+
"RateLimit-Reset": {
|
|
16033
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
16034
|
+
},
|
|
16035
|
+
"RateLimit-Policy": {
|
|
16036
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
16037
|
+
},
|
|
16038
|
+
"Idempotency-Key": {
|
|
16039
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
16040
|
+
},
|
|
16041
|
+
"Idempotency-Replay": {
|
|
16042
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
16043
|
+
}
|
|
16044
|
+
},
|
|
16045
|
+
"content": {
|
|
16046
|
+
"application/json": {
|
|
16047
|
+
"schema": {
|
|
16048
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
16049
|
+
}
|
|
16050
|
+
}
|
|
16051
|
+
}
|
|
16052
|
+
},
|
|
16053
|
+
"503": {
|
|
16054
|
+
"description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
|
|
16055
|
+
"headers": {
|
|
16056
|
+
"Content-Type": {
|
|
16057
|
+
"$ref": "#/components/headers/Content-Type"
|
|
16058
|
+
},
|
|
16059
|
+
"RateLimit-Limit": {
|
|
16060
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
16061
|
+
},
|
|
16062
|
+
"RateLimit-Remaining": {
|
|
16063
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
16064
|
+
},
|
|
16065
|
+
"RateLimit-Reset": {
|
|
16066
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
16067
|
+
},
|
|
16068
|
+
"RateLimit-Policy": {
|
|
16069
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
16070
|
+
},
|
|
16071
|
+
"Idempotency-Key": {
|
|
16072
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
16073
|
+
},
|
|
16074
|
+
"Idempotency-Replay": {
|
|
16075
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
16076
|
+
},
|
|
16077
|
+
"Retry-After": {
|
|
16078
|
+
"$ref": "#/components/headers/Retry-After"
|
|
16079
|
+
}
|
|
16080
|
+
},
|
|
16081
|
+
"content": {
|
|
16082
|
+
"application/json": {
|
|
16083
|
+
"schema": {
|
|
16084
|
+
"type": "string",
|
|
16085
|
+
"example": "Please wait some time, then try again."
|
|
16086
|
+
}
|
|
16087
|
+
}
|
|
16088
|
+
}
|
|
16089
|
+
}
|
|
16090
|
+
},
|
|
16091
|
+
"tags": [
|
|
16092
|
+
"Topics"
|
|
16093
|
+
],
|
|
16094
|
+
"security": [
|
|
16095
|
+
{
|
|
16096
|
+
"secretKey": []
|
|
16097
|
+
}
|
|
16098
|
+
]
|
|
16099
|
+
},
|
|
15607
16100
|
"patch": {
|
|
15608
16101
|
"operationId": "TopicsController_updateTopicSubscription",
|
|
15609
16102
|
"x-speakeasy-name-override": "update",
|
|
15610
16103
|
"x-speakeasy-group": "Topics.Subscriptions",
|
|
15611
16104
|
"summary": "Update a topic subscription",
|
|
15612
|
-
"description": "Update a subscription by its unique identifier
|
|
16105
|
+
"description": "Update a subscription by its unique identifier for a topic. You can update the preferences and name associated with the subscription.",
|
|
15613
16106
|
"parameters": [
|
|
15614
16107
|
{
|
|
15615
16108
|
"name": "topicKey",
|
|
@@ -15621,7 +16114,7 @@
|
|
|
15621
16114
|
}
|
|
15622
16115
|
},
|
|
15623
16116
|
{
|
|
15624
|
-
"name": "
|
|
16117
|
+
"name": "identifier",
|
|
15625
16118
|
"required": true,
|
|
15626
16119
|
"in": "path",
|
|
15627
16120
|
"description": "The unique identifier of the subscription",
|
|
@@ -20636,8 +21129,9 @@
|
|
|
20636
21129
|
"/v1/channel-connections": {
|
|
20637
21130
|
"get": {
|
|
20638
21131
|
"operationId": "ChannelConnectionsController_listChannelConnections",
|
|
20639
|
-
"
|
|
20640
|
-
"
|
|
21132
|
+
"x-speakeasy-name-override": "list",
|
|
21133
|
+
"summary": "List all channel connections",
|
|
21134
|
+
"description": "List all channel connections for a resource.",
|
|
20641
21135
|
"parameters": [
|
|
20642
21136
|
{
|
|
20643
21137
|
"name": "after",
|
|
@@ -21232,7 +21726,8 @@
|
|
|
21232
21726
|
},
|
|
21233
21727
|
"post": {
|
|
21234
21728
|
"operationId": "ChannelConnectionsController_createChannelConnection",
|
|
21235
|
-
"
|
|
21729
|
+
"x-speakeasy-name-override": "create",
|
|
21730
|
+
"summary": "Create a channel connection",
|
|
21236
21731
|
"description": "Create a new channel connection for a resource for given integration. Only one channel connection is allowed per resource and integration.",
|
|
21237
21732
|
"parameters": [
|
|
21238
21733
|
{
|
|
@@ -21717,7 +22212,8 @@
|
|
|
21717
22212
|
"/v1/channel-connections/{identifier}": {
|
|
21718
22213
|
"get": {
|
|
21719
22214
|
"operationId": "ChannelConnectionsController_getChannelConnectionByIdentifier",
|
|
21720
|
-
"
|
|
22215
|
+
"x-speakeasy-name-override": "retrieve",
|
|
22216
|
+
"summary": "Retrieve a channel connection",
|
|
21721
22217
|
"description": "Retrieve a specific channel connection by its unique identifier.",
|
|
21722
22218
|
"parameters": [
|
|
21723
22219
|
{
|
|
@@ -22199,7 +22695,8 @@
|
|
|
22199
22695
|
},
|
|
22200
22696
|
"patch": {
|
|
22201
22697
|
"operationId": "ChannelConnectionsController_updateChannelConnection",
|
|
22202
|
-
"
|
|
22698
|
+
"x-speakeasy-name-override": "update",
|
|
22699
|
+
"summary": "Update a channel connection",
|
|
22203
22700
|
"description": "Update an existing channel connection by its unique identifier.",
|
|
22204
22701
|
"parameters": [
|
|
22205
22702
|
{
|
|
@@ -22691,7 +23188,8 @@
|
|
|
22691
23188
|
},
|
|
22692
23189
|
"delete": {
|
|
22693
23190
|
"operationId": "ChannelConnectionsController_deleteChannelConnection",
|
|
22694
|
-
"
|
|
23191
|
+
"x-speakeasy-name-override": "delete",
|
|
23192
|
+
"summary": "Delete a channel connection",
|
|
22695
23193
|
"description": "Delete a specific channel connection by its unique identifier.",
|
|
22696
23194
|
"parameters": [
|
|
22697
23195
|
{
|
|
@@ -23145,8 +23643,9 @@
|
|
|
23145
23643
|
"/v1/channel-endpoints": {
|
|
23146
23644
|
"get": {
|
|
23147
23645
|
"operationId": "ChannelEndpointsController_listChannelEndpoints",
|
|
23148
|
-
"
|
|
23149
|
-
"
|
|
23646
|
+
"x-speakeasy-name-override": "list",
|
|
23647
|
+
"summary": "List all channel endpoints",
|
|
23648
|
+
"description": "List all channel endpoints for a resource based on query filters.",
|
|
23150
23649
|
"parameters": [
|
|
23151
23650
|
{
|
|
23152
23651
|
"name": "after",
|
|
@@ -23753,7 +24252,8 @@
|
|
|
23753
24252
|
},
|
|
23754
24253
|
"post": {
|
|
23755
24254
|
"operationId": "ChannelEndpointsController_createChannelEndpoint",
|
|
23756
|
-
"
|
|
24255
|
+
"x-speakeasy-name-override": "create",
|
|
24256
|
+
"summary": "Create a channel endpoint",
|
|
23757
24257
|
"description": "Create a new channel endpoint for a resource.",
|
|
23758
24258
|
"parameters": [
|
|
23759
24259
|
{
|
|
@@ -24272,7 +24772,8 @@
|
|
|
24272
24772
|
"/v1/channel-endpoints/{identifier}": {
|
|
24273
24773
|
"get": {
|
|
24274
24774
|
"operationId": "ChannelEndpointsController_getChannelEndpoint",
|
|
24275
|
-
"
|
|
24775
|
+
"x-speakeasy-name-override": "retrieve",
|
|
24776
|
+
"summary": "Retrieve a channel endpoint",
|
|
24276
24777
|
"description": "Retrieve a specific channel endpoint by its unique identifier.",
|
|
24277
24778
|
"parameters": [
|
|
24278
24779
|
{
|
|
@@ -24757,7 +25258,8 @@
|
|
|
24757
25258
|
},
|
|
24758
25259
|
"patch": {
|
|
24759
25260
|
"operationId": "ChannelEndpointsController_updateChannelEndpoint",
|
|
24760
|
-
"
|
|
25261
|
+
"x-speakeasy-name-override": "update",
|
|
25262
|
+
"summary": "Update a channel endpoint",
|
|
24761
25263
|
"description": "Update an existing channel endpoint by its unique identifier.",
|
|
24762
25264
|
"parameters": [
|
|
24763
25265
|
{
|
|
@@ -25252,7 +25754,8 @@
|
|
|
25252
25754
|
},
|
|
25253
25755
|
"delete": {
|
|
25254
25756
|
"operationId": "ChannelEndpointsController_deleteChannelEndpoint",
|
|
25255
|
-
"
|
|
25757
|
+
"x-speakeasy-name-override": "delete",
|
|
25758
|
+
"summary": "Delete a channel endpoint",
|
|
25256
25759
|
"description": "Delete a specific channel endpoint by its unique identifier.",
|
|
25257
25760
|
"parameters": [
|
|
25258
25761
|
{
|
|
@@ -27640,7 +28143,7 @@
|
|
|
27640
28143
|
},
|
|
27641
28144
|
"x-speakeasy-name-override": "trigger",
|
|
27642
28145
|
"summary": "Trigger event",
|
|
27643
|
-
"description": "\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.",
|
|
28146
|
+
"description": "\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.",
|
|
27644
28147
|
"parameters": [
|
|
27645
28148
|
{
|
|
27646
28149
|
"name": "idempotency-key",
|
|
@@ -35105,6 +35608,15 @@
|
|
|
35105
35608
|
"type": "string"
|
|
35106
35609
|
}
|
|
35107
35610
|
},
|
|
35611
|
+
{
|
|
35612
|
+
"name": "subscriptionId",
|
|
35613
|
+
"required": false,
|
|
35614
|
+
"in": "query",
|
|
35615
|
+
"description": "Subscription ID for filtering notifications by subscription",
|
|
35616
|
+
"schema": {
|
|
35617
|
+
"type": "string"
|
|
35618
|
+
}
|
|
35619
|
+
},
|
|
35108
35620
|
{
|
|
35109
35621
|
"name": "contextKeys",
|
|
35110
35622
|
"required": false,
|
|
@@ -42671,7 +43183,7 @@
|
|
|
42671
43183
|
]
|
|
42672
43184
|
},
|
|
42673
43185
|
"to": {
|
|
42674
|
-
"description": "The recipients list of people who will receive the notification.",
|
|
43186
|
+
"description": "The recipients list of people who will receive the notification. Maximum number of recipients can be 100.",
|
|
42675
43187
|
"oneOf": [
|
|
42676
43188
|
{
|
|
42677
43189
|
"type": "array",
|
|
@@ -43991,6 +44503,40 @@
|
|
|
43991
44503
|
"traces"
|
|
43992
44504
|
]
|
|
43993
44505
|
},
|
|
44506
|
+
"TopicResponseDto": {
|
|
44507
|
+
"type": "object",
|
|
44508
|
+
"properties": {
|
|
44509
|
+
"_id": {
|
|
44510
|
+
"type": "string",
|
|
44511
|
+
"description": "The identifier of the topic",
|
|
44512
|
+
"example": "64da692e9a94fb2e6449ad06"
|
|
44513
|
+
},
|
|
44514
|
+
"key": {
|
|
44515
|
+
"type": "string",
|
|
44516
|
+
"description": "The unique key of the topic",
|
|
44517
|
+
"example": "product-updates"
|
|
44518
|
+
},
|
|
44519
|
+
"name": {
|
|
44520
|
+
"type": "string",
|
|
44521
|
+
"description": "The name of the topic",
|
|
44522
|
+
"example": "Product Updates"
|
|
44523
|
+
},
|
|
44524
|
+
"createdAt": {
|
|
44525
|
+
"type": "string",
|
|
44526
|
+
"description": "The date the topic was created",
|
|
44527
|
+
"example": "2023-08-15T00:00:00.000Z"
|
|
44528
|
+
},
|
|
44529
|
+
"updatedAt": {
|
|
44530
|
+
"type": "string",
|
|
44531
|
+
"description": "The date the topic was last updated",
|
|
44532
|
+
"example": "2023-08-15T00:00:00.000Z"
|
|
44533
|
+
}
|
|
44534
|
+
},
|
|
44535
|
+
"required": [
|
|
44536
|
+
"_id",
|
|
44537
|
+
"key"
|
|
44538
|
+
]
|
|
44539
|
+
},
|
|
43994
44540
|
"WorkflowRunStepsDetailsDto": {
|
|
43995
44541
|
"type": "object",
|
|
43996
44542
|
"properties": {
|
|
@@ -44120,254 +44666,268 @@
|
|
|
44120
44666
|
"type": "string"
|
|
44121
44667
|
}
|
|
44122
44668
|
},
|
|
44123
|
-
"
|
|
44124
|
-
"description": "
|
|
44125
|
-
"type": "array",
|
|
44126
|
-
"items": {
|
|
44127
|
-
"$ref": "#/components/schemas/
|
|
44128
|
-
}
|
|
44129
|
-
}
|
|
44130
|
-
|
|
44131
|
-
|
|
44132
|
-
|
|
44133
|
-
|
|
44134
|
-
|
|
44135
|
-
|
|
44136
|
-
|
|
44137
|
-
|
|
44138
|
-
|
|
44139
|
-
"
|
|
44140
|
-
"
|
|
44141
|
-
"
|
|
44142
|
-
"
|
|
44143
|
-
"
|
|
44144
|
-
"
|
|
44145
|
-
"
|
|
44146
|
-
"
|
|
44147
|
-
|
|
44148
|
-
|
|
44149
|
-
|
|
44150
|
-
|
|
44151
|
-
|
|
44152
|
-
"
|
|
44153
|
-
|
|
44154
|
-
|
|
44155
|
-
|
|
44156
|
-
|
|
44157
|
-
|
|
44158
|
-
|
|
44159
|
-
"
|
|
44160
|
-
"
|
|
44161
|
-
"
|
|
44162
|
-
"
|
|
44163
|
-
|
|
44164
|
-
|
|
44165
|
-
|
|
44166
|
-
|
|
44167
|
-
"
|
|
44168
|
-
|
|
44169
|
-
|
|
44170
|
-
|
|
44171
|
-
"
|
|
44172
|
-
|
|
44173
|
-
|
|
44174
|
-
|
|
44175
|
-
|
|
44176
|
-
|
|
44177
|
-
|
|
44178
|
-
|
|
44179
|
-
|
|
44180
|
-
|
|
44181
|
-
|
|
44182
|
-
|
|
44183
|
-
|
|
44184
|
-
|
|
44185
|
-
|
|
44186
|
-
"
|
|
44187
|
-
},
|
|
44188
|
-
"
|
|
44189
|
-
"type": "string",
|
|
44190
|
-
"description": "
|
|
44191
|
-
},
|
|
44192
|
-
"
|
|
44193
|
-
"
|
|
44194
|
-
|
|
44195
|
-
|
|
44196
|
-
|
|
44197
|
-
"
|
|
44198
|
-
|
|
44199
|
-
|
|
44200
|
-
|
|
44201
|
-
|
|
44202
|
-
|
|
44203
|
-
"
|
|
44204
|
-
|
|
44205
|
-
|
|
44206
|
-
|
|
44207
|
-
|
|
44208
|
-
|
|
44209
|
-
"
|
|
44210
|
-
|
|
44211
|
-
"
|
|
44212
|
-
|
|
44213
|
-
|
|
44214
|
-
|
|
44215
|
-
|
|
44216
|
-
|
|
44217
|
-
|
|
44218
|
-
|
|
44219
|
-
|
|
44220
|
-
"
|
|
44221
|
-
|
|
44222
|
-
|
|
44223
|
-
|
|
44224
|
-
"
|
|
44225
|
-
|
|
44226
|
-
|
|
44227
|
-
|
|
44228
|
-
"
|
|
44229
|
-
|
|
44230
|
-
|
|
44231
|
-
|
|
44232
|
-
|
|
44233
|
-
|
|
44234
|
-
|
|
44235
|
-
|
|
44236
|
-
|
|
44237
|
-
|
|
44238
|
-
"
|
|
44239
|
-
"
|
|
44240
|
-
|
|
44241
|
-
|
|
44242
|
-
|
|
44243
|
-
|
|
44244
|
-
|
|
44245
|
-
|
|
44246
|
-
|
|
44247
|
-
|
|
44248
|
-
|
|
44249
|
-
|
|
44250
|
-
"
|
|
44251
|
-
|
|
44252
|
-
|
|
44253
|
-
|
|
44254
|
-
|
|
44255
|
-
"
|
|
44256
|
-
|
|
44257
|
-
|
|
44258
|
-
},
|
|
44259
|
-
"
|
|
44260
|
-
"description": "
|
|
44261
|
-
"
|
|
44262
|
-
|
|
44263
|
-
|
|
44264
|
-
|
|
44265
|
-
|
|
44266
|
-
|
|
44267
|
-
|
|
44268
|
-
"
|
|
44269
|
-
|
|
44270
|
-
|
|
44271
|
-
|
|
44272
|
-
|
|
44273
|
-
|
|
44274
|
-
"
|
|
44275
|
-
|
|
44276
|
-
|
|
44277
|
-
|
|
44278
|
-
|
|
44279
|
-
|
|
44280
|
-
|
|
44281
|
-
|
|
44282
|
-
|
|
44283
|
-
|
|
44284
|
-
|
|
44285
|
-
"
|
|
44286
|
-
|
|
44287
|
-
|
|
44288
|
-
|
|
44289
|
-
|
|
44290
|
-
|
|
44291
|
-
|
|
44292
|
-
|
|
44293
|
-
|
|
44294
|
-
"
|
|
44295
|
-
|
|
44296
|
-
|
|
44297
|
-
|
|
44298
|
-
"
|
|
44299
|
-
|
|
44300
|
-
|
|
44301
|
-
|
|
44302
|
-
"
|
|
44303
|
-
|
|
44304
|
-
|
|
44305
|
-
|
|
44306
|
-
"
|
|
44307
|
-
|
|
44308
|
-
|
|
44309
|
-
|
|
44310
|
-
"
|
|
44311
|
-
|
|
44312
|
-
|
|
44313
|
-
|
|
44314
|
-
"
|
|
44315
|
-
|
|
44316
|
-
|
|
44317
|
-
|
|
44318
|
-
|
|
44319
|
-
|
|
44320
|
-
|
|
44321
|
-
|
|
44322
|
-
|
|
44323
|
-
|
|
44324
|
-
"
|
|
44325
|
-
|
|
44326
|
-
|
|
44327
|
-
|
|
44328
|
-
|
|
44329
|
-
|
|
44330
|
-
|
|
44331
|
-
"
|
|
44332
|
-
|
|
44333
|
-
|
|
44334
|
-
|
|
44335
|
-
|
|
44336
|
-
|
|
44337
|
-
|
|
44338
|
-
|
|
44339
|
-
|
|
44340
|
-
|
|
44341
|
-
"
|
|
44342
|
-
|
|
44343
|
-
|
|
44344
|
-
|
|
44345
|
-
"
|
|
44346
|
-
|
|
44347
|
-
|
|
44348
|
-
|
|
44349
|
-
"
|
|
44350
|
-
|
|
44351
|
-
|
|
44352
|
-
|
|
44353
|
-
"
|
|
44354
|
-
|
|
44355
|
-
|
|
44356
|
-
|
|
44357
|
-
|
|
44358
|
-
|
|
44359
|
-
|
|
44360
|
-
"
|
|
44361
|
-
|
|
44362
|
-
|
|
44363
|
-
|
|
44364
|
-
|
|
44365
|
-
|
|
44366
|
-
|
|
44367
|
-
"description": "
|
|
44669
|
+
"topics": {
|
|
44670
|
+
"description": "Topics",
|
|
44671
|
+
"type": "array",
|
|
44672
|
+
"items": {
|
|
44673
|
+
"$ref": "#/components/schemas/TopicResponseDto"
|
|
44674
|
+
}
|
|
44675
|
+
},
|
|
44676
|
+
"steps": {
|
|
44677
|
+
"description": "Workflow run steps",
|
|
44678
|
+
"type": "array",
|
|
44679
|
+
"items": {
|
|
44680
|
+
"$ref": "#/components/schemas/WorkflowRunStepsDetailsDto"
|
|
44681
|
+
}
|
|
44682
|
+
}
|
|
44683
|
+
},
|
|
44684
|
+
"required": [
|
|
44685
|
+
"id",
|
|
44686
|
+
"workflowId",
|
|
44687
|
+
"workflowName",
|
|
44688
|
+
"organizationId",
|
|
44689
|
+
"environmentId",
|
|
44690
|
+
"internalSubscriberId",
|
|
44691
|
+
"status",
|
|
44692
|
+
"deliveryLifecycleStatus",
|
|
44693
|
+
"triggerIdentifier",
|
|
44694
|
+
"transactionId",
|
|
44695
|
+
"createdAt",
|
|
44696
|
+
"updatedAt",
|
|
44697
|
+
"severity",
|
|
44698
|
+
"critical",
|
|
44699
|
+
"steps"
|
|
44700
|
+
]
|
|
44701
|
+
},
|
|
44702
|
+
"GetWorkflowRunsResponseDto": {
|
|
44703
|
+
"type": "object",
|
|
44704
|
+
"properties": {
|
|
44705
|
+
"data": {
|
|
44706
|
+
"description": "Workflow runs data",
|
|
44707
|
+
"type": "array",
|
|
44708
|
+
"items": {
|
|
44709
|
+
"$ref": "#/components/schemas/GetWorkflowRunsDto"
|
|
44710
|
+
}
|
|
44711
|
+
},
|
|
44712
|
+
"next": {
|
|
44713
|
+
"type": "object",
|
|
44714
|
+
"nullable": true,
|
|
44715
|
+
"description": "Next cursor for pagination"
|
|
44716
|
+
},
|
|
44717
|
+
"previous": {
|
|
44718
|
+
"type": "object",
|
|
44719
|
+
"nullable": true,
|
|
44720
|
+
"description": "Previous cursor for pagination"
|
|
44721
|
+
}
|
|
44722
|
+
},
|
|
44723
|
+
"required": [
|
|
44724
|
+
"data"
|
|
44725
|
+
]
|
|
44726
|
+
},
|
|
44727
|
+
"StepExecutionDetailDto": {
|
|
44728
|
+
"type": "object",
|
|
44729
|
+
"properties": {
|
|
44730
|
+
"_id": {
|
|
44731
|
+
"type": "string",
|
|
44732
|
+
"description": "Unique identifier of the execution detail"
|
|
44733
|
+
},
|
|
44734
|
+
"createdAt": {
|
|
44735
|
+
"type": "string",
|
|
44736
|
+
"description": "Creation time of the execution detail"
|
|
44737
|
+
},
|
|
44738
|
+
"status": {
|
|
44739
|
+
"$ref": "#/components/schemas/ExecutionDetailsStatusEnum"
|
|
44740
|
+
},
|
|
44741
|
+
"detail": {
|
|
44742
|
+
"type": "string",
|
|
44743
|
+
"description": "Detailed information about the execution"
|
|
44744
|
+
},
|
|
44745
|
+
"providerId": {
|
|
44746
|
+
"type": "string",
|
|
44747
|
+
"description": "Provider identifier"
|
|
44748
|
+
},
|
|
44749
|
+
"raw": {
|
|
44750
|
+
"type": "object",
|
|
44751
|
+
"nullable": true,
|
|
44752
|
+
"description": "Raw data of the execution"
|
|
44753
|
+
}
|
|
44754
|
+
},
|
|
44755
|
+
"required": [
|
|
44756
|
+
"_id",
|
|
44757
|
+
"status",
|
|
44758
|
+
"detail"
|
|
44759
|
+
]
|
|
44760
|
+
},
|
|
44761
|
+
"StepRunDto": {
|
|
44762
|
+
"type": "object",
|
|
44763
|
+
"properties": {
|
|
44764
|
+
"stepRunId": {
|
|
44765
|
+
"type": "string",
|
|
44766
|
+
"description": "Step run identifier"
|
|
44767
|
+
},
|
|
44768
|
+
"stepId": {
|
|
44769
|
+
"type": "string",
|
|
44770
|
+
"description": "Step identifier"
|
|
44771
|
+
},
|
|
44772
|
+
"stepType": {
|
|
44773
|
+
"type": "string",
|
|
44774
|
+
"description": "Step type"
|
|
44775
|
+
},
|
|
44776
|
+
"providerId": {
|
|
44777
|
+
"type": "string",
|
|
44778
|
+
"description": "Provider identifier"
|
|
44779
|
+
},
|
|
44780
|
+
"status": {
|
|
44781
|
+
"type": "string",
|
|
44782
|
+
"description": "Step status",
|
|
44783
|
+
"enum": [
|
|
44784
|
+
"pending",
|
|
44785
|
+
"queued",
|
|
44786
|
+
"running",
|
|
44787
|
+
"completed",
|
|
44788
|
+
"failed",
|
|
44789
|
+
"delayed",
|
|
44790
|
+
"canceled",
|
|
44791
|
+
"merged",
|
|
44792
|
+
"skipped"
|
|
44793
|
+
]
|
|
44794
|
+
},
|
|
44795
|
+
"createdAt": {
|
|
44796
|
+
"format": "date-time",
|
|
44797
|
+
"type": "string",
|
|
44798
|
+
"description": "Creation timestamp"
|
|
44799
|
+
},
|
|
44800
|
+
"updatedAt": {
|
|
44801
|
+
"format": "date-time",
|
|
44802
|
+
"type": "string",
|
|
44803
|
+
"description": "Update timestamp"
|
|
44804
|
+
},
|
|
44805
|
+
"executionDetails": {
|
|
44806
|
+
"description": "Execution details",
|
|
44807
|
+
"type": "array",
|
|
44808
|
+
"items": {
|
|
44809
|
+
"$ref": "#/components/schemas/StepExecutionDetailDto"
|
|
44810
|
+
}
|
|
44811
|
+
},
|
|
44812
|
+
"digest": {
|
|
44813
|
+
"description": "Optional digest for the job, including metadata and events",
|
|
44814
|
+
"allOf": [
|
|
44815
|
+
{
|
|
44816
|
+
"$ref": "#/components/schemas/DigestMetadataDto"
|
|
44817
|
+
}
|
|
44818
|
+
]
|
|
44819
|
+
},
|
|
44820
|
+
"scheduleExtensionsCount": {
|
|
44821
|
+
"type": "number",
|
|
44822
|
+
"description": "The number of times the digest/delay job has been extended to align with the subscribers schedule"
|
|
44823
|
+
}
|
|
44824
|
+
},
|
|
44825
|
+
"required": [
|
|
44826
|
+
"stepRunId",
|
|
44827
|
+
"stepId",
|
|
44828
|
+
"stepType",
|
|
44829
|
+
"status",
|
|
44830
|
+
"createdAt",
|
|
44831
|
+
"updatedAt",
|
|
44832
|
+
"executionDetails"
|
|
44833
|
+
]
|
|
44834
|
+
},
|
|
44835
|
+
"GetWorkflowRunResponseDto": {
|
|
44836
|
+
"type": "object",
|
|
44837
|
+
"properties": {
|
|
44838
|
+
"id": {
|
|
44839
|
+
"type": "string",
|
|
44840
|
+
"description": "Workflow run id"
|
|
44841
|
+
},
|
|
44842
|
+
"workflowId": {
|
|
44843
|
+
"type": "string",
|
|
44844
|
+
"description": "Workflow identifier"
|
|
44845
|
+
},
|
|
44846
|
+
"workflowName": {
|
|
44847
|
+
"type": "string",
|
|
44848
|
+
"description": "Workflow name"
|
|
44849
|
+
},
|
|
44850
|
+
"organizationId": {
|
|
44851
|
+
"type": "string",
|
|
44852
|
+
"description": "Organization identifier"
|
|
44853
|
+
},
|
|
44854
|
+
"environmentId": {
|
|
44855
|
+
"type": "string",
|
|
44856
|
+
"description": "Environment identifier"
|
|
44857
|
+
},
|
|
44858
|
+
"internalSubscriberId": {
|
|
44859
|
+
"type": "string",
|
|
44860
|
+
"description": "Internal subscriber identifier"
|
|
44861
|
+
},
|
|
44862
|
+
"subscriberId": {
|
|
44863
|
+
"type": "string",
|
|
44864
|
+
"description": "External subscriber identifier"
|
|
44865
|
+
},
|
|
44866
|
+
"status": {
|
|
44867
|
+
"enum": [
|
|
44868
|
+
"processing",
|
|
44869
|
+
"completed",
|
|
44870
|
+
"error"
|
|
44871
|
+
],
|
|
44872
|
+
"type": "string",
|
|
44873
|
+
"description": "Workflow run status"
|
|
44874
|
+
},
|
|
44875
|
+
"deliveryLifecycleStatus": {
|
|
44876
|
+
"enum": [
|
|
44877
|
+
"pending",
|
|
44878
|
+
"sent",
|
|
44879
|
+
"errored",
|
|
44880
|
+
"skipped",
|
|
44881
|
+
"canceled",
|
|
44882
|
+
"merged",
|
|
44883
|
+
"delivered",
|
|
44884
|
+
"interacted"
|
|
44885
|
+
],
|
|
44886
|
+
"type": "string",
|
|
44887
|
+
"description": "Workflow run delivery lifecycle status"
|
|
44888
|
+
},
|
|
44889
|
+
"triggerIdentifier": {
|
|
44890
|
+
"type": "string",
|
|
44891
|
+
"description": "Trigger identifier"
|
|
44892
|
+
},
|
|
44893
|
+
"transactionId": {
|
|
44894
|
+
"type": "string",
|
|
44895
|
+
"description": "Transaction identifier"
|
|
44896
|
+
},
|
|
44897
|
+
"createdAt": {
|
|
44898
|
+
"type": "string",
|
|
44899
|
+
"description": "Creation timestamp"
|
|
44900
|
+
},
|
|
44901
|
+
"updatedAt": {
|
|
44902
|
+
"type": "string",
|
|
44903
|
+
"description": "Update timestamp"
|
|
44904
|
+
},
|
|
44905
|
+
"severity": {
|
|
44906
|
+
"enum": [
|
|
44907
|
+
"high",
|
|
44908
|
+
"medium",
|
|
44909
|
+
"low",
|
|
44910
|
+
"none"
|
|
44911
|
+
],
|
|
44912
|
+
"type": "string",
|
|
44913
|
+
"description": "Severity"
|
|
44914
|
+
},
|
|
44915
|
+
"critical": {
|
|
44916
|
+
"type": "boolean",
|
|
44917
|
+
"description": "Critical flag"
|
|
44918
|
+
},
|
|
44919
|
+
"contextKeys": {
|
|
44920
|
+
"description": "Context (single or multi) in which the workflow run was executed",
|
|
44921
|
+
"type": "array",
|
|
44922
|
+
"items": {
|
|
44923
|
+
"type": "string"
|
|
44924
|
+
}
|
|
44925
|
+
},
|
|
44926
|
+
"topics": {
|
|
44927
|
+
"description": "Topics",
|
|
44368
44928
|
"type": "array",
|
|
44369
44929
|
"items": {
|
|
44370
|
-
"
|
|
44930
|
+
"$ref": "#/components/schemas/TopicResponseDto"
|
|
44371
44931
|
}
|
|
44372
44932
|
},
|
|
44373
44933
|
"steps": {
|
|
@@ -44807,7 +45367,8 @@
|
|
|
44807
45367
|
},
|
|
44808
45368
|
"connectionIdentifier": {
|
|
44809
45369
|
"type": "string",
|
|
44810
|
-
"description": "Identifier of the channel connection that will be created"
|
|
45370
|
+
"description": "Identifier of the channel connection that will be created. It is generated automatically if not provided.",
|
|
45371
|
+
"example": "slack-connection-abc123"
|
|
44811
45372
|
},
|
|
44812
45373
|
"context": {
|
|
44813
45374
|
"type": "object",
|
|
@@ -45730,6 +46291,11 @@
|
|
|
45730
46291
|
"description": "Indicates whether the notification has been seen by the subscriber.",
|
|
45731
46292
|
"example": true
|
|
45732
46293
|
},
|
|
46294
|
+
"archived": {
|
|
46295
|
+
"type": "boolean",
|
|
46296
|
+
"description": "Indicates whether the notification has been archived by the subscriber.",
|
|
46297
|
+
"example": false
|
|
46298
|
+
},
|
|
45733
46299
|
"deviceTokens": {
|
|
45734
46300
|
"nullable": true,
|
|
45735
46301
|
"description": "Device tokens for push notifications, if applicable.",
|
|
@@ -45811,6 +46377,7 @@
|
|
|
45811
46377
|
"channel",
|
|
45812
46378
|
"read",
|
|
45813
46379
|
"seen",
|
|
46380
|
+
"archived",
|
|
45814
46381
|
"cta",
|
|
45815
46382
|
"status"
|
|
45816
46383
|
]
|
|
@@ -47390,40 +47957,6 @@
|
|
|
47390
47957
|
}
|
|
47391
47958
|
}
|
|
47392
47959
|
},
|
|
47393
|
-
"TopicResponseDto": {
|
|
47394
|
-
"type": "object",
|
|
47395
|
-
"properties": {
|
|
47396
|
-
"_id": {
|
|
47397
|
-
"type": "string",
|
|
47398
|
-
"description": "The identifier of the topic",
|
|
47399
|
-
"example": "64da692e9a94fb2e6449ad06"
|
|
47400
|
-
},
|
|
47401
|
-
"key": {
|
|
47402
|
-
"type": "string",
|
|
47403
|
-
"description": "The unique key of the topic",
|
|
47404
|
-
"example": "product-updates"
|
|
47405
|
-
},
|
|
47406
|
-
"name": {
|
|
47407
|
-
"type": "string",
|
|
47408
|
-
"description": "The name of the topic",
|
|
47409
|
-
"example": "Product Updates"
|
|
47410
|
-
},
|
|
47411
|
-
"createdAt": {
|
|
47412
|
-
"type": "string",
|
|
47413
|
-
"description": "The date the topic was created",
|
|
47414
|
-
"example": "2023-08-15T00:00:00.000Z"
|
|
47415
|
-
},
|
|
47416
|
-
"updatedAt": {
|
|
47417
|
-
"type": "string",
|
|
47418
|
-
"description": "The date the topic was last updated",
|
|
47419
|
-
"example": "2023-08-15T00:00:00.000Z"
|
|
47420
|
-
}
|
|
47421
|
-
},
|
|
47422
|
-
"required": [
|
|
47423
|
-
"_id",
|
|
47424
|
-
"key"
|
|
47425
|
-
]
|
|
47426
|
-
},
|
|
47427
47960
|
"SubscriberDto": {
|
|
47428
47961
|
"type": "object",
|
|
47429
47962
|
"properties": {
|
|
@@ -47475,6 +48008,11 @@
|
|
|
47475
48008
|
"description": "The identifier of the subscription",
|
|
47476
48009
|
"example": "64da692e9a94fb2e6449ad08"
|
|
47477
48010
|
},
|
|
48011
|
+
"identifier": {
|
|
48012
|
+
"type": "string",
|
|
48013
|
+
"description": "The identifier of the subscription",
|
|
48014
|
+
"example": "tk=product-updates:si=subscriber-123"
|
|
48015
|
+
},
|
|
47478
48016
|
"createdAt": {
|
|
47479
48017
|
"type": "string",
|
|
47480
48018
|
"description": "The date and time the subscription was created",
|
|
@@ -47499,6 +48037,7 @@
|
|
|
47499
48037
|
},
|
|
47500
48038
|
"required": [
|
|
47501
48039
|
"_id",
|
|
48040
|
+
"identifier",
|
|
47502
48041
|
"createdAt",
|
|
47503
48042
|
"topic",
|
|
47504
48043
|
"subscriber"
|
|
@@ -50987,7 +51526,7 @@
|
|
|
50987
51526
|
},
|
|
50988
51527
|
"stepId": {
|
|
50989
51528
|
"type": "string",
|
|
50990
|
-
"pattern": "/^[a-
|
|
51529
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
50991
51530
|
"description": "Unique identifier for the step"
|
|
50992
51531
|
},
|
|
50993
51532
|
"name": {
|
|
@@ -51024,7 +51563,7 @@
|
|
|
51024
51563
|
},
|
|
51025
51564
|
"stepId": {
|
|
51026
51565
|
"type": "string",
|
|
51027
|
-
"pattern": "/^[a-
|
|
51566
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51028
51567
|
"description": "Unique identifier for the step"
|
|
51029
51568
|
},
|
|
51030
51569
|
"name": {
|
|
@@ -51061,7 +51600,7 @@
|
|
|
51061
51600
|
},
|
|
51062
51601
|
"stepId": {
|
|
51063
51602
|
"type": "string",
|
|
51064
|
-
"pattern": "/^[a-
|
|
51603
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51065
51604
|
"description": "Unique identifier for the step"
|
|
51066
51605
|
},
|
|
51067
51606
|
"name": {
|
|
@@ -51098,7 +51637,7 @@
|
|
|
51098
51637
|
},
|
|
51099
51638
|
"stepId": {
|
|
51100
51639
|
"type": "string",
|
|
51101
|
-
"pattern": "/^[a-
|
|
51640
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51102
51641
|
"description": "Unique identifier for the step"
|
|
51103
51642
|
},
|
|
51104
51643
|
"name": {
|
|
@@ -51135,7 +51674,7 @@
|
|
|
51135
51674
|
},
|
|
51136
51675
|
"stepId": {
|
|
51137
51676
|
"type": "string",
|
|
51138
|
-
"pattern": "/^[a-
|
|
51677
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51139
51678
|
"description": "Unique identifier for the step"
|
|
51140
51679
|
},
|
|
51141
51680
|
"name": {
|
|
@@ -51172,7 +51711,7 @@
|
|
|
51172
51711
|
},
|
|
51173
51712
|
"stepId": {
|
|
51174
51713
|
"type": "string",
|
|
51175
|
-
"pattern": "/^[a-
|
|
51714
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51176
51715
|
"description": "Unique identifier for the step"
|
|
51177
51716
|
},
|
|
51178
51717
|
"name": {
|
|
@@ -51209,7 +51748,7 @@
|
|
|
51209
51748
|
},
|
|
51210
51749
|
"stepId": {
|
|
51211
51750
|
"type": "string",
|
|
51212
|
-
"pattern": "/^[a-
|
|
51751
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51213
51752
|
"description": "Unique identifier for the step"
|
|
51214
51753
|
},
|
|
51215
51754
|
"name": {
|
|
@@ -51246,7 +51785,7 @@
|
|
|
51246
51785
|
},
|
|
51247
51786
|
"stepId": {
|
|
51248
51787
|
"type": "string",
|
|
51249
|
-
"pattern": "/^[a-
|
|
51788
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51250
51789
|
"description": "Unique identifier for the step"
|
|
51251
51790
|
},
|
|
51252
51791
|
"name": {
|
|
@@ -51283,7 +51822,7 @@
|
|
|
51283
51822
|
},
|
|
51284
51823
|
"stepId": {
|
|
51285
51824
|
"type": "string",
|
|
51286
|
-
"pattern": "/^[a-
|
|
51825
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51287
51826
|
"description": "Unique identifier for the step"
|
|
51288
51827
|
},
|
|
51289
51828
|
"name": {
|
|
@@ -51391,7 +51930,7 @@
|
|
|
51391
51930
|
},
|
|
51392
51931
|
"workflowId": {
|
|
51393
51932
|
"type": "string",
|
|
51394
|
-
"pattern": "/^[a-
|
|
51933
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51395
51934
|
"description": "Unique identifier for the workflow"
|
|
51396
51935
|
},
|
|
51397
51936
|
"steps": {
|
|
@@ -51747,7 +52286,7 @@
|
|
|
51747
52286
|
},
|
|
51748
52287
|
"workflowId": {
|
|
51749
52288
|
"type": "string",
|
|
51750
|
-
"pattern": "/^[a-
|
|
52289
|
+
"pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
|
|
51751
52290
|
"description": "Custom workflow identifier for the duplicated workflow"
|
|
51752
52291
|
},
|
|
51753
52292
|
"tags": {
|