diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 8a198d0e..f892e6fc 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -3,10 +3,10 @@ id: f50499c4-d106-4975-983f-ead3a386ec53 management: docChecksum: fd909d3ac88ddddc757bde177be7fbbe docVersion: "1.0" - speakeasyVersion: 1.308.0 - generationVersion: 2.342.2 - releaseVersion: 0.0.1-alpha.1 - configChecksum: 2ae251f220977648bbd47931e1478c6c + speakeasyVersion: 1.308.1 + generationVersion: 2.342.6 + releaseVersion: 0.0.1-alpha.2 + configChecksum: 944abba41b79fc21b9eb7d6917828fcd published: true features: typescript: @@ -29,35 +29,35 @@ features: sdkHooks: 0.1.0 unions: 2.85.5 generatedFiles: - - src/sdk/members.ts - - src/sdk/branding.ts - - src/sdk/organizations.ts + - src/sdk/changes.ts - src/sdk/apikeys.ts - src/sdk/environments.ts - - src/sdk/executiondetails.ts - - src/sdk/variables.ts - - src/sdk/status.ts - - src/sdk/workflows.ts - src/sdk/events.ts - - src/sdk/stats.ts - - src/sdk/notifications.ts - - src/sdk/workflowgroups.ts + - src/sdk/executiondetails.ts + - src/sdk/feeds.ts - src/sdk/webhooks.ts - src/sdk/integrations.ts - - src/sdk/changes.ts + - src/sdk/layouts.ts + - src/sdk/messages.ts + - src/sdk/workflowgroups.ts + - src/sdk/stats.ts + - src/sdk/notifications.ts + - src/sdk/branding.ts + - src/sdk/members.ts + - src/sdk/organizations.ts - src/sdk/credentials.ts + - src/sdk/authentication.ts + - src/sdk/novumessages.ts + - src/sdk/novunotifications.ts - src/sdk/properties.ts - src/sdk/preferences.ts - - src/sdk/novunotifications.ts - - src/sdk/novumessages.ts - - src/sdk/authentication.ts - src/sdk/subscribers.ts - - src/sdk/feeds.ts - - src/sdk/layouts.ts - - src/sdk/messages.ts + - src/sdk/tenants.ts - src/sdk/novusubscribers.ts - src/sdk/topics.ts - - src/sdk/tenants.ts + - src/sdk/variables.ts + - src/sdk/status.ts + - src/sdk/workflows.ts - src/sdk/sdk.ts - .eslintrc.js - .npmignore @@ -85,353 +85,346 @@ generatedFiles: - src/types/operations.ts - src/types/rfcdate.ts - tsconfig.json - - src/models/components/organizationresponsedto.ts - - src/models/components/ipartnerconfigurationresponsedto.ts - - src/models/components/organizationbrandingresponsedto.ts - - src/models/components/createorganizationdto.ts - - src/models/components/renameorganizationdto.ts - - src/models/components/memberresponsedto.ts - - src/models/components/memberinvitedto.ts - - src/models/components/memberuserdto.ts - - src/models/components/updatebrandingdetailsdto.ts + - src/models/components/changeresponsedto.ts + - src/models/components/bulkapplychangedto.ts + - src/models/components/datanumberdto.ts + - src/models/components/changesresponsedto.ts - src/models/components/environmentresponsedto.ts - src/models/components/apikey.ts - - src/models/components/executiondetailsresponsedto.ts - - src/models/components/workflowsresponsedto.ts - - src/models/components/workflowresponse.ts - - src/models/components/notificationgroup.ts - - src/models/components/notificationtrigger.ts - - src/models/components/notificationtriggervariable.ts - - src/models/components/notificationstep.ts - - src/models/components/notificationstepvariant.ts - - src/models/components/digestregularmetadata.ts - - src/models/components/digesttimedmetadata.ts - - src/models/components/timedconfig.ts - - src/models/components/delayregularmetadata.ts - - src/models/components/delayscheduledmetadata.ts - - src/models/components/stepfilter.ts - - src/models/components/fieldfilterpart.ts - - src/models/components/messagetemplate.ts - - src/models/components/preferencechannels.ts - - src/models/components/createworkflowrequestdto.ts - - src/models/components/updateworkflowrequestdto.ts - src/models/components/databooleandto.ts - - src/models/components/variablesresponsedto.ts - - src/models/components/changeworkflowstatusrequestdto.ts - src/models/components/triggereventresponsedto.ts - src/models/components/triggereventrequestdto.ts - - src/models/components/tenantpayloaddto.ts - src/models/components/subscriberpayloaddto.ts - src/models/components/subscriberchanneldto.ts - src/models/components/channelcredentialsdto.ts - src/models/components/topicpayloaddto.ts - - src/models/components/bulktriggereventdto.ts + - src/models/components/tenantpayloaddto.ts - src/models/components/triggereventtoallrequestdto.ts + - src/models/components/bulktriggereventdto.ts + - src/models/components/executiondetailsresponsedto.ts + - src/models/components/feedresponsedto.ts + - src/models/components/createfeedrequestdto.ts + - src/models/components/integrationresponsedto.ts + - src/models/components/credentialsdto.ts + - src/models/components/stepfilter.ts + - src/models/components/fieldfilterpart.ts + - src/models/components/createintegrationrequestdto.ts + - src/models/components/updateintegrationrequestdto.ts + - src/models/components/createlayoutresponsedto.ts + - src/models/components/getlayoutresponsedto.ts + - src/models/components/updatelayoutresponsedto.ts + - src/models/components/updatelayoutrequestdto.ts + - src/models/components/deletemessageresponsedto.ts - src/models/components/activitiesresponsedto.ts - src/models/components/activitynotificationresponsedto.ts + - src/models/components/activitynotificationtemplateresponsedto.ts + - src/models/components/notificationtrigger.ts + - src/models/components/notificationtriggervariable.ts + - src/models/components/activitynotificationsubscriberresponsedto.ts - src/models/components/activitynotificationjobresponsedto.ts - src/models/components/activitynotificationstepresponsedto.ts - src/models/components/messagetemplatedto.ts - src/models/components/activitynotificationexecutiondetailresponsedto.ts - - src/models/components/activitynotificationtemplateresponsedto.ts - - src/models/components/activitynotificationsubscriberresponsedto.ts - - src/models/components/activitystatsresponsedto.ts - - src/models/components/activitygraphstatesresponse.ts - src/models/components/notificationgroupresponsedto.ts - src/models/components/createnotificationgrouprequestdto.ts - src/models/components/deletenotificationgroupresponsedto.ts - - src/models/components/integrationresponsedto.ts - - src/models/components/credentialsdto.ts - - src/models/components/createintegrationrequestdto.ts - - src/models/components/updateintegrationrequestdto.ts - - src/models/components/changesresponsedto.ts - - src/models/components/changeresponsedto.ts - - src/models/components/datanumberdto.ts - - src/models/components/bulkapplychangedto.ts + - src/models/components/activitygraphstatesresponse.ts + - src/models/components/activitystatsresponsedto.ts + - src/models/components/organizationresponsedto.ts + - src/models/components/ipartnerconfigurationresponsedto.ts + - src/models/components/organizationbrandingresponsedto.ts + - src/models/components/createorganizationdto.ts + - src/models/components/renameorganizationdto.ts + - src/models/components/updatebrandingdetailsdto.ts + - src/models/components/memberresponsedto.ts + - src/models/components/memberuserdto.ts + - src/models/components/memberinvitedto.ts - src/models/components/subscriberresponsedto.ts - src/models/components/channelsettings.ts - src/models/components/channelcredentials.ts - src/models/components/createsubscriberrequestdto.ts - - src/models/components/updatesubscriberrequestdto.ts - - src/models/components/deletesubscriberresponsedto.ts - src/models/components/bulksubscribercreatedto.ts + - src/models/components/deletesubscriberresponsedto.ts + - src/models/components/updatesubscriberrequestdto.ts - src/models/components/updatesubscriberchannelrequestdto.ts - - src/models/components/updatesubscriberonlineflagrequestdto.ts - - src/models/components/updatesubscriberpreferenceresponsedto.ts - - src/models/components/preference.ts - - src/models/components/templateresponse.ts - - src/models/components/updatesubscriberglobalpreferencesrequestdto.ts - - src/models/components/channelpreference.ts - - src/models/components/getsubscriberpreferencesresponsedto.ts - - src/models/components/updatesubscriberpreferencerequestdto.ts - - src/models/components/feedresponsedto.ts - - src/models/components/unseencountresponse.ts + - src/models/components/markallmessageasrequestdto.ts - src/models/components/messageentity.ts - src/models/components/messagemarkasrequestdto.ts - - src/models/components/markallmessageasrequestdto.ts - src/models/components/messageresponsedto.ts + - src/models/components/workflowresponse.ts + - src/models/components/notificationstep.ts + - src/models/components/notificationstepvariant.ts + - src/models/components/messagetemplate.ts + - src/models/components/digestregularmetadata.ts + - src/models/components/digesttimedmetadata.ts + - src/models/components/timedconfig.ts + - src/models/components/delayregularmetadata.ts + - src/models/components/delayscheduledmetadata.ts + - src/models/components/preferencechannels.ts + - src/models/components/notificationgroup.ts - src/models/components/messagecta.ts + - src/models/components/messagectadata.ts - src/models/components/messageaction.ts - src/models/components/messageactionresult.ts - src/models/components/messagebutton.ts - - src/models/components/messagectadata.ts - src/models/components/emailblock.ts - src/models/components/emailblockstyles.ts - src/models/components/markmessageactionasseendto.ts - - src/models/components/createfeedrequestdto.ts - - src/models/components/createlayoutresponsedto.ts - - src/models/components/getlayoutresponsedto.ts - - src/models/components/updatelayoutresponsedto.ts - - src/models/components/updatelayoutrequestdto.ts - - src/models/components/deletemessageresponsedto.ts - - src/models/components/filtertopicsresponsedto.ts - - src/models/components/topicdto.ts + - src/models/components/unseencountresponse.ts + - src/models/components/updatesubscriberonlineflagrequestdto.ts + - src/models/components/updatesubscriberpreferenceresponsedto.ts + - src/models/components/templateresponse.ts + - src/models/components/preference.ts + - src/models/components/getsubscriberpreferencesresponsedto.ts + - src/models/components/updatesubscriberpreferencerequestdto.ts + - src/models/components/channelpreference.ts + - src/models/components/updatesubscriberglobalpreferencesrequestdto.ts + - src/models/components/createtenantresponsedto.ts + - src/models/components/createtenantrequestdto.ts + - src/models/components/gettenantresponsedto.ts + - src/models/components/updatetenantresponsedto.ts + - src/models/components/updatetenantrequestdto.ts - src/models/components/createtopicresponsedto.ts - src/models/components/createtopicrequestdto.ts - - src/models/components/gettopicresponsedto.ts + - src/models/components/filtertopicsresponsedto.ts + - src/models/components/topicdto.ts - src/models/components/renametopicresponsedto.ts - src/models/components/renametopicrequestdto.ts + - src/models/components/gettopicresponsedto.ts - src/models/components/addsubscribersrequestdto.ts - - src/models/components/topicsubscriberdto.ts - src/models/components/removesubscribersrequestdto.ts - - src/models/components/gettenantresponsedto.ts - - src/models/components/createtenantresponsedto.ts - - src/models/components/createtenantrequestdto.ts - - src/models/components/updatetenantresponsedto.ts - - src/models/components/updatetenantrequestdto.ts + - src/models/components/topicsubscriberdto.ts + - src/models/components/createworkflowrequestdto.ts + - src/models/components/workflowsresponsedto.ts + - src/models/components/updateworkflowrequestdto.ts + - src/models/components/variablesresponsedto.ts + - src/models/components/changeworkflowstatusrequestdto.ts - src/models/components/security.ts - - src/models/operations/organizationcontrollerremove.ts - - src/models/operations/executiondetailscontrollergetexecutiondetailsfornotification.ts - - src/models/operations/workflowcontrollerlistworkflows.ts - - src/models/operations/workflowcontrollergetworkflowbyid.ts - - src/models/operations/workflowcontrollerupdateworkflowbyid.ts - - src/models/operations/workflowcontrollerdeleteworkflowbyid.ts - - src/models/operations/workflowcontrollerupdateactivestatus.ts + - src/models/operations/changescontrollerapplydiff.ts + - src/models/operations/changescontrollergetchanges.ts - src/models/operations/eventscontrollercancel.ts - - src/models/operations/notificationscontrollerlistnotifications.ts - - src/models/operations/notificationscontrollergetnotification.ts - - src/models/operations/notificationscontrollergetactivitygraphstats.ts - - src/models/operations/notificationgroupscontrollergetnotificationgroup.ts - - src/models/operations/notificationgroupscontrollerdeletenotificationgroup.ts - - src/models/operations/notificationgroupscontrollerupdatenotificationgroup.ts - - src/models/operations/integrationscontrollerupdateintegrationbyid.ts + - src/models/operations/executiondetailscontrollergetexecutiondetailsfornotification.ts + - src/models/operations/feedscontrollerdeletefeedbyid.ts - src/models/operations/integrationscontrollerremoveintegration.ts - src/models/operations/integrationscontrollersetintegrationasprimary.ts + - src/models/operations/integrationscontrollerupdateintegrationbyid.ts - src/models/operations/integrationscontrollergetwebhooksupportstatus.ts - - src/models/operations/changescontrollergetchanges.ts - - src/models/operations/changescontrollerapplydiff.ts + - src/models/operations/layoutscontrollerdeletelayout.ts + - src/models/operations/layoutscontrollerlistlayouts.ts + - src/models/operations/layoutscontrollergetlayout.ts + - src/models/operations/layoutscontrollersetdefaultlayout.ts + - src/models/operations/layoutscontrollerupdatelayout.ts + - src/models/operations/messagescontrollerdeletemessage.ts + - src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts + - src/models/operations/messagescontrollergetmessages.ts + - src/models/operations/notificationgroupscontrollerdeletenotificationgroup.ts + - src/models/operations/notificationgroupscontrollergetnotificationgroup.ts + - src/models/operations/notificationgroupscontrollerupdatenotificationgroup.ts + - src/models/operations/notificationscontrollerlistnotifications.ts + - src/models/operations/notificationscontrollergetnotification.ts + - src/models/operations/notificationscontrollergetactivitygraphstats.ts + - src/models/operations/organizationcontrollerremove.ts + - src/models/operations/subscriberscontrollerremovesubscriber.ts - src/models/operations/subscriberscontrollerlistsubscribers.ts - src/models/operations/subscriberscontrollergetsubscriber.ts - src/models/operations/subscriberscontrollerupdatesubscriber.ts - - src/models/operations/subscriberscontrollerremovesubscriber.ts - - src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts - src/models/operations/subscriberscontrollermodifysubscriberchannel.ts - src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts + - src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts + - src/models/operations/subscriberscontrollerchataccessoauth.ts + - src/models/operations/subscriberscontrollerchatoauthcallback.ts + - src/models/operations/subscriberscontrollermarkallunreadasread.ts + - src/models/operations/subscriberscontrollermarkmessagesas.ts + - src/models/operations/subscriberscontrollermarkactionasseen.ts + - src/models/operations/subscriberscontrollergetnotificationsfeed.ts + - src/models/operations/subscriberscontrollergetunseencount.ts - src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts - src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts - - src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts - src/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.ts - src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts - - src/models/operations/subscriberscontrollergetnotificationsfeed.ts - - src/models/operations/subscriberscontrollergetunseencount.ts - - src/models/operations/subscriberscontrollermarkmessagesas.ts - - src/models/operations/subscriberscontrollermarkallunreadasread.ts - - src/models/operations/subscriberscontrollermarkactionasseen.ts - - src/models/operations/subscriberscontrollerchatoauthcallback.ts - - src/models/operations/subscriberscontrollerchataccessoauth.ts - - src/models/operations/feedscontrollerdeletefeedbyid.ts - - src/models/operations/layoutscontrollerlistlayouts.ts - - src/models/operations/layoutscontrollergetlayout.ts - - src/models/operations/layoutscontrollerdeletelayout.ts - - src/models/operations/layoutscontrollerupdatelayout.ts - - src/models/operations/layoutscontrollersetdefaultlayout.ts - - src/models/operations/messagescontrollergetmessages.ts - - src/models/operations/messagescontrollerdeletemessage.ts - - src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts - - src/models/operations/topicscontrollerlisttopics.ts - - src/models/operations/topicscontrollergettopic.ts + - src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts + - src/models/operations/tenantcontrollerremovetenant.ts + - src/models/operations/tenantcontrollerlisttenants.ts + - src/models/operations/tenantcontrollergettenantbyid.ts + - src/models/operations/tenantcontrollerupdatetenant.ts - src/models/operations/topicscontrollerdeletetopic.ts + - src/models/operations/topicscontrollerlisttopics.ts - src/models/operations/topicscontrollerrenametopic.ts + - src/models/operations/topicscontrollergettopic.ts - src/models/operations/topicscontrolleraddsubscribers.ts - - src/models/operations/topicscontrollergettopicsubscriber.ts - src/models/operations/topicscontrollerremovesubscribers.ts - - src/models/operations/tenantcontrollerlisttenants.ts - - src/models/operations/tenantcontrollergettenantbyid.ts - - src/models/operations/tenantcontrollerremovetenant.ts - - src/models/operations/tenantcontrollerupdatetenant.ts + - src/models/operations/topicscontrollergettopicsubscriber.ts + - src/models/operations/workflowcontrollerdeleteworkflowbyid.ts + - src/models/operations/workflowcontrollerlistworkflows.ts + - src/models/operations/workflowcontrollergetworkflowbyid.ts + - src/models/operations/workflowcontrollerupdateworkflowbyid.ts + - src/models/operations/workflowcontrollerupdateactivestatus.ts - src/models/errors/index.ts - src/models/components/index.ts - src/models/operations/index.ts - - docs/models/components/organizationresponsedto.md - - docs/models/components/partnertype.md - - docs/models/components/ipartnerconfigurationresponsedto.md - - docs/models/components/direction.md - - docs/models/components/organizationbrandingresponsedto.md - - docs/models/components/jobtitle.md - - docs/models/components/productusecases.md - - docs/models/components/createorganizationdto.md - - docs/models/components/renameorganizationdto.md - - docs/models/components/roles.md - - docs/models/components/memberstatus.md - - docs/models/components/memberresponsedto.md - - docs/models/components/memberinvitedto.md - - docs/models/components/memberuserdto.md - - docs/models/components/updatebrandingdetailsdto.md + - docs/models/components/change.md + - docs/models/components/type.md + - docs/models/components/changeresponsedto.md + - docs/models/components/bulkapplychangedto.md + - docs/models/components/datanumberdto.md + - docs/models/components/changesresponsedto.md - docs/models/components/apikeys.md - docs/models/components/environmentresponsedto.md - docs/models/components/apikey.md - - docs/models/components/channel.md - - docs/models/components/source.md - - docs/models/components/status.md - - docs/models/components/executiondetailsresponsedto.md - - docs/models/components/workflowsresponsedto.md - - docs/models/components/data.md - - docs/models/components/workflowintegrationstatus.md - - docs/models/components/workflowresponse.md - - docs/models/components/notificationgroup.md - - docs/models/components/notificationtriggertype.md - - docs/models/components/notificationtrigger.md - - docs/models/components/notificationtriggervariable.md - - docs/models/components/parentid.md - - docs/models/components/metadata.md - - docs/models/components/replycallback.md - - docs/models/components/notificationstep.md - - docs/models/components/notificationstepvariantparentid.md - - docs/models/components/notificationstepvariantmetadata.md - - docs/models/components/notificationstepvariantreplycallback.md - - docs/models/components/notificationstepvariant.md - - docs/models/components/unit.md - - docs/models/components/digestregularmetadatatype.md - - docs/models/components/backoffunit.md - - docs/models/components/digestregularmetadata.md - - docs/models/components/digesttimedmetadataunit.md - - docs/models/components/digesttimedmetadatatype.md - - docs/models/components/digesttimedmetadata.md - - docs/models/components/weekdays.md - - docs/models/components/ordinal.md - - docs/models/components/ordinalvalue.md - - docs/models/components/monthlytype.md - - docs/models/components/timedconfig.md - - docs/models/components/delayregularmetadataunit.md - - docs/models/components/delayregularmetadatatype.md - - docs/models/components/delayregularmetadata.md - - docs/models/components/delayscheduledmetadatatype.md - - docs/models/components/delayscheduledmetadata.md - - docs/models/components/type.md - - docs/models/components/value.md - - docs/models/components/stepfilter.md - - docs/models/components/operator.md - - docs/models/components/on.md - - docs/models/components/fieldfilterpart.md - - docs/models/components/messagetemplate.md - - docs/models/components/preferencechannels.md - - docs/models/components/createworkflowrequestdtonotificationgroup.md - - docs/models/components/createworkflowrequestdtodata.md - - docs/models/components/createworkflowrequestdto.md - - docs/models/components/updateworkflowrequestdtodata.md - - docs/models/components/updateworkflowrequestdto.md - docs/models/components/databooleandto.md - - docs/models/components/translations.md - - docs/models/components/system.md - - docs/models/components/variablesresponsedto.md - - docs/models/components/changeworkflowstatusrequestdto.md - docs/models/components/triggereventresponsedtostatus.md - docs/models/components/triggereventresponsedto.md - - docs/models/components/payload.md - - docs/models/components/overrides.md - - docs/models/components/to.md - docs/models/components/actor.md + - docs/models/components/triggereventrequestdtooverrides.md + - docs/models/components/triggereventrequestdtopayload.md - docs/models/components/tenant.md + - docs/models/components/to.md - docs/models/components/triggereventrequestdto.md - - docs/models/components/tenantpayloaddtodata.md - - docs/models/components/tenantpayloaddto.md - docs/models/components/subscriberpayloaddtodata.md - docs/models/components/subscriberpayloaddto.md - - docs/models/components/providerid.md + - docs/models/components/subscriberchanneldtoproviderid.md - docs/models/components/subscriberchanneldto.md - docs/models/components/channelcredentialsdto.md - docs/models/components/topicpayloaddtotype.md - docs/models/components/topicpayloaddto.md - - docs/models/components/bulktriggereventdto.md - - docs/models/components/triggereventtoallrequestdtopayload.md - - docs/models/components/triggereventtoallrequestdtooverrides.md + - docs/models/components/tenantpayloaddtodata.md + - docs/models/components/tenantpayloaddto.md - docs/models/components/triggereventtoallrequestdtoactor.md + - docs/models/components/triggereventtoallrequestdtooverrides.md + - docs/models/components/triggereventtoallrequestdtopayload.md - docs/models/components/triggereventtoallrequestdtotenant.md - docs/models/components/triggereventtoallrequestdto.md + - docs/models/components/bulktriggereventdto.md + - docs/models/components/executiondetailsresponsedtochannel.md + - docs/models/components/executiondetailsresponsedtosource.md + - docs/models/components/executiondetailsresponsedtostatus.md + - docs/models/components/executiondetailsresponsedto.md + - docs/models/components/feedresponsedto.md + - docs/models/components/createfeedrequestdto.md + - docs/models/components/integrationresponsedtochannel.md + - docs/models/components/integrationresponsedto.md + - docs/models/components/tlsoptions.md + - docs/models/components/credentialsdto.md + - docs/models/components/stepfiltertype.md + - docs/models/components/value.md + - docs/models/components/stepfilter.md + - docs/models/components/on.md + - docs/models/components/operator.md + - docs/models/components/fieldfilterpart.md + - docs/models/components/channel.md + - docs/models/components/createintegrationrequestdto.md + - docs/models/components/updateintegrationrequestdto.md + - docs/models/components/createlayoutresponsedto.md + - docs/models/components/getlayoutresponsedtochannel.md + - docs/models/components/variables.md + - docs/models/components/getlayoutresponsedto.md + - docs/models/components/updatelayoutresponsedtochannel.md + - docs/models/components/updatelayoutresponsedtovariables.md + - docs/models/components/updatelayoutresponsedto.md + - docs/models/components/updatelayoutrequestdtovariables.md + - docs/models/components/updatelayoutrequestdto.md + - docs/models/components/deletemessageresponsedtostatus.md + - docs/models/components/deletemessageresponsedto.md - docs/models/components/activitiesresponsedto.md - - docs/models/components/channels.md + - docs/models/components/activitynotificationresponsedtochannels.md - docs/models/components/activitynotificationresponsedto.md + - docs/models/components/activitynotificationtemplateresponsedto.md + - docs/models/components/notificationtriggertype.md + - docs/models/components/notificationtrigger.md + - docs/models/components/notificationtriggervariable.md + - docs/models/components/activitynotificationsubscriberresponsedto.md - docs/models/components/digest.md - - docs/models/components/activitynotificationjobresponsedtopayload.md + - docs/models/components/payload.md - docs/models/components/activitynotificationjobresponsedtoproviderid.md - docs/models/components/activitynotificationjobresponsedto.md - docs/models/components/activitynotificationstepresponsedto.md - docs/models/components/messagetemplatedto.md - - docs/models/components/activitynotificationexecutiondetailresponsedtostatus.md - - docs/models/components/activitynotificationexecutiondetailresponsedtoproviderid.md - - docs/models/components/activitynotificationexecutiondetailresponsedtosource.md + - docs/models/components/providerid.md + - docs/models/components/source.md + - docs/models/components/status.md - docs/models/components/activitynotificationexecutiondetailresponsedto.md - - docs/models/components/activitynotificationtemplateresponsedto.md - - docs/models/components/activitynotificationsubscriberresponsedto.md - - docs/models/components/activitystatsresponsedto.md - - docs/models/components/activitygraphstatesresponsechannels.md - - docs/models/components/activitygraphstatesresponse.md - docs/models/components/notificationgroupresponsedto.md - docs/models/components/createnotificationgrouprequestdto.md - docs/models/components/deletenotificationgroupresponsedtostatus.md - docs/models/components/deletenotificationgroupresponsedto.md - - docs/models/components/integrationresponsedtochannel.md - - docs/models/components/integrationresponsedto.md - - docs/models/components/tlsoptions.md - - docs/models/components/credentialsdto.md - - docs/models/components/createintegrationrequestdtochannel.md - - docs/models/components/createintegrationrequestdto.md - - docs/models/components/updateintegrationrequestdto.md - - docs/models/components/changesresponsedto.md - - docs/models/components/changeresponsedtotype.md - - docs/models/components/change.md - - docs/models/components/changeresponsedto.md - - docs/models/components/datanumberdto.md - - docs/models/components/bulkapplychangedto.md + - docs/models/components/channels.md + - docs/models/components/activitygraphstatesresponse.md + - docs/models/components/activitystatsresponsedto.md + - docs/models/components/organizationresponsedto.md + - docs/models/components/partnertype.md + - docs/models/components/ipartnerconfigurationresponsedto.md + - docs/models/components/direction.md + - docs/models/components/organizationbrandingresponsedto.md + - docs/models/components/jobtitle.md + - docs/models/components/productusecases.md + - docs/models/components/createorganizationdto.md + - docs/models/components/renameorganizationdto.md + - docs/models/components/updatebrandingdetailsdto.md + - docs/models/components/memberstatus.md + - docs/models/components/roles.md + - docs/models/components/memberresponsedto.md + - docs/models/components/memberuserdto.md + - docs/models/components/memberinvitedto.md - docs/models/components/subscriberresponsedto.md - docs/models/components/channelsettingsproviderid.md - docs/models/components/channelsettings.md - docs/models/components/channelcredentials.md - - docs/models/components/createsubscriberrequestdtodata.md + - docs/models/components/data.md - docs/models/components/createsubscriberrequestdto.md - - docs/models/components/updatesubscriberrequestdtodata.md - - docs/models/components/updatesubscriberrequestdto.md + - docs/models/components/bulksubscribercreatedto.md - docs/models/components/deletesubscriberresponsedtostatus.md - docs/models/components/deletesubscriberresponsedto.md - - docs/models/components/bulksubscribercreatedto.md + - docs/models/components/updatesubscriberrequestdtodata.md + - docs/models/components/updatesubscriberrequestdto.md - docs/models/components/updatesubscriberchannelrequestdtoproviderid.md - docs/models/components/updatesubscriberchannelrequestdto.md - - docs/models/components/updatesubscriberonlineflagrequestdto.md - - docs/models/components/updatesubscriberpreferenceresponsedto.md - - docs/models/components/preference.md - - docs/models/components/templateresponse.md - - docs/models/components/updatesubscriberglobalpreferencesrequestdto.md - - docs/models/components/channelpreferencetype.md - - docs/models/components/channelpreference.md - - docs/models/components/getsubscriberpreferencesresponsedto.md - - docs/models/components/updatesubscriberpreferencerequestdto.md - - docs/models/components/feedresponsedto.md - - docs/models/components/unseencountresponse.md + - docs/models/components/feedidentifier.md + - docs/models/components/markas.md + - docs/models/components/markallmessageasrequestdto.md - docs/models/components/messageentity.md + - docs/models/components/messagemarkasrequestdtomarkas.md - docs/models/components/messageid.md - - docs/models/components/markas.md - docs/models/components/messagemarkasrequestdto.md - - docs/models/components/feedidentifier.md - - docs/models/components/markallmessageasrequestdtomarkas.md - - docs/models/components/markallmessageasrequestdto.md - - docs/models/components/content.md - docs/models/components/messageresponsedtochannel.md - - docs/models/components/messageresponsedtostatus.md + - docs/models/components/content.md + - docs/models/components/overrides.md - docs/models/components/messageresponsedtopayload.md - - docs/models/components/messageresponsedtooverrides.md + - docs/models/components/messageresponsedtostatus.md - docs/models/components/messageresponsedto.md + - docs/models/components/workflowresponsedata.md + - docs/models/components/workflowintegrationstatus.md + - docs/models/components/workflowresponse.md + - docs/models/components/parentid.md + - docs/models/components/metadata.md + - docs/models/components/replycallback.md + - docs/models/components/notificationstep.md + - docs/models/components/notificationstepvariantparentid.md + - docs/models/components/notificationstepvariantmetadata.md + - docs/models/components/notificationstepvariantreplycallback.md + - docs/models/components/notificationstepvariant.md + - docs/models/components/messagetemplate.md + - docs/models/components/backoffunit.md + - docs/models/components/digestregularmetadatatype.md + - docs/models/components/digestregularmetadataunit.md + - docs/models/components/digestregularmetadata.md + - docs/models/components/digesttimedmetadatatype.md + - docs/models/components/digesttimedmetadataunit.md + - docs/models/components/digesttimedmetadata.md + - docs/models/components/monthlytype.md + - docs/models/components/ordinal.md + - docs/models/components/ordinalvalue.md + - docs/models/components/weekdays.md + - docs/models/components/timedconfig.md + - docs/models/components/delayregularmetadatatype.md + - docs/models/components/unit.md + - docs/models/components/delayregularmetadata.md + - docs/models/components/delayscheduledmetadatatype.md + - docs/models/components/delayscheduledmetadata.md + - docs/models/components/preferencechannels.md + - docs/models/components/notificationgroup.md - docs/models/components/messagectatype.md - docs/models/components/messagecta.md + - docs/models/components/messagectadata.md - docs/models/components/messageactionstatus.md - docs/models/components/messageaction.md - docs/models/components/messageactionresultpayload.md @@ -439,147 +432,154 @@ generatedFiles: - docs/models/components/messageactionresult.md - docs/models/components/messagebuttontype.md - docs/models/components/messagebutton.md - - docs/models/components/messagectadata.md - docs/models/components/emailblocktype.md - docs/models/components/emailblock.md - docs/models/components/textalign.md - docs/models/components/emailblockstyles.md - - docs/models/components/markmessageactionasseendtostatus.md - docs/models/components/markmessageactionasseendtopayload.md + - docs/models/components/markmessageactionasseendtostatus.md - docs/models/components/markmessageactionasseendto.md - - docs/models/components/createfeedrequestdto.md - - docs/models/components/createlayoutresponsedto.md - - docs/models/components/getlayoutresponsedtochannel.md - - docs/models/components/variables.md - - docs/models/components/getlayoutresponsedto.md - - docs/models/components/updatelayoutresponsedtochannel.md - - docs/models/components/updatelayoutresponsedtovariables.md - - docs/models/components/updatelayoutresponsedto.md - - docs/models/components/updatelayoutrequestdtovariables.md - - docs/models/components/updatelayoutrequestdto.md - - docs/models/components/deletemessageresponsedtostatus.md - - docs/models/components/deletemessageresponsedto.md - - docs/models/components/filtertopicsresponsedto.md - - docs/models/components/topicdto.md - - docs/models/components/createtopicresponsedto.md - - docs/models/components/createtopicrequestdto.md - - docs/models/components/gettopicresponsedto.md - - docs/models/components/renametopicresponsedto.md - - docs/models/components/renametopicrequestdto.md - - docs/models/components/addsubscribersrequestdto.md - - docs/models/components/topicsubscriberdto.md - - docs/models/components/removesubscribersrequestdto.md - - docs/models/components/gettenantresponsedtodata.md - - docs/models/components/gettenantresponsedto.md + - docs/models/components/unseencountresponse.md + - docs/models/components/updatesubscriberonlineflagrequestdto.md + - docs/models/components/updatesubscriberpreferenceresponsedto.md + - docs/models/components/templateresponse.md + - docs/models/components/preference.md + - docs/models/components/getsubscriberpreferencesresponsedto.md + - docs/models/components/updatesubscriberpreferencerequestdto.md + - docs/models/components/channelpreferencetype.md + - docs/models/components/channelpreference.md + - docs/models/components/updatesubscriberglobalpreferencesrequestdto.md - docs/models/components/createtenantresponsedtodata.md - docs/models/components/createtenantresponsedto.md - docs/models/components/createtenantrequestdtodata.md - docs/models/components/createtenantrequestdto.md + - docs/models/components/gettenantresponsedtodata.md + - docs/models/components/gettenantresponsedto.md - docs/models/components/updatetenantresponsedtodata.md - docs/models/components/updatetenantresponsedto.md - docs/models/components/updatetenantrequestdtodata.md - docs/models/components/updatetenantrequestdto.md + - docs/models/components/createtopicresponsedto.md + - docs/models/components/createtopicrequestdto.md + - docs/models/components/filtertopicsresponsedto.md + - docs/models/components/topicdto.md + - docs/models/components/renametopicresponsedto.md + - docs/models/components/renametopicrequestdto.md + - docs/models/components/gettopicresponsedto.md + - docs/models/components/addsubscribersrequestdto.md + - docs/models/components/removesubscribersrequestdto.md + - docs/models/components/topicsubscriberdto.md + - docs/models/components/createworkflowrequestdtodata.md + - docs/models/components/createworkflowrequestdtonotificationgroup.md + - docs/models/components/createworkflowrequestdto.md + - docs/models/components/workflowsresponsedto.md + - docs/models/components/updateworkflowrequestdtodata.md + - docs/models/components/updateworkflowrequestdto.md + - docs/models/components/system.md + - docs/models/components/translations.md + - docs/models/components/variablesresponsedto.md + - docs/models/components/changeworkflowstatusrequestdto.md - docs/models/components/security.md - - docs/models/operations/organizationcontrollerremoverequest.md - - docs/models/operations/executiondetailscontrollergetexecutiondetailsfornotificationrequest.md - - docs/models/operations/workflowcontrollerlistworkflowsrequest.md - - docs/models/operations/workflowcontrollergetworkflowbyidrequest.md - - docs/models/operations/workflowcontrollerupdateworkflowbyidrequest.md - - docs/models/operations/workflowcontrollerdeleteworkflowbyidrequest.md - - docs/models/operations/workflowcontrollerupdateactivestatusrequest.md + - docs/models/operations/changescontrollerapplydiffrequest.md + - docs/models/operations/changescontrollergetchangesrequest.md - docs/models/operations/eventscontrollercancelrequest.md + - docs/models/operations/executiondetailscontrollergetexecutiondetailsfornotificationrequest.md + - docs/models/operations/feedscontrollerdeletefeedbyidrequest.md + - docs/models/operations/integrationscontrollerremoveintegrationrequest.md + - docs/models/operations/integrationscontrollersetintegrationasprimaryrequest.md + - docs/models/operations/integrationscontrollerupdateintegrationbyidrequest.md + - docs/models/operations/integrationscontrollergetwebhooksupportstatusrequest.md + - docs/models/operations/layoutscontrollerdeletelayoutrequest.md + - docs/models/operations/orderby.md + - docs/models/operations/layoutscontrollerlistlayoutsrequest.md + - docs/models/operations/layoutscontrollergetlayoutrequest.md + - docs/models/operations/layoutscontrollersetdefaultlayoutrequest.md + - docs/models/operations/layoutscontrollerupdatelayoutrequest.md + - docs/models/operations/messagescontrollerdeletemessagerequest.md + - docs/models/operations/channel.md + - docs/models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md + - docs/models/operations/queryparamchannel.md + - docs/models/operations/messagescontrollergetmessagesrequest.md + - docs/models/operations/notificationgroupscontrollerdeletenotificationgrouprequest.md + - docs/models/operations/notificationgroupscontrollergetnotificationgrouprequest.md + - docs/models/operations/notificationgroupscontrollerupdatenotificationgrouprequest.md - docs/models/operations/channels.md - docs/models/operations/notificationscontrollerlistnotificationsrequest.md - docs/models/operations/notificationscontrollergetnotificationrequest.md - docs/models/operations/notificationscontrollergetactivitygraphstatsrequest.md - - docs/models/operations/notificationgroupscontrollergetnotificationgrouprequest.md - - docs/models/operations/notificationgroupscontrollerdeletenotificationgrouprequest.md - - docs/models/operations/notificationgroupscontrollerupdatenotificationgrouprequest.md - - docs/models/operations/integrationscontrollerupdateintegrationbyidrequest.md - - docs/models/operations/integrationscontrollerremoveintegrationrequest.md - - docs/models/operations/integrationscontrollersetintegrationasprimaryrequest.md - - docs/models/operations/integrationscontrollergetwebhooksupportstatusrequest.md - - docs/models/operations/changescontrollergetchangesrequest.md - - docs/models/operations/changescontrollerapplydiffrequest.md + - docs/models/operations/organizationcontrollerremoverequest.md + - docs/models/operations/subscriberscontrollerremovesubscriberrequest.md - docs/models/operations/subscriberscontrollerlistsubscribersrequest.md - docs/models/operations/subscriberscontrollerlistsubscribersresponsebody.md - docs/models/operations/subscriberscontrollerlistsubscribersresponse.md - docs/models/operations/subscriberscontrollergetsubscriberrequest.md - docs/models/operations/subscriberscontrollerupdatesubscriberrequest.md - - docs/models/operations/subscriberscontrollerremovesubscriberrequest.md - - docs/models/operations/subscriberscontrollerupdatesubscriberchannelrequest.md - docs/models/operations/subscriberscontrollermodifysubscriberchannelrequest.md - docs/models/operations/subscriberscontrollerdeletesubscribercredentialsrequest.md + - docs/models/operations/subscriberscontrollerupdatesubscriberchannelrequest.md + - docs/models/operations/subscriberscontrollerchataccessoauthrequest.md + - docs/models/operations/subscriberscontrollerchatoauthcallbackrequest.md + - docs/models/operations/subscriberscontrollerchatoauthcallbackresponsebody.md + - docs/models/operations/subscriberscontrollermarkallunreadasreadrequest.md + - docs/models/operations/subscriberscontrollermarkmessagesasrequest.md + - docs/models/operations/subscriberscontrollermarkactionasseenrequest.md + - docs/models/operations/subscriberscontrollergetnotificationsfeedrequest.md + - docs/models/operations/subscriberscontrollergetnotificationsfeedresponsebody.md + - docs/models/operations/subscriberscontrollergetunseencountrequest.md - docs/models/operations/subscriberscontrollerupdatesubscriberonlineflagrequest.md - docs/models/operations/subscriberscontrollerlistsubscriberpreferencesrequest.md - - docs/models/operations/subscriberscontrollerupdatesubscriberglobalpreferencesrequest.md - docs/models/operations/subscriberscontrollergetsubscriberpreferencebylevelrequest.md - docs/models/operations/subscriberscontrollerupdatesubscriberpreferencerequest.md - - docs/models/operations/subscriberscontrollergetnotificationsfeedrequest.md - - docs/models/operations/subscriberscontrollergetnotificationsfeedresponsebody.md - - docs/models/operations/subscriberscontrollergetunseencountrequest.md - - docs/models/operations/subscriberscontrollermarkmessagesasrequest.md - - docs/models/operations/subscriberscontrollermarkallunreadasreadrequest.md - - docs/models/operations/subscriberscontrollermarkactionasseenrequest.md - - docs/models/operations/subscriberscontrollerchatoauthcallbackrequest.md - - docs/models/operations/subscriberscontrollerchatoauthcallbackresponsebody.md - - docs/models/operations/subscriberscontrollerchataccessoauthrequest.md - - docs/models/operations/feedscontrollerdeletefeedbyidrequest.md - - docs/models/operations/orderby.md - - docs/models/operations/layoutscontrollerlistlayoutsrequest.md - - docs/models/operations/layoutscontrollergetlayoutrequest.md - - docs/models/operations/layoutscontrollerdeletelayoutrequest.md - - docs/models/operations/layoutscontrollerupdatelayoutrequest.md - - docs/models/operations/layoutscontrollersetdefaultlayoutrequest.md - - docs/models/operations/channel.md - - docs/models/operations/messagescontrollergetmessagesrequest.md - - docs/models/operations/messagescontrollerdeletemessagerequest.md - - docs/models/operations/queryparamchannel.md - - docs/models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md - - docs/models/operations/topicscontrollerlisttopicsrequest.md - - docs/models/operations/topicscontrollergettopicrequest.md - - docs/models/operations/topicscontrollerdeletetopicrequest.md - - docs/models/operations/topicscontrollerrenametopicrequest.md - - docs/models/operations/topicscontrolleraddsubscribersrequest.md - - docs/models/operations/topicscontrollergettopicsubscriberrequest.md - - docs/models/operations/topicscontrollerremovesubscribersrequest.md + - docs/models/operations/subscriberscontrollerupdatesubscriberglobalpreferencesrequest.md + - docs/models/operations/tenantcontrollerremovetenantrequest.md - docs/models/operations/tenantcontrollerlisttenantsrequest.md - docs/models/operations/tenantcontrollerlisttenantsresponsebody.md - docs/models/operations/tenantcontrollerlisttenantsresponse.md - docs/models/operations/tenantcontrollergettenantbyidrequest.md - - docs/models/operations/tenantcontrollerremovetenantrequest.md - docs/models/operations/tenantcontrollerupdatetenantrequest.md + - docs/models/operations/topicscontrollerdeletetopicrequest.md + - docs/models/operations/topicscontrollerlisttopicsrequest.md + - docs/models/operations/topicscontrollerrenametopicrequest.md + - docs/models/operations/topicscontrollergettopicrequest.md + - docs/models/operations/topicscontrolleraddsubscribersrequest.md + - docs/models/operations/topicscontrollerremovesubscribersrequest.md + - docs/models/operations/topicscontrollergettopicsubscriberrequest.md + - docs/models/operations/workflowcontrollerdeleteworkflowbyidrequest.md + - docs/models/operations/workflowcontrollerlistworkflowsrequest.md + - docs/models/operations/workflowcontrollergetworkflowbyidrequest.md + - docs/models/operations/workflowcontrollerupdateworkflowbyidrequest.md + - docs/models/operations/workflowcontrollerupdateactivestatusrequest.md - docs/sdks/novu/README.md - docs/lib/utils/retryconfig.md - - docs/sdks/organizations/README.md - - docs/sdks/members/README.md - - docs/sdks/branding/README.md + - docs/sdks/changes/README.md - docs/sdks/environments/README.md - docs/sdks/apikeys/README.md - - docs/sdks/executiondetails/README.md - - docs/sdks/workflows/README.md - - docs/sdks/variables/README.md - - docs/sdks/status/README.md - docs/sdks/events/README.md - - docs/sdks/notifications/README.md - - docs/sdks/stats/README.md - - docs/sdks/workflowgroups/README.md + - docs/sdks/executiondetails/README.md + - docs/sdks/feeds/README.md - docs/sdks/integrations/README.md - docs/sdks/webhooks/README.md - - docs/sdks/changes/README.md + - docs/sdks/layouts/README.md + - docs/sdks/messages/README.md + - docs/sdks/workflowgroups/README.md + - docs/sdks/notifications/README.md + - docs/sdks/stats/README.md + - docs/sdks/organizations/README.md + - docs/sdks/branding/README.md + - docs/sdks/members/README.md - docs/sdks/subscribers/README.md - docs/sdks/credentials/README.md + - docs/sdks/authentication/README.md + - docs/sdks/novumessages/README.md + - docs/sdks/novunotifications/README.md - docs/sdks/properties/README.md - docs/sdks/preferences/README.md - - docs/sdks/novunotifications/README.md - - docs/sdks/novumessages/README.md - - docs/sdks/authentication/README.md - - docs/sdks/feeds/README.md - - docs/sdks/layouts/README.md - - docs/sdks/messages/README.md + - docs/sdks/tenants/README.md - docs/sdks/topics/README.md - docs/sdks/novusubscribers/README.md - - docs/sdks/tenants/README.md + - docs/sdks/workflows/README.md + - docs/sdks/variables/README.md + - docs/sdks/status/README.md - USAGE.md - .gitattributes - src/hooks/hooks.ts diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index a8bc20db..0d95d9d1 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -1,7 +1,6 @@ configVersion: 2.0.0 generation: sdkClassName: Novu - maintainOpenAPIOrder: false usageSnippets: optionalPropertyRendering: withExample useClassNamesForArrayFields: true @@ -12,7 +11,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false typescript: - version: 0.0.1-alpha.1 + version: 0.0.1-alpha.2 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 763e0067..d639dfb7 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,17 +1,17 @@ -speakeasyVersion: 1.308.0 +speakeasyVersion: 1.308.1 sources: json-development: sourceNamespace: json-development - sourceRevisionDigest: sha256:dbb34fad20704425aa5f3bebd44c342a26ec51304ca8f3e42ec4fee1864b3ae6 - sourceBlobDigest: sha256:a1a2c7e9a5d6f2b7ed85c22c521d573f7bf43259dc66e1a2d7fc0cdb64ee1358 + sourceRevisionDigest: sha256:5dce7a6bba8b99f7be22ce80c2bb074e61aac4a930cdd1139124d2fb72166852 + sourceBlobDigest: sha256:8bfbf39247b9510f916783be29abd7f814f07787477ae0c10816a5219a97ecf9 tags: - latest targets: my-first-target: source: json-development sourceNamespace: json-development - sourceRevisionDigest: sha256:dbb34fad20704425aa5f3bebd44c342a26ec51304ca8f3e42ec4fee1864b3ae6 - sourceBlobDigest: sha256:a1a2c7e9a5d6f2b7ed85c22c521d573f7bf43259dc66e1a2d7fc0cdb64ee1358 + sourceRevisionDigest: sha256:5dce7a6bba8b99f7be22ce80c2bb074e61aac4a930cdd1139124d2fb72166852 + sourceBlobDigest: sha256:8bfbf39247b9510f916783be29abd7f814f07787477ae0c10816a5219a97ecf9 outLocation: /Users/galtidhar/Documents/GitHub/novu-ts-sdk workflow: workflowVersion: 1.0.0 @@ -19,9 +19,9 @@ workflow: sources: json-development: inputs: - - location: http://127.0.0.1:3000/openapi.sdk.json + - location: ./sources/openapi.sdk.json overlays: - - location: /Users/galtidhar/WebstormProjects/novu-sdk/sources/remove-headers-overlay.yaml + - location: ./sources/remove-headers-overlay.yaml registry: location: registry.speakeasyapi.dev/novu/novu/json-development targets: diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml index 5a4a88f5..aa0cb511 100644 --- a/.speakeasy/workflow.yaml +++ b/.speakeasy/workflow.yaml @@ -3,9 +3,10 @@ speakeasyVersion: latest sources: json-development: inputs: - - location: http://127.0.0.1:3000/openapi.sdk.json +# - location: http://api.novu.co/openapi.sdk.json + - location: ./sources/openapi.sdk.json overlays: - - location: /Users/galtidhar/WebstormProjects/novu-sdk/sources/remove-headers-overlay.yaml + - location: ./sources/remove-headers-overlay.yaml registry: location: registry.speakeasyapi.dev/novu/novu/json-development targets: diff --git a/README.md b/README.md index cd40031e..91d0380d 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,8 @@ const novu = new Novu({ async function run() { const result = await novu.events.trigger({ name: "workflow_identifier", - payload: {}, overrides: {}, + payload: {}, to: [ { topicKey: "topic_key", @@ -68,58 +68,75 @@ run(); ## Available Resources and Operations -### [organizations](docs/sdks/organizations/README.md) - -* [list](docs/sdks/organizations/README.md#list) - Fetch all organizations -* [create](docs/sdks/organizations/README.md#create) - Create an organization -* [rename](docs/sdks/organizations/README.md#rename) - Rename organization name -* [retrieve](docs/sdks/organizations/README.md#retrieve) - Fetch current organization details - -### [organizations.members](docs/sdks/members/README.md) - -* [delete](docs/sdks/members/README.md#delete) - Remove a member from organization using memberId -* [list](docs/sdks/members/README.md#list) - Fetch all members of current organizations - -### [organizations.branding](docs/sdks/branding/README.md) +### [changes](docs/sdks/changes/README.md) -* [update](docs/sdks/branding/README.md#update) - Update organization branding details +* [apply](docs/sdks/changes/README.md#apply) - Apply change +* [applyBulk](docs/sdks/changes/README.md#applybulk) - Apply changes +* [count](docs/sdks/changes/README.md#count) - Get changes count +* [retrieve](docs/sdks/changes/README.md#retrieve) - Get changes ### [environments](docs/sdks/environments/README.md) -* [retrieve](docs/sdks/environments/README.md#retrieve) - Get current environment * [list](docs/sdks/environments/README.md#list) - Get environments +* [retrieve](docs/sdks/environments/README.md#retrieve) - Get current environment ### [environments.apiKeys](docs/sdks/apikeys/README.md) * [list](docs/sdks/apikeys/README.md#list) - Get api keys * [regenerate](docs/sdks/apikeys/README.md#regenerate) - Regenerate api keys +### [events](docs/sdks/events/README.md) + +* [cancel](docs/sdks/events/README.md#cancel) - Cancel triggered event +* [trigger](docs/sdks/events/README.md#trigger) - Trigger event +* [triggerBroadcast](docs/sdks/events/README.md#triggerbroadcast) - Broadcast event to all +* [triggerBulk](docs/sdks/events/README.md#triggerbulk) - Bulk trigger event + ### [executionDetails](docs/sdks/executiondetails/README.md) * [retrieve](docs/sdks/executiondetails/README.md#retrieve) - Get execution details -### [workflows](docs/sdks/workflows/README.md) +### [feeds](docs/sdks/feeds/README.md) -* [list](docs/sdks/workflows/README.md#list) - Get workflows -* [create](docs/sdks/workflows/README.md#create) - Create workflow -* [retrieve](docs/sdks/workflows/README.md#retrieve) - Get workflow -* [update](docs/sdks/workflows/README.md#update) - Update workflow -* [delete](docs/sdks/workflows/README.md#delete) - Delete workflow +* [create](docs/sdks/feeds/README.md#create) - Create feed +* [delete](docs/sdks/feeds/README.md#delete) - Delete feed +* [retrieve](docs/sdks/feeds/README.md#retrieve) - Get feeds -### [workflows.variables](docs/sdks/variables/README.md) +### [integrations](docs/sdks/integrations/README.md) -* [retrieve](docs/sdks/variables/README.md#retrieve) - Get available variables +* [create](docs/sdks/integrations/README.md#create) - Create integration +* [delete](docs/sdks/integrations/README.md#delete) - Delete integration +* [list](docs/sdks/integrations/README.md#list) - Get integrations +* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations +* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary +* [update](docs/sdks/integrations/README.md#update) - Update integration -### [workflows.status](docs/sdks/status/README.md) +### [integrations.webhooks](docs/sdks/webhooks/README.md) -* [update](docs/sdks/status/README.md#update) - Update workflow status +* [retrieve](docs/sdks/webhooks/README.md#retrieve) - Get webhook support status for provider -### [events](docs/sdks/events/README.md) +### [layouts](docs/sdks/layouts/README.md) -* [trigger](docs/sdks/events/README.md#trigger) - Trigger event -* [triggerBulk](docs/sdks/events/README.md#triggerbulk) - Bulk trigger event -* [triggerBroadcast](docs/sdks/events/README.md#triggerbroadcast) - Broadcast event to all -* [cancel](docs/sdks/events/README.md#cancel) - Cancel triggered event +* [create](docs/sdks/layouts/README.md#create) - Layout creation +* [delete](docs/sdks/layouts/README.md#delete) - Delete layout +* [list](docs/sdks/layouts/README.md#list) - Filter layouts +* [retrieve](docs/sdks/layouts/README.md#retrieve) - Get layout +* [setAsDefault](docs/sdks/layouts/README.md#setasdefault) - Set default layout +* [update](docs/sdks/layouts/README.md#update) - Update a layout + +### [messages](docs/sdks/messages/README.md) + +* [delete](docs/sdks/messages/README.md#delete) - Delete message +* [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId +* [retrieve](docs/sdks/messages/README.md#retrieve) - Get messages + +### [workflowGroups](docs/sdks/workflowgroups/README.md) + +* [create](docs/sdks/workflowgroups/README.md#create) - Create workflow group +* [delete](docs/sdks/workflowgroups/README.md#delete) - Delete workflow group +* [list](docs/sdks/workflowgroups/README.md#list) - Get workflow groups +* [retrieve](docs/sdks/workflowgroups/README.md#retrieve) - Get workflow group +* [update](docs/sdks/workflowgroups/README.md#update) - Update workflow group ### [notifications](docs/sdks/notifications/README.md) @@ -128,121 +145,104 @@ run(); ### [notifications.stats](docs/sdks/stats/README.md) -* [retrieve](docs/sdks/stats/README.md#retrieve) - Get notification statistics * [graph](docs/sdks/stats/README.md#graph) - Get notification graph statistics +* [retrieve](docs/sdks/stats/README.md#retrieve) - Get notification statistics -### [workflowGroups](docs/sdks/workflowgroups/README.md) - -* [list](docs/sdks/workflowgroups/README.md#list) - Get workflow groups -* [create](docs/sdks/workflowgroups/README.md#create) - Create workflow group -* [retrieve](docs/sdks/workflowgroups/README.md#retrieve) - Get workflow group -* [delete](docs/sdks/workflowgroups/README.md#delete) - Delete workflow group -* [update](docs/sdks/workflowgroups/README.md#update) - Update workflow group - -### [integrations](docs/sdks/integrations/README.md) +### [organizations](docs/sdks/organizations/README.md) -* [list](docs/sdks/integrations/README.md#list) - Get integrations -* [create](docs/sdks/integrations/README.md#create) - Create integration -* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations -* [update](docs/sdks/integrations/README.md#update) - Update integration -* [delete](docs/sdks/integrations/README.md#delete) - Delete integration -* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary +* [create](docs/sdks/organizations/README.md#create) - Create an organization +* [list](docs/sdks/organizations/README.md#list) - Fetch all organizations +* [rename](docs/sdks/organizations/README.md#rename) - Rename organization name +* [retrieve](docs/sdks/organizations/README.md#retrieve) - Fetch current organization details -### [integrations.webhooks](docs/sdks/webhooks/README.md) +### [organizations.branding](docs/sdks/branding/README.md) -* [retrieve](docs/sdks/webhooks/README.md#retrieve) - Get webhook support status for provider +* [update](docs/sdks/branding/README.md#update) - Update organization branding details -### [changes](docs/sdks/changes/README.md) +### [organizations.members](docs/sdks/members/README.md) -* [retrieve](docs/sdks/changes/README.md#retrieve) - Get changes -* [count](docs/sdks/changes/README.md#count) - Get changes count -* [applyBulk](docs/sdks/changes/README.md#applybulk) - Apply changes -* [apply](docs/sdks/changes/README.md#apply) - Apply change +* [delete](docs/sdks/members/README.md#delete) - Remove a member from organization using memberId +* [list](docs/sdks/members/README.md#list) - Fetch all members of current organizations ### [subscribers](docs/sdks/subscribers/README.md) -* [list](docs/sdks/subscribers/README.md#list) - Get subscribers * [create](docs/sdks/subscribers/README.md#create) - Create subscriber +* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers +* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber +* [list](docs/sdks/subscribers/README.md#list) - Get subscribers * [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber * [update](docs/sdks/subscribers/README.md#update) - Update subscriber -* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber -* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers ### [subscribers.credentials](docs/sdks/credentials/README.md) -* [update](docs/sdks/credentials/README.md#update) - Update subscriber credentials * [append](docs/sdks/credentials/README.md#append) - Modify subscriber credentials * [delete](docs/sdks/credentials/README.md#delete) - Delete subscriber credentials by providerId +* [update](docs/sdks/credentials/README.md#update) - Update subscriber credentials -### [subscribers.properties](docs/sdks/properties/README.md) - -* [updateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status - -### [subscribers.preferences](docs/sdks/preferences/README.md) - -* [list](docs/sdks/preferences/README.md#list) - Get subscriber preferences -* [updateGlobal](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences -* [retrieveByLevel](docs/sdks/preferences/README.md#retrievebylevel) - Get subscriber preferences by level -* [update](docs/sdks/preferences/README.md#update) - Update subscriber preference - -### [subscribers.notifications](docs/sdks/novunotifications/README.md) +### [subscribers.authentication](docs/sdks/authentication/README.md) -* [retrieve](docs/sdks/novunotifications/README.md#retrieve) - Get in-app notification feed for a particular subscriber -* [unseenCount](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed +* [chatAccessOauth](docs/sdks/authentication/README.md#chataccessoauth) - Handle chat oauth +* [chatAccessOauthCallBack](docs/sdks/authentication/README.md#chataccessoauthcallback) - Handle providers oauth redirect ### [subscribers.messages](docs/sdks/novumessages/README.md) -* [markAllAs](docs/sdks/novumessages/README.md#markallas) - Mark a subscriber messages as seen, read, unseen or unread * [markAll](docs/sdks/novumessages/README.md#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed. +* [markAllAs](docs/sdks/novumessages/README.md#markallas) - Mark a subscriber messages as seen, read, unseen or unread * [updateAsSeen](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen -### [subscribers.authentication](docs/sdks/authentication/README.md) +### [subscribers.notifications](docs/sdks/novunotifications/README.md) -* [chatAccessOauthCallBack](docs/sdks/authentication/README.md#chataccessoauthcallback) - Handle providers oauth redirect -* [chatAccessOauth](docs/sdks/authentication/README.md#chataccessoauth) - Handle chat oauth +* [retrieve](docs/sdks/novunotifications/README.md#retrieve) - Get in-app notification feed for a particular subscriber +* [unseenCount](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed -### [feeds](docs/sdks/feeds/README.md) +### [subscribers.properties](docs/sdks/properties/README.md) -* [retrieve](docs/sdks/feeds/README.md#retrieve) - Get feeds -* [create](docs/sdks/feeds/README.md#create) - Create feed -* [delete](docs/sdks/feeds/README.md#delete) - Delete feed +* [updateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status -### [layouts](docs/sdks/layouts/README.md) +### [subscribers.preferences](docs/sdks/preferences/README.md) -* [list](docs/sdks/layouts/README.md#list) - Filter layouts -* [create](docs/sdks/layouts/README.md#create) - Layout creation -* [retrieve](docs/sdks/layouts/README.md#retrieve) - Get layout -* [delete](docs/sdks/layouts/README.md#delete) - Delete layout -* [update](docs/sdks/layouts/README.md#update) - Update a layout -* [setAsDefault](docs/sdks/layouts/README.md#setasdefault) - Set default layout +* [list](docs/sdks/preferences/README.md#list) - Get subscriber preferences +* [retrieveByLevel](docs/sdks/preferences/README.md#retrievebylevel) - Get subscriber preferences by level +* [update](docs/sdks/preferences/README.md#update) - Update subscriber preference +* [updateGlobal](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences -### [messages](docs/sdks/messages/README.md) +### [tenants](docs/sdks/tenants/README.md) -* [retrieve](docs/sdks/messages/README.md#retrieve) - Get messages -* [delete](docs/sdks/messages/README.md#delete) - Delete message -* [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId +* [create](docs/sdks/tenants/README.md#create) - Create tenant +* [delete](docs/sdks/tenants/README.md#delete) - Delete tenant +* [list](docs/sdks/tenants/README.md#list) - Get tenants +* [retrieve](docs/sdks/tenants/README.md#retrieve) - Get tenant +* [update](docs/sdks/tenants/README.md#update) - Update tenant ### [topics](docs/sdks/topics/README.md) -* [list](docs/sdks/topics/README.md#list) - Filter topics * [create](docs/sdks/topics/README.md#create) - Topic creation -* [retrieve](docs/sdks/topics/README.md#retrieve) - Get topic * [delete](docs/sdks/topics/README.md#delete) - Delete topic +* [list](docs/sdks/topics/README.md#list) - Filter topics * [rename](docs/sdks/topics/README.md#rename) - Rename a topic +* [retrieve](docs/sdks/topics/README.md#retrieve) - Get topic ### [topics.subscribers](docs/sdks/novusubscribers/README.md) * [assign](docs/sdks/novusubscribers/README.md#assign) - Subscribers addition -* [retrieve](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber * [delete](docs/sdks/novusubscribers/README.md#delete) - Subscribers removal +* [retrieve](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber -### [tenants](docs/sdks/tenants/README.md) +### [workflows](docs/sdks/workflows/README.md) -* [list](docs/sdks/tenants/README.md#list) - Get tenants -* [create](docs/sdks/tenants/README.md#create) - Create tenant -* [retrieve](docs/sdks/tenants/README.md#retrieve) - Get tenant -* [delete](docs/sdks/tenants/README.md#delete) - Delete tenant -* [update](docs/sdks/tenants/README.md#update) - Update tenant +* [create](docs/sdks/workflows/README.md#create) - Create workflow +* [delete](docs/sdks/workflows/README.md#delete) - Delete workflow +* [list](docs/sdks/workflows/README.md#list) - Get workflows +* [retrieve](docs/sdks/workflows/README.md#retrieve) - Get workflow +* [update](docs/sdks/workflows/README.md#update) - Update workflow + +### [workflows.variables](docs/sdks/variables/README.md) + +* [retrieve](docs/sdks/variables/README.md#retrieve) - Get available variables + +### [workflows.status](docs/sdks/status/README.md) + +* [update](docs/sdks/status/README.md#update) - Update workflow status @@ -300,7 +300,7 @@ const novu = new Novu({ async function run() { let result; try { - result = await novu.organizations.list(); + result = await novu.changes.apply(""); } catch (err) { switch (true) { case err instanceof errors.SDKValidationError: { @@ -346,7 +346,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.organizations.list(); + const result = await novu.changes.apply(""); // Handle the result console.log(result); @@ -370,7 +370,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.organizations.list(); + const result = await novu.changes.apply(""); // Handle the result console.log(result); @@ -450,7 +450,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.organizations.list(); + const result = await novu.changes.apply(""); // Handle the result console.log(result); @@ -475,7 +475,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.organizations.list({ + const result = await novu.changes.apply("", { retries: { strategy: "backoff", backoff: { @@ -515,7 +515,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.organizations.list(); + const result = await novu.changes.apply(""); // Handle the result console.log(result); diff --git a/RELEASES.md b/RELEASES.md deleted file mode 100644 index 63047635..00000000 --- a/RELEASES.md +++ /dev/null @@ -1,17 +0,0 @@ -# Releases - -## [0.24.0-alpha.0](https://github.com/novuhq/novu/releases/tag/0.24.0-alpha.0) - 2024-06-14 - -### Highlights - -- **Alpha Release**: This is the first alpha release of the Novu TypeScript SDK, featuring new and improved functionality. - -### Bug Fixes - -### Improvements - -- **Improved Error Messages In The Workflow Editor**: We have improved the error icons and states for each node in the workflow, when no provider is connected or not configured - -### Known Issues - -- **Migration Required**: To upgrade to this new version, you will need to follow the migration steps provided in the release notes. \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 7ade9457..37fa3e94 100644 --- a/USAGE.md +++ b/USAGE.md @@ -12,8 +12,8 @@ const novu = new Novu({ async function run() { const result = await novu.events.trigger({ name: "workflow_identifier", - payload: {}, overrides: {}, + payload: {}, to: [ { topicKey: "topic_key", diff --git a/docs/models/components/activitiesresponsedto.md b/docs/models/components/activitiesresponsedto.md index 1634aa32..6869d885 100644 --- a/docs/models/components/activitiesresponsedto.md +++ b/docs/models/components/activitiesresponsedto.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `hasMore` | *boolean* | :heavy_check_mark: | N/A | | `data` | [components.ActivityNotificationResponseDto](../../models/components/activitynotificationresponsedto.md)[] | :heavy_check_mark: | N/A | -| `pageSize` | *number* | :heavy_check_mark: | N/A | -| `page` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `hasMore` | *boolean* | :heavy_check_mark: | N/A | +| `page` | *number* | :heavy_check_mark: | N/A | +| `pageSize` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/activitygraphstatesresponse.md b/docs/models/components/activitygraphstatesresponse.md index 98f24403..93669149 100644 --- a/docs/models/components/activitygraphstatesresponse.md +++ b/docs/models/components/activitygraphstatesresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | -| `count` | *number* | :heavy_check_mark: | N/A | -| `templates` | *string*[] | :heavy_check_mark: | N/A | -| `channels` | [components.ActivityGraphStatesResponseChannels](../../models/components/activitygraphstatesresponsechannels.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | N/A | +| `channels` | [components.Channels](../../models/components/channels.md)[] | :heavy_check_mark: | N/A | +| `count` | *number* | :heavy_check_mark: | N/A | +| `templates` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/activitygraphstatesresponsechannels.md b/docs/models/components/activitygraphstatesresponsechannels.md deleted file mode 100644 index 96388344..00000000 --- a/docs/models/components/activitygraphstatesresponsechannels.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActivityGraphStatesResponseChannels - - -## Values - -| Name | Value | -| ------- | ------- | -| `InApp` | in_app | -| `Email` | email | -| `Sms` | sms | -| `Chat` | chat | -| `Push` | push | \ No newline at end of file diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedto.md b/docs/models/components/activitynotificationexecutiondetailresponsedto.md index 63785859..6446a8d7 100644 --- a/docs/models/components/activitynotificationexecutiondetailresponsedto.md +++ b/docs/models/components/activitynotificationexecutiondetailresponsedto.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `jobId` | *string* | :heavy_check_mark: | N/A | -| `status` | [components.ActivityNotificationExecutionDetailResponseDtoStatus](../../models/components/activitynotificationexecutiondetailresponsedtostatus.md) | :heavy_check_mark: | N/A | -| `detail` | *string* | :heavy_check_mark: | N/A | -| `isRetry` | *boolean* | :heavy_check_mark: | N/A | -| `isTest` | *boolean* | :heavy_check_mark: | N/A | -| `providerId` | [components.ActivityNotificationExecutionDetailResponseDtoProviderId](../../models/components/activitynotificationexecutiondetailresponsedtoproviderid.md) | :heavy_check_mark: | N/A | -| `raw` | *string* | :heavy_minus_sign: | N/A | -| `source` | [components.ActivityNotificationExecutionDetailResponseDtoSource](../../models/components/activitynotificationexecutiondetailresponsedtosource.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | N/A | +| `jobId` | *string* | :heavy_check_mark: | N/A | +| `detail` | *string* | :heavy_check_mark: | N/A | +| `isRetry` | *boolean* | :heavy_check_mark: | N/A | +| `isTest` | *boolean* | :heavy_check_mark: | N/A | +| `providerId` | [components.ProviderId](../../models/components/providerid.md) | :heavy_check_mark: | N/A | +| `raw` | *string* | :heavy_minus_sign: | N/A | +| `source` | [components.Source](../../models/components/source.md) | :heavy_check_mark: | N/A | +| `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedtoproviderid.md b/docs/models/components/activitynotificationexecutiondetailresponsedtoproviderid.md deleted file mode 100644 index bd132fc7..00000000 --- a/docs/models/components/activitynotificationexecutiondetailresponsedtoproviderid.md +++ /dev/null @@ -1,7 +0,0 @@ -# ActivityNotificationExecutionDetailResponseDtoProviderId - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedtosource.md b/docs/models/components/activitynotificationexecutiondetailresponsedtosource.md deleted file mode 100644 index 94f16442..00000000 --- a/docs/models/components/activitynotificationexecutiondetailresponsedtosource.md +++ /dev/null @@ -1,11 +0,0 @@ -# ActivityNotificationExecutionDetailResponseDtoSource - - -## Values - -| Name | Value | -| ------------- | ------------- | -| `Credentials` | Credentials | -| `Internal` | Internal | -| `Payload` | Payload | -| `Webhook` | Webhook | \ No newline at end of file diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedtostatus.md b/docs/models/components/activitynotificationexecutiondetailresponsedtostatus.md deleted file mode 100644 index 57ba1a13..00000000 --- a/docs/models/components/activitynotificationexecutiondetailresponsedtostatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActivityNotificationExecutionDetailResponseDtoStatus - - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `Success` | Success | -| `Warning` | Warning | -| `Failed` | Failed | -| `Pending` | Pending | -| `Queued` | Queued | -| `ReadConfirmation` | ReadConfirmation | \ No newline at end of file diff --git a/docs/models/components/activitynotificationjobresponsedto.md b/docs/models/components/activitynotificationjobresponsedto.md index c2d2d58b..26acb2eb 100644 --- a/docs/models/components/activitynotificationjobresponsedto.md +++ b/docs/models/components/activitynotificationjobresponsedto.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | | `digest` | [components.Digest](../../models/components/digest.md) | :heavy_minus_sign: | N/A | | `executionDetails` | [components.ActivityNotificationExecutionDetailResponseDto](../../models/components/activitynotificationexecutiondetailresponsedto.md)[] | :heavy_check_mark: | N/A | -| `step` | [components.ActivityNotificationStepResponseDto](../../models/components/activitynotificationstepresponsedto.md) | :heavy_check_mark: | N/A | -| `payload` | [components.ActivityNotificationJobResponseDtoPayload](../../models/components/activitynotificationjobresponsedtopayload.md) | :heavy_minus_sign: | N/A | +| `payload` | [components.Payload](../../models/components/payload.md) | :heavy_minus_sign: | N/A | | `providerId` | [components.ActivityNotificationJobResponseDtoProviderId](../../models/components/activitynotificationjobresponsedtoproviderid.md) | :heavy_check_mark: | N/A | -| `status` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `status` | *string* | :heavy_check_mark: | N/A | +| `step` | [components.ActivityNotificationStepResponseDto](../../models/components/activitynotificationstepresponsedto.md) | :heavy_check_mark: | N/A | +| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/activitynotificationjobresponsedtopayload.md b/docs/models/components/activitynotificationjobresponsedtopayload.md deleted file mode 100644 index 71a464a3..00000000 --- a/docs/models/components/activitynotificationjobresponsedtopayload.md +++ /dev/null @@ -1,7 +0,0 @@ -# ActivityNotificationJobResponseDtoPayload - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/activitynotificationresponsedto.md b/docs/models/components/activitynotificationresponsedto.md index 6625aea0..7451041d 100644 --- a/docs/models/components/activitynotificationresponsedto.md +++ b/docs/models/components/activitynotificationresponsedto.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | | `environmentId` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `transactionId` | *string* | :heavy_check_mark: | N/A | +| `channels` | [components.ActivityNotificationResponseDtoChannels](../../models/components/activitynotificationresponsedtochannels.md) | :heavy_minus_sign: | N/A | | `createdAt` | *string* | :heavy_minus_sign: | N/A | -| `channels` | [components.Channels](../../models/components/channels.md) | :heavy_minus_sign: | N/A | +| `jobs` | [components.ActivityNotificationJobResponseDto](../../models/components/activitynotificationjobresponsedto.md)[] | :heavy_minus_sign: | N/A | | `subscriber` | [components.ActivityNotificationSubscriberResponseDto](../../models/components/activitynotificationsubscriberresponsedto.md) | :heavy_minus_sign: | N/A | | `template` | [components.ActivityNotificationTemplateResponseDto](../../models/components/activitynotificationtemplateresponsedto.md) | :heavy_minus_sign: | N/A | -| `jobs` | [components.ActivityNotificationJobResponseDto](../../models/components/activitynotificationjobresponsedto.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `transactionId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/activitynotificationsubscriberresponsedto.md b/docs/models/components/activitynotificationsubscriberresponsedto.md index 1e9bd407..4fd5323e 100644 --- a/docs/models/components/activitynotificationsubscriberresponsedto.md +++ b/docs/models/components/activitynotificationsubscriberresponsedto.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `firstName` | *string* | :heavy_minus_sign: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | -| `lastName` | *string* | :heavy_minus_sign: | N/A | | `email` | *string* | :heavy_minus_sign: | N/A | +| `firstName` | *string* | :heavy_minus_sign: | N/A | +| `lastName` | *string* | :heavy_minus_sign: | N/A | | `phone` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/activitystatsresponsedto.md b/docs/models/components/activitystatsresponsedto.md index 27a46eb1..234c47bc 100644 --- a/docs/models/components/activitystatsresponsedto.md +++ b/docs/models/components/activitystatsresponsedto.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `weeklySent` | *number* | :heavy_check_mark: | N/A | -| `monthlySent` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `monthlySent` | *number* | :heavy_check_mark: | N/A | +| `weeklySent` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/apikey.md b/docs/models/components/apikey.md index 43cdc7e6..cb6ad09e 100644 --- a/docs/models/components/apikey.md +++ b/docs/models/components/apikey.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `key` | *string* | :heavy_check_mark: | N/A | -| `userId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `userId` | *string* | :heavy_check_mark: | N/A | +| `key` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/changeresponsedto.md b/docs/models/components/changeresponsedto.md index 3ee5de72..95ee3d48 100644 --- a/docs/models/components/changeresponsedto.md +++ b/docs/models/components/changeresponsedto.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `creatorId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | -| `entityId` | *string* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_check_mark: | N/A | -| `type` | [components.ChangeResponseDtoType](../../models/components/changeresponsedtotype.md) | :heavy_check_mark: | N/A | -| `change` | [components.Change](../../models/components/change.md) | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `parentId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `creatorId` | *string* | :heavy_check_mark: | N/A | +| `entityId` | *string* | :heavy_check_mark: | N/A | +| `environmentId` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | +| `parentId` | *string* | :heavy_minus_sign: | N/A | +| `change` | [components.Change](../../models/components/change.md) | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `enabled` | *boolean* | :heavy_check_mark: | N/A | +| `type` | [components.Type](../../models/components/type.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/changeresponsedtotype.md b/docs/models/components/changeresponsedtotype.md deleted file mode 100644 index cc4a8042..00000000 --- a/docs/models/components/changeresponsedtotype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ChangeResponseDtoType - - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `Feed` | Feed | -| `MessageTemplate` | MessageTemplate | -| `Layout` | Layout | -| `DefaultLayout` | DefaultLayout | -| `NotificationTemplate` | NotificationTemplate | -| `NotificationGroup` | NotificationGroup | -| `TranslationGroup` | TranslationGroup | -| `Translation` | Translation | \ No newline at end of file diff --git a/docs/models/components/changesresponsedto.md b/docs/models/components/changesresponsedto.md index 9ceb5345..5cd9e350 100644 --- a/docs/models/components/changesresponsedto.md +++ b/docs/models/components/changesresponsedto.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `totalCount` | *number* | :heavy_check_mark: | N/A | | `data` | [components.ChangeResponseDto](../../models/components/changeresponsedto.md)[] | :heavy_check_mark: | N/A | +| `page` | *number* | :heavy_check_mark: | N/A | | `pageSize` | *number* | :heavy_check_mark: | N/A | -| `page` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/channel.md b/docs/models/components/channel.md index 572a52de..e94defd2 100644 --- a/docs/models/components/channel.md +++ b/docs/models/components/channel.md @@ -3,14 +3,10 @@ ## Values -| Name | Value | -| --------- | --------- | -| `InApp` | in_app | -| `Email` | email | -| `Sms` | sms | -| `Chat` | chat | -| `Push` | push | -| `Digest` | digest | -| `Trigger` | trigger | -| `Delay` | delay | -| `Custom` | custom | \ No newline at end of file +| Name | Value | +| ------- | ------- | +| `InApp` | in_app | +| `Email` | email | +| `Sms` | sms | +| `Chat` | chat | +| `Push` | push | \ No newline at end of file diff --git a/docs/models/components/channelcredentials.md b/docs/models/components/channelcredentials.md index 1e4cefe6..179a9bc5 100644 --- a/docs/models/components/channelcredentials.md +++ b/docs/models/components/channelcredentials.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `webhookUrl` | *string* | :heavy_check_mark: | Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider. | +| `alertUid` | *string* | :heavy_minus_sign: | alert_uid for grafana on-call webhook payload | | `channel` | *string* | :heavy_minus_sign: | Channel specification for Mattermost chat notifications | | `deviceTokens` | *string*[] | :heavy_minus_sign: | Contains an array of the subscriber device tokens for a given provider. Used on Push integrations | -| `alertUid` | *string* | :heavy_minus_sign: | alert_uid for grafana on-call webhook payload | -| `title` | *string* | :heavy_minus_sign: | title to be used with grafana on call webhook | +| `externalUrl` | *string* | :heavy_minus_sign: | link_to_upstream_details property fo grafana on call webhook | | `imageUrl` | *string* | :heavy_minus_sign: | image_url property fo grafana on call webhook | | `state` | *string* | :heavy_minus_sign: | state property fo grafana on call webhook | -| `externalUrl` | *string* | :heavy_minus_sign: | link_to_upstream_details property fo grafana on call webhook | \ No newline at end of file +| `title` | *string* | :heavy_minus_sign: | title to be used with grafana on call webhook | +| `webhookUrl` | *string* | :heavy_check_mark: | Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider. | \ No newline at end of file diff --git a/docs/models/components/channelcredentialsdto.md b/docs/models/components/channelcredentialsdto.md index 4c4cdb82..c4592324 100644 --- a/docs/models/components/channelcredentialsdto.md +++ b/docs/models/components/channelcredentialsdto.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `webhookUrl` | *string* | :heavy_minus_sign: | N/A | -| `deviceTokens` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `deviceTokens` | *string*[] | :heavy_minus_sign: | N/A | +| `webhookUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/channelpreference.md b/docs/models/components/channelpreference.md index 7f2b31d0..cd367447 100644 --- a/docs/models/components/channelpreference.md +++ b/docs/models/components/channelpreference.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.ChannelPreferenceType](../../models/components/channelpreferencetype.md) | :heavy_check_mark: | The type of channel that is enabled or not | -| `enabled` | *boolean* | :heavy_check_mark: | If channel is enabled or not | \ No newline at end of file +| `enabled` | *boolean* | :heavy_check_mark: | If channel is enabled or not | +| `type` | [components.ChannelPreferenceType](../../models/components/channelpreferencetype.md) | :heavy_check_mark: | The type of channel that is enabled or not | \ No newline at end of file diff --git a/docs/models/components/channels.md b/docs/models/components/channels.md index 3b9453e5..12ae99d1 100644 --- a/docs/models/components/channels.md +++ b/docs/models/components/channels.md @@ -3,14 +3,10 @@ ## Values -| Name | Value | -| --------- | --------- | -| `InApp` | in_app | -| `Email` | email | -| `Sms` | sms | -| `Chat` | chat | -| `Push` | push | -| `Digest` | digest | -| `Trigger` | trigger | -| `Delay` | delay | -| `Custom` | custom | \ No newline at end of file +| Name | Value | +| ------- | ------- | +| `InApp` | in_app | +| `Email` | email | +| `Sms` | sms | +| `Chat` | chat | +| `Push` | push | \ No newline at end of file diff --git a/docs/models/components/channelsettings.md b/docs/models/components/channelsettings.md index dd057144..e425e364 100644 --- a/docs/models/components/channelsettings.md +++ b/docs/models/components/channelsettings.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `providerId` | [components.ChannelSettingsProviderId](../../models/components/channelsettingsproviderid.md) | :heavy_check_mark: | The provider identifier for the credentials | -| `integrationIdentifier` | *string* | :heavy_minus_sign: | The integration identifier | +| `integrationId` | *string* | :heavy_check_mark: | Id of the integration that is used for this channel | | `credentials` | [components.ChannelCredentials](../../models/components/channelcredentials.md) | :heavy_check_mark: | Credentials payload for the specified provider | -| `integrationId` | *string* | :heavy_check_mark: | Id of the integration that is used for this channel | \ No newline at end of file +| `integrationIdentifier` | *string* | :heavy_minus_sign: | The integration identifier | +| `providerId` | [components.ChannelSettingsProviderId](../../models/components/channelsettingsproviderid.md) | :heavy_check_mark: | The provider identifier for the credentials | \ No newline at end of file diff --git a/docs/models/components/createintegrationrequestdto.md b/docs/models/components/createintegrationrequestdto.md index cf759d33..aefdae29 100644 --- a/docs/models/components/createintegrationrequestdto.md +++ b/docs/models/components/createintegrationrequestdto.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `identifier` | *string* | :heavy_minus_sign: | N/A | -| `environmentId` | *string* | :heavy_minus_sign: | N/A | -| `providerId` | *string* | :heavy_check_mark: | N/A | -| `channel` | [components.CreateIntegrationRequestDtoChannel](../../models/components/createintegrationrequestdtochannel.md) | :heavy_check_mark: | N/A | -| `credentials` | [components.CredentialsDto](../../models/components/credentialsdto.md) | :heavy_minus_sign: | N/A | -| `active` | *boolean* | :heavy_minus_sign: | If the integration is active the validation on the credentials field will run | -| `check` | *boolean* | :heavy_minus_sign: | N/A | -| `conditions` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `environmentId` | *string* | :heavy_minus_sign: | N/A | +| `active` | *boolean* | :heavy_minus_sign: | If the integration is active the validation on the credentials field will run | +| `channel` | [components.Channel](../../models/components/channel.md) | :heavy_check_mark: | N/A | +| `check` | *boolean* | :heavy_minus_sign: | N/A | +| `conditions` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | +| `credentials` | [components.CredentialsDto](../../models/components/credentialsdto.md) | :heavy_minus_sign: | N/A | +| `identifier` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_minus_sign: | N/A | +| `providerId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createintegrationrequestdtochannel.md b/docs/models/components/createintegrationrequestdtochannel.md deleted file mode 100644 index 9fe355a8..00000000 --- a/docs/models/components/createintegrationrequestdtochannel.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateIntegrationRequestDtoChannel - - -## Values - -| Name | Value | -| ------- | ------- | -| `InApp` | in_app | -| `Email` | email | -| `Sms` | sms | -| `Chat` | chat | -| `Push` | push | \ No newline at end of file diff --git a/docs/models/components/createorganizationdto.md b/docs/models/components/createorganizationdto.md index 3bb6fd2f..a65933c0 100644 --- a/docs/models/components/createorganizationdto.md +++ b/docs/models/components/createorganizationdto.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `logo` | *string* | :heavy_minus_sign: | N/A | -| `jobTitle` | [components.JobTitle](../../models/components/jobtitle.md) | :heavy_minus_sign: | N/A | | `domain` | *string* | :heavy_minus_sign: | N/A | +| `jobTitle` | [components.JobTitle](../../models/components/jobtitle.md) | :heavy_minus_sign: | N/A | +| `logo` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | | `productUseCases` | [components.ProductUseCases](../../models/components/productusecases.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/createsubscriberrequestdto.md b/docs/models/components/createsubscriberrequestdto.md index d92b1f9f..ddcec351 100644 --- a/docs/models/components/createsubscriberrequestdto.md +++ b/docs/models/components/createsubscriberrequestdto.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `subscriberId` | *string* | :heavy_check_mark: | The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems | +| `avatar` | *string* | :heavy_minus_sign: | An http url to the profile image of your subscriber | +| `channels` | [components.SubscriberChannelDto](../../models/components/subscriberchanneldto.md)[] | :heavy_minus_sign: | N/A | +| `data` | [components.Data](../../models/components/data.md) | :heavy_minus_sign: | N/A | | `email` | *string* | :heavy_minus_sign: | N/A | | `firstName` | *string* | :heavy_minus_sign: | N/A | | `lastName` | *string* | :heavy_minus_sign: | N/A | -| `phone` | *string* | :heavy_minus_sign: | N/A | -| `avatar` | *string* | :heavy_minus_sign: | An http url to the profile image of your subscriber | | `locale` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.CreateSubscriberRequestDtoData](../../models/components/createsubscriberrequestdtodata.md) | :heavy_minus_sign: | N/A | -| `channels` | [components.SubscriberChannelDto](../../models/components/subscriberchanneldto.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `phone` | *string* | :heavy_minus_sign: | N/A | +| `subscriberId` | *string* | :heavy_check_mark: | The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems | \ No newline at end of file diff --git a/docs/models/components/createsubscriberrequestdtodata.md b/docs/models/components/createsubscriberrequestdtodata.md deleted file mode 100644 index baddc784..00000000 --- a/docs/models/components/createsubscriberrequestdtodata.md +++ /dev/null @@ -1,7 +0,0 @@ -# CreateSubscriberRequestDtoData - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/createtenantrequestdto.md b/docs/models/components/createtenantrequestdto.md index 188a932d..4a380e27 100644 --- a/docs/models/components/createtenantrequestdto.md +++ b/docs/models/components/createtenantrequestdto.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `data` | [components.CreateTenantRequestDtoData](../../models/components/createtenantrequestdtodata.md) | :heavy_minus_sign: | N/A | | `identifier` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `data` | [components.CreateTenantRequestDtoData](../../models/components/createtenantrequestdtodata.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createtenantresponsedto.md b/docs/models/components/createtenantresponsedto.md index 2f1ffd24..8932f4fb 100644 --- a/docs/models/components/createtenantresponsedto.md +++ b/docs/models/components/createtenantresponsedto.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `data` | [components.CreateTenantResponseDtoData](../../models/components/createtenantresponsedtodata.md) | :heavy_minus_sign: | N/A | | `identifier` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.CreateTenantResponseDtoData](../../models/components/createtenantresponsedtodata.md) | :heavy_minus_sign: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createworkflowrequestdto.md b/docs/models/components/createworkflowrequestdto.md index 23b4c0a8..67f8db5d 100644 --- a/docs/models/components/createworkflowrequestdto.md +++ b/docs/models/components/createworkflowrequestdto.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `notificationGroupId` | *string* | :heavy_check_mark: | N/A | -| `notificationGroup` | [components.CreateWorkflowRequestDtoNotificationGroup](../../models/components/createworkflowrequestdtonotificationgroup.md) | :heavy_minus_sign: | N/A | -| `tags` | *string*[] | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `steps` | [components.NotificationStep](../../models/components/notificationstep.md)[] | :heavy_check_mark: | N/A | | `active` | *boolean* | :heavy_minus_sign: | N/A | -| ~~`draft`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | +| `blueprintId` | *string* | :heavy_minus_sign: | N/A | | `critical` | *boolean* | :heavy_minus_sign: | N/A | +| `data` | [components.CreateWorkflowRequestDtoData](../../models/components/createworkflowrequestdtodata.md) | :heavy_minus_sign: | N/A | +| `description` | *string* | :heavy_minus_sign: | N/A | +| ~~`draft`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | +| `name` | *string* | :heavy_check_mark: | N/A | +| `notificationGroup` | [components.CreateWorkflowRequestDtoNotificationGroup](../../models/components/createworkflowrequestdtonotificationgroup.md) | :heavy_minus_sign: | N/A | +| `notificationGroupId` | *string* | :heavy_check_mark: | N/A | | `preferenceSettings` | [components.PreferenceChannels](../../models/components/preferencechannels.md) | :heavy_minus_sign: | N/A | -| `blueprintId` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.CreateWorkflowRequestDtoData](../../models/components/createworkflowrequestdtodata.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `steps` | [components.NotificationStep](../../models/components/notificationstep.md)[] | :heavy_check_mark: | N/A | +| `tags` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/credentialsdto.md b/docs/models/components/credentialsdto.md index 4f1c9f56..ad7749d9 100644 --- a/docs/models/components/credentialsdto.md +++ b/docs/models/components/credentialsdto.md @@ -5,44 +5,44 @@ | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `accountSid` | *string* | :heavy_minus_sign: | N/A | +| `alertUid` | *string* | :heavy_minus_sign: | N/A | | `apiKey` | *string* | :heavy_minus_sign: | N/A | -| `user` | *string* | :heavy_minus_sign: | N/A | -| `secretKey` | *string* | :heavy_minus_sign: | N/A | +| `apiKeyRequestHeader` | *string* | :heavy_minus_sign: | N/A | +| `apiToken` | *string* | :heavy_minus_sign: | N/A | +| `applicationId` | *string* | :heavy_minus_sign: | N/A | +| `authenticateByToken` | *boolean* | :heavy_minus_sign: | N/A | +| `authenticationTokenKey` | *string* | :heavy_minus_sign: | N/A | +| `baseUrl` | *string* | :heavy_minus_sign: | N/A | +| `channelId` | *string* | :heavy_minus_sign: | N/A | +| `clientId` | *string* | :heavy_minus_sign: | N/A | +| `datePath` | *string* | :heavy_minus_sign: | N/A | | `domain` | *string* | :heavy_minus_sign: | N/A | -| `password` | *string* | :heavy_minus_sign: | N/A | +| `externalLink` | *string* | :heavy_minus_sign: | N/A | +| `from` | *string* | :heavy_minus_sign: | N/A | +| `hmac` | *boolean* | :heavy_minus_sign: | N/A | | `host` | *string* | :heavy_minus_sign: | N/A | -| `port` | *string* | :heavy_minus_sign: | N/A | -| `secure` | *boolean* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `accountSid` | *string* | :heavy_minus_sign: | N/A | +| `idPath` | *string* | :heavy_minus_sign: | N/A | +| `ignoreTls` | *boolean* | :heavy_minus_sign: | N/A | +| `imageUrl` | *string* | :heavy_minus_sign: | N/A | +| `instanceId` | *string* | :heavy_minus_sign: | N/A | +| `ipPoolName` | *string* | :heavy_minus_sign: | N/A | | `messageProfileId` | *string* | :heavy_minus_sign: | N/A | -| `token` | *string* | :heavy_minus_sign: | N/A | -| `from` | *string* | :heavy_minus_sign: | N/A | -| `senderName` | *string* | :heavy_minus_sign: | N/A | +| `password` | *string* | :heavy_minus_sign: | N/A | +| `phoneNumberIdentification` | *string* | :heavy_minus_sign: | N/A | +| `port` | *string* | :heavy_minus_sign: | N/A | | `projectName` | *string* | :heavy_minus_sign: | N/A | -| `applicationId` | *string* | :heavy_minus_sign: | N/A | -| `clientId` | *string* | :heavy_minus_sign: | N/A | -| `requireTls` | *boolean* | :heavy_minus_sign: | N/A | -| `ignoreTls` | *boolean* | :heavy_minus_sign: | N/A | -| `tlsOptions` | [components.TlsOptions](../../models/components/tlsoptions.md) | :heavy_minus_sign: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `webhookUrl` | *string* | :heavy_minus_sign: | N/A | | `redirectUrl` | *string* | :heavy_minus_sign: | N/A | -| `hmac` | *boolean* | :heavy_minus_sign: | N/A | -| `serviceAccount` | *string* | :heavy_minus_sign: | N/A | -| `ipPoolName` | *string* | :heavy_minus_sign: | N/A | -| `apiKeyRequestHeader` | *string* | :heavy_minus_sign: | N/A | +| `region` | *string* | :heavy_minus_sign: | N/A | +| `requireTls` | *boolean* | :heavy_minus_sign: | N/A | +| `secretKey` | *string* | :heavy_minus_sign: | N/A | | `secretKeyRequestHeader` | *string* | :heavy_minus_sign: | N/A | -| `idPath` | *string* | :heavy_minus_sign: | N/A | -| `datePath` | *string* | :heavy_minus_sign: | N/A | -| `apiToken` | *string* | :heavy_minus_sign: | N/A | -| `authenticateByToken` | *boolean* | :heavy_minus_sign: | N/A | -| `authenticationTokenKey` | *string* | :heavy_minus_sign: | N/A | -| `instanceId` | *string* | :heavy_minus_sign: | N/A | -| `alertUid` | *string* | :heavy_minus_sign: | N/A | -| `title` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | +| `secure` | *boolean* | :heavy_minus_sign: | N/A | +| `senderName` | *string* | :heavy_minus_sign: | N/A | +| `serviceAccount` | *string* | :heavy_minus_sign: | N/A | | `state` | *string* | :heavy_minus_sign: | N/A | -| `externalLink` | *string* | :heavy_minus_sign: | N/A | -| `channelId` | *string* | :heavy_minus_sign: | N/A | -| `phoneNumberIdentification` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `title` | *string* | :heavy_minus_sign: | N/A | +| `tlsOptions` | [components.TlsOptions](../../models/components/tlsoptions.md) | :heavy_minus_sign: | N/A | +| `token` | *string* | :heavy_minus_sign: | N/A | +| `user` | *string* | :heavy_minus_sign: | N/A | +| `webhookUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/delayregularmetadata.md b/docs/models/components/delayregularmetadata.md index 217c8131..e945d036 100644 --- a/docs/models/components/delayregularmetadata.md +++ b/docs/models/components/delayregularmetadata.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `amount` | *number* | :heavy_minus_sign: | N/A | -| `unit` | [components.DelayRegularMetadataUnit](../../models/components/delayregularmetadataunit.md) | :heavy_minus_sign: | N/A | -| `type` | [components.DelayRegularMetadataType](../../models/components/delayregularmetadatatype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.DelayRegularMetadataType](../../models/components/delayregularmetadatatype.md) | :heavy_check_mark: | N/A | +| `unit` | [components.Unit](../../models/components/unit.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/delayregularmetadataunit.md b/docs/models/components/delayregularmetadataunit.md deleted file mode 100644 index f6f7471e..00000000 --- a/docs/models/components/delayregularmetadataunit.md +++ /dev/null @@ -1,13 +0,0 @@ -# DelayRegularMetadataUnit - - -## Values - -| Name | Value | -| --------- | --------- | -| `Seconds` | seconds | -| `Minutes` | minutes | -| `Hours` | hours | -| `Days` | days | -| `Weeks` | weeks | -| `Months` | months | \ No newline at end of file diff --git a/docs/models/components/delayscheduledmetadata.md b/docs/models/components/delayscheduledmetadata.md index ea88e215..04fbe134 100644 --- a/docs/models/components/delayscheduledmetadata.md +++ b/docs/models/components/delayscheduledmetadata.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | [components.DelayScheduledMetadataType](../../models/components/delayscheduledmetadatatype.md) | :heavy_check_mark: | N/A | -| `delayPath` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delayPath` | *string* | :heavy_check_mark: | N/A | +| `type` | [components.DelayScheduledMetadataType](../../models/components/delayscheduledmetadatatype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/digestregularmetadata.md b/docs/models/components/digestregularmetadata.md index 62f436f4..8372f432 100644 --- a/docs/models/components/digestregularmetadata.md +++ b/docs/models/components/digestregularmetadata.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `amount` | *number* | :heavy_minus_sign: | N/A | -| `unit` | [components.Unit](../../models/components/unit.md) | :heavy_minus_sign: | N/A | -| `digestKey` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.DigestRegularMetadataType](../../models/components/digestregularmetadatatype.md) | :heavy_check_mark: | N/A | | `backoff` | *boolean* | :heavy_minus_sign: | N/A | | `backoffAmount` | *number* | :heavy_minus_sign: | N/A | | `backoffUnit` | [components.BackoffUnit](../../models/components/backoffunit.md) | :heavy_minus_sign: | N/A | +| `digestKey` | *string* | :heavy_minus_sign: | N/A | +| `type` | [components.DigestRegularMetadataType](../../models/components/digestregularmetadatatype.md) | :heavy_check_mark: | N/A | +| `unit` | [components.DigestRegularMetadataUnit](../../models/components/digestregularmetadataunit.md) | :heavy_minus_sign: | N/A | | `updateMode` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/digesttimedmetadata.md b/docs/models/components/digesttimedmetadata.md index 13683563..6c9b4127 100644 --- a/docs/models/components/digesttimedmetadata.md +++ b/docs/models/components/digesttimedmetadata.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `amount` | *number* | :heavy_minus_sign: | N/A | -| `unit` | [components.DigestTimedMetadataUnit](../../models/components/digesttimedmetadataunit.md) | :heavy_minus_sign: | N/A | | `digestKey` | *string* | :heavy_minus_sign: | N/A | +| `timed` | [components.TimedConfig](../../models/components/timedconfig.md) | :heavy_minus_sign: | N/A | | `type` | [components.DigestTimedMetadataType](../../models/components/digesttimedmetadatatype.md) | :heavy_check_mark: | N/A | -| `timed` | [components.TimedConfig](../../models/components/timedconfig.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `unit` | [components.DigestTimedMetadataUnit](../../models/components/digesttimedmetadataunit.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/emailblock.md b/docs/models/components/emailblock.md index a67cb7a3..9ee36a41 100644 --- a/docs/models/components/emailblock.md +++ b/docs/models/components/emailblock.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.EmailBlockType](../../models/components/emailblocktype.md) | :heavy_check_mark: | N/A | | `content` | *string* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_minus_sign: | N/A | -| `styles` | [components.EmailBlockStyles](../../models/components/emailblockstyles.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `styles` | [components.EmailBlockStyles](../../models/components/emailblockstyles.md) | :heavy_minus_sign: | N/A | +| `type` | [components.EmailBlockType](../../models/components/emailblocktype.md) | :heavy_check_mark: | N/A | +| `url` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/environmentresponsedto.md b/docs/models/components/environmentresponsedto.md index f4787704..fe591792 100644 --- a/docs/models/components/environmentresponsedto.md +++ b/docs/models/components/environmentresponsedto.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `identifier` | *string* | :heavy_check_mark: | N/A | +| `parentId` | *string* | :heavy_check_mark: | N/A | | `apiKeys` | [components.ApiKeys](../../models/components/apikeys.md)[] | :heavy_minus_sign: | N/A | -| `parentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `identifier` | *string* | :heavy_check_mark: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/executiondetailsresponsedto.md b/docs/models/components/executiondetailsresponsedto.md index 45f1a034..3e6021bc 100644 --- a/docs/models/components/executiondetailsresponsedto.md +++ b/docs/models/components/executiondetailsresponsedto.md @@ -3,22 +3,22 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | -| `jobId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `notificationId` | *string* | :heavy_check_mark: | N/A | -| `notificationTemplateId` | *string* | :heavy_check_mark: | N/A | -| `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `messageId` | *string* | :heavy_minus_sign: | N/A | -| `providerId` | *string* | :heavy_minus_sign: | N/A | -| `transactionId` | *string* | :heavy_check_mark: | N/A | -| `channel` | [components.Channel](../../models/components/channel.md) | :heavy_check_mark: | N/A | -| `detail` | *string* | :heavy_check_mark: | N/A | -| `source` | [components.Source](../../models/components/source.md) | :heavy_check_mark: | N/A | -| `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | N/A | -| `isTest` | *boolean* | :heavy_check_mark: | N/A | -| `isRetry` | *boolean* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `environmentId` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | +| `jobId` | *string* | :heavy_check_mark: | N/A | +| `messageId` | *string* | :heavy_minus_sign: | N/A | +| `notificationId` | *string* | :heavy_check_mark: | N/A | +| `notificationTemplateId` | *string* | :heavy_check_mark: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | +| `subscriberId` | *string* | :heavy_check_mark: | N/A | +| `channel` | [components.ExecutionDetailsResponseDtoChannel](../../models/components/executiondetailsresponsedtochannel.md) | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_minus_sign: | N/A | +| `detail` | *string* | :heavy_check_mark: | N/A | +| `isRetry` | *boolean* | :heavy_check_mark: | N/A | +| `isTest` | *boolean* | :heavy_check_mark: | N/A | +| `providerId` | *string* | :heavy_minus_sign: | N/A | +| `source` | [components.ExecutionDetailsResponseDtoSource](../../models/components/executiondetailsresponsedtosource.md) | :heavy_check_mark: | N/A | +| `status` | [components.ExecutionDetailsResponseDtoStatus](../../models/components/executiondetailsresponsedtostatus.md) | :heavy_check_mark: | N/A | +| `transactionId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/feedresponsedto.md b/docs/models/components/feedresponsedto.md index afc3c5ca..99bf08a9 100644 --- a/docs/models/components/feedresponsedto.md +++ b/docs/models/components/feedresponsedto.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | | `identifier` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fieldfilterpart.md b/docs/models/components/fieldfilterpart.md index 031fb292..16e003ed 100644 --- a/docs/models/components/fieldfilterpart.md +++ b/docs/models/components/fieldfilterpart.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `field` | *string* | :heavy_check_mark: | N/A | -| `value` | *string* | :heavy_check_mark: | N/A | +| `on` | [components.On](../../models/components/on.md) | :heavy_check_mark: | N/A | | `operator` | [components.Operator](../../models/components/operator.md) | :heavy_check_mark: | N/A | -| `on` | [components.On](../../models/components/on.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/getlayoutresponsedto.md b/docs/models/components/getlayoutresponsedto.md index 80ac819a..cdb1708f 100644 --- a/docs/models/components/getlayoutresponsedto.md +++ b/docs/models/components/getlayoutresponsedto.md @@ -5,19 +5,19 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `creatorId` | *string* | :heavy_check_mark: | N/A | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `creatorId` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `identifier` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | +| `parentId` | *string* | :heavy_minus_sign: | N/A | | `channel` | [components.GetLayoutResponseDtoChannel](../../models/components/getlayoutresponsedtochannel.md) | :heavy_check_mark: | N/A | | `content` | *string* | :heavy_check_mark: | N/A | | `contentType` | *string* | :heavy_check_mark: | N/A | -| `variables` | [components.Variables](../../models/components/variables.md)[] | :heavy_minus_sign: | N/A | +| `createdAt` | *string* | :heavy_minus_sign: | N/A | +| `description` | *string* | :heavy_minus_sign: | N/A | +| `identifier` | *string* | :heavy_check_mark: | N/A | | `isDefault` | *boolean* | :heavy_check_mark: | N/A | | `isDeleted` | *boolean* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_minus_sign: | N/A | -| `parentId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `variables` | [components.Variables](../../models/components/variables.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/getsubscriberpreferencesresponsedto.md b/docs/models/components/getsubscriberpreferencesresponsedto.md index 5d23ba19..43f2a598 100644 --- a/docs/models/components/getsubscriberpreferencesresponsedto.md +++ b/docs/models/components/getsubscriberpreferencesresponsedto.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `template` | [components.TemplateResponse](../../models/components/templateresponse.md) | :heavy_minus_sign: | The workflow information and if it is critical or not | -| `preference` | [components.Preference](../../models/components/preference.md) | :heavy_check_mark: | The preferences of the subscriber regarding the related workflow | \ No newline at end of file +| `preference` | [components.Preference](../../models/components/preference.md) | :heavy_check_mark: | The preferences of the subscriber regarding the related workflow | +| `template` | [components.TemplateResponse](../../models/components/templateresponse.md) | :heavy_minus_sign: | The workflow information and if it is critical or not | \ No newline at end of file diff --git a/docs/models/components/gettenantresponsedto.md b/docs/models/components/gettenantresponsedto.md index 4d25d1e3..d8cf585b 100644 --- a/docs/models/components/gettenantresponsedto.md +++ b/docs/models/components/gettenantresponsedto.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `data` | [components.GetTenantResponseDtoData](../../models/components/gettenantresponsedtodata.md) | :heavy_minus_sign: | N/A | | `identifier` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.GetTenantResponseDtoData](../../models/components/gettenantresponsedtodata.md) | :heavy_minus_sign: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/gettopicresponsedto.md b/docs/models/components/gettopicresponsedto.md index 5c0ad400..5d55ce17 100644 --- a/docs/models/components/gettopicresponsedto.md +++ b/docs/models/components/gettopicresponsedto.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | | `key` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `subscribers` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/integrationresponsedto.md b/docs/models/components/integrationresponsedto.md index 335130dd..793ed471 100644 --- a/docs/models/components/integrationresponsedto.md +++ b/docs/models/components/integrationresponsedto.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | | `environmentId` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `identifier` | *string* | :heavy_check_mark: | N/A | -| `providerId` | *string* | :heavy_check_mark: | N/A | +| `active` | *boolean* | :heavy_check_mark: | N/A | | `channel` | [components.IntegrationResponseDtoChannel](../../models/components/integrationresponsedtochannel.md) | :heavy_check_mark: | N/A | +| `conditions` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | | `credentials` | [components.CredentialsDto](../../models/components/credentialsdto.md) | :heavy_check_mark: | N/A | -| `active` | *boolean* | :heavy_check_mark: | N/A | | `deleted` | *boolean* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `deletedBy` | *string* | :heavy_check_mark: | N/A | +| `identifier` | *string* | :heavy_check_mark: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | | `primary` | *boolean* | :heavy_check_mark: | N/A | -| `conditions` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `providerId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/ipartnerconfigurationresponsedto.md b/docs/models/components/ipartnerconfigurationresponsedto.md index 77eeb658..ca7e27b4 100644 --- a/docs/models/components/ipartnerconfigurationresponsedto.md +++ b/docs/models/components/ipartnerconfigurationresponsedto.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `projectIds` | *string*[] | :heavy_minus_sign: | N/A | | `accessToken` | *string* | :heavy_check_mark: | N/A | | `configurationId` | *string* | :heavy_check_mark: | N/A | -| `teamId` | *string* | :heavy_minus_sign: | N/A | -| `partnerType` | [components.PartnerType](../../models/components/partnertype.md) | :heavy_check_mark: | Partner Type Enum | \ No newline at end of file +| `partnerType` | [components.PartnerType](../../models/components/partnertype.md) | :heavy_check_mark: | Partner Type Enum | +| `projectIds` | *string*[] | :heavy_minus_sign: | N/A | +| `teamId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/markallmessageasrequestdto.md b/docs/models/components/markallmessageasrequestdto.md index 3b31a835..de25411c 100644 --- a/docs/models/components/markallmessageasrequestdto.md +++ b/docs/models/components/markallmessageasrequestdto.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `feedIdentifier` | *components.FeedIdentifier* | :heavy_minus_sign: | Optional feed identifier or array of feed identifiers | -| `markAs` | [components.MarkAllMessageAsRequestDtoMarkAs](../../models/components/markallmessageasrequestdtomarkas.md) | :heavy_check_mark: | Mark all subscriber messages as read, unread, seen or unseen | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `feedIdentifier` | *components.FeedIdentifier* | :heavy_minus_sign: | Optional feed identifier or array of feed identifiers | +| `markAs` | [components.MarkAs](../../models/components/markas.md) | :heavy_check_mark: | Mark all subscriber messages as read, unread, seen or unseen | \ No newline at end of file diff --git a/docs/models/components/markallmessageasrequestdtomarkas.md b/docs/models/components/markallmessageasrequestdtomarkas.md deleted file mode 100644 index 1ca94aac..00000000 --- a/docs/models/components/markallmessageasrequestdtomarkas.md +++ /dev/null @@ -1,13 +0,0 @@ -# MarkAllMessageAsRequestDtoMarkAs - -Mark all subscriber messages as read, unread, seen or unseen - - -## Values - -| Name | Value | -| -------- | -------- | -| `Read` | read | -| `Seen` | seen | -| `Unread` | unread | -| `Unseen` | unseen | \ No newline at end of file diff --git a/docs/models/components/markas.md b/docs/models/components/markas.md index 6775ddd9..2797ca96 100644 --- a/docs/models/components/markas.md +++ b/docs/models/components/markas.md @@ -1,5 +1,7 @@ # MarkAs +Mark all subscriber messages as read, unread, seen or unseen + ## Values diff --git a/docs/models/components/markmessageactionasseendto.md b/docs/models/components/markmessageactionasseendto.md index 8315d79c..15a5475e 100644 --- a/docs/models/components/markmessageactionasseendto.md +++ b/docs/models/components/markmessageactionasseendto.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `status` | [components.MarkMessageActionAsSeenDtoStatus](../../models/components/markmessageactionasseendtostatus.md) | :heavy_check_mark: | Message action status | -| `payload` | [components.MarkMessageActionAsSeenDtoPayload](../../models/components/markmessageactionasseendtopayload.md) | :heavy_minus_sign: | Message action payload | \ No newline at end of file +| `payload` | [components.MarkMessageActionAsSeenDtoPayload](../../models/components/markmessageactionasseendtopayload.md) | :heavy_minus_sign: | Message action payload | +| `status` | [components.MarkMessageActionAsSeenDtoStatus](../../models/components/markmessageactionasseendtostatus.md) | :heavy_check_mark: | Message action status | \ No newline at end of file diff --git a/docs/models/components/memberinvitedto.md b/docs/models/components/memberinvitedto.md index 16943a57..f70bcdf8 100644 --- a/docs/models/components/memberinvitedto.md +++ b/docs/models/components/memberinvitedto.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `inviterId` | *string* | :heavy_check_mark: | N/A | +| `answerDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | `email` | *string* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | | `invitationDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `answerDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `inviterId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/memberresponsedto.md b/docs/models/components/memberresponsedto.md index 135b4545..01efd9c8 100644 --- a/docs/models/components/memberresponsedto.md +++ b/docs/models/components/memberresponsedto.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | | `userId` | *string* | :heavy_check_mark: | N/A | -| `user` | [components.MemberUserDto](../../models/components/memberuserdto.md) | :heavy_minus_sign: | N/A | -| `roles` | [components.Roles](../../models/components/roles.md) | :heavy_minus_sign: | N/A | | `invite` | [components.MemberInviteDTO](../../models/components/memberinvitedto.md) | :heavy_minus_sign: | N/A | | `memberStatus` | [components.MemberStatus](../../models/components/memberstatus.md) | :heavy_minus_sign: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `roles` | [components.Roles](../../models/components/roles.md) | :heavy_minus_sign: | N/A | +| `user` | [components.MemberUserDto](../../models/components/memberuserdto.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/memberuserdto.md b/docs/models/components/memberuserdto.md index f60719ed..661d1b63 100644 --- a/docs/models/components/memberuserdto.md +++ b/docs/models/components/memberuserdto.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | | `id` | *string* | :heavy_check_mark: | N/A | +| `email` | *string* | :heavy_check_mark: | N/A | | `firstName` | *string* | :heavy_check_mark: | N/A | -| `lastName` | *string* | :heavy_check_mark: | N/A | -| `email` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `lastName` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messageaction.md b/docs/models/components/messageaction.md index 8726fc3e..2dea05e2 100644 --- a/docs/models/components/messageaction.md +++ b/docs/models/components/messageaction.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `status` | [components.MessageActionStatus](../../models/components/messageactionstatus.md) | :heavy_minus_sign: | N/A | | `buttons` | [components.MessageButton](../../models/components/messagebutton.md)[] | :heavy_minus_sign: | N/A | -| `result` | [components.MessageActionResult](../../models/components/messageactionresult.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `result` | [components.MessageActionResult](../../models/components/messageactionresult.md) | :heavy_minus_sign: | N/A | +| `status` | [components.MessageActionStatus](../../models/components/messageactionstatus.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagebutton.md b/docs/models/components/messagebutton.md index 6c2ea2e7..01d79911 100644 --- a/docs/models/components/messagebutton.md +++ b/docs/models/components/messagebutton.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [components.MessageButtonType](../../models/components/messagebuttontype.md) | :heavy_check_mark: | N/A | | `content` | *string* | :heavy_check_mark: | N/A | -| `resultContent` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `resultContent` | *string* | :heavy_minus_sign: | N/A | +| `type` | [components.MessageButtonType](../../models/components/messagebuttontype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagecta.md b/docs/models/components/messagecta.md index fdf056ad..746d77de 100644 --- a/docs/models/components/messagecta.md +++ b/docs/models/components/messagecta.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.MessageCTAType](../../models/components/messagectatype.md) | :heavy_minus_sign: | N/A | +| `action` | [components.MessageAction](../../models/components/messageaction.md) | :heavy_minus_sign: | N/A | | `data` | [components.MessageCTAData](../../models/components/messagectadata.md) | :heavy_check_mark: | N/A | -| `action` | [components.MessageAction](../../models/components/messageaction.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [components.MessageCTAType](../../models/components/messagectatype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagemarkasrequestdto.md b/docs/models/components/messagemarkasrequestdto.md index 120ab180..c8c0d43a 100644 --- a/docs/models/components/messagemarkasrequestdto.md +++ b/docs/models/components/messagemarkasrequestdto.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `messageId` | *components.MessageId* | :heavy_check_mark: | N/A | -| `markAs` | [components.MarkAs](../../models/components/markas.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `markAs` | [components.MessageMarkAsRequestDtoMarkAs](../../models/components/messagemarkasrequestdtomarkas.md) | :heavy_check_mark: | N/A | +| `messageId` | *components.MessageId* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messageresponsedto.md b/docs/models/components/messageresponsedto.md index 4ff2e082..42f3adb0 100644 --- a/docs/models/components/messageresponsedto.md +++ b/docs/models/components/messageresponsedto.md @@ -3,37 +3,37 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `templateId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `messageTemplateId` | *string* | :heavy_check_mark: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | -| `notificationId` | *string* | :heavy_check_mark: | N/A | -| `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `subscriber` | [components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md) | :heavy_minus_sign: | N/A | -| `template` | [components.WorkflowResponse](../../models/components/workflowresponse.md) | :heavy_minus_sign: | N/A | -| `templateIdentifier` | *string* | :heavy_minus_sign: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `lastSeenDate` | *string* | :heavy_minus_sign: | N/A | -| `lastReadDate` | *string* | :heavy_minus_sign: | N/A | -| `content` | *components.Content* | :heavy_check_mark: | N/A | -| `transactionId` | *string* | :heavy_check_mark: | N/A | -| `subject` | *string* | :heavy_minus_sign: | N/A | -| `channel` | [components.MessageResponseDtoChannel](../../models/components/messageresponsedtochannel.md) | :heavy_check_mark: | N/A | -| `read` | *boolean* | :heavy_check_mark: | N/A | -| `seen` | *boolean* | :heavy_check_mark: | N/A | -| `email` | *string* | :heavy_minus_sign: | N/A | -| `phone` | *string* | :heavy_minus_sign: | N/A | -| `directWebhookUrl` | *string* | :heavy_minus_sign: | N/A | -| `providerId` | *string* | :heavy_minus_sign: | N/A | -| `deviceTokens` | *string*[] | :heavy_minus_sign: | N/A | -| `title` | *string* | :heavy_minus_sign: | N/A | -| `cta` | [components.MessageCTA](../../models/components/messagecta.md) | :heavy_check_mark: | N/A | -| `feedId` | *string* | :heavy_minus_sign: | N/A | -| `status` | [components.MessageResponseDtoStatus](../../models/components/messageresponsedtostatus.md) | :heavy_check_mark: | N/A | -| `errorId` | *string* | :heavy_check_mark: | N/A | -| `errorText` | *string* | :heavy_check_mark: | N/A | -| `payload` | [components.MessageResponseDtoPayload](../../models/components/messageresponsedtopayload.md) | :heavy_check_mark: | The payload that was used to send the notification trigger | -| `overrides` | [components.MessageResponseDtoOverrides](../../models/components/messageresponsedtooverrides.md) | :heavy_check_mark: | Provider specific overrides used when triggering the notification | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `environmentId` | *string* | :heavy_check_mark: | N/A | +| `feedId` | *string* | :heavy_minus_sign: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | +| `messageTemplateId` | *string* | :heavy_check_mark: | N/A | +| `notificationId` | *string* | :heavy_check_mark: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | +| `subscriberId` | *string* | :heavy_check_mark: | N/A | +| `templateId` | *string* | :heavy_check_mark: | N/A | +| `channel` | [components.MessageResponseDtoChannel](../../models/components/messageresponsedtochannel.md) | :heavy_check_mark: | N/A | +| `content` | *components.Content* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `cta` | [components.MessageCTA](../../models/components/messagecta.md) | :heavy_check_mark: | N/A | +| `deviceTokens` | *string*[] | :heavy_minus_sign: | N/A | +| `directWebhookUrl` | *string* | :heavy_minus_sign: | N/A | +| `email` | *string* | :heavy_minus_sign: | N/A | +| `errorId` | *string* | :heavy_check_mark: | N/A | +| `errorText` | *string* | :heavy_check_mark: | N/A | +| `lastReadDate` | *string* | :heavy_minus_sign: | N/A | +| `lastSeenDate` | *string* | :heavy_minus_sign: | N/A | +| `overrides` | [components.Overrides](../../models/components/overrides.md) | :heavy_check_mark: | Provider specific overrides used when triggering the notification | +| `payload` | [components.MessageResponseDtoPayload](../../models/components/messageresponsedtopayload.md) | :heavy_check_mark: | The payload that was used to send the notification trigger | +| `phone` | *string* | :heavy_minus_sign: | N/A | +| `providerId` | *string* | :heavy_minus_sign: | N/A | +| `read` | *boolean* | :heavy_check_mark: | N/A | +| `seen` | *boolean* | :heavy_check_mark: | N/A | +| `status` | [components.MessageResponseDtoStatus](../../models/components/messageresponsedtostatus.md) | :heavy_check_mark: | N/A | +| `subject` | *string* | :heavy_minus_sign: | N/A | +| `subscriber` | [components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md) | :heavy_minus_sign: | N/A | +| `template` | [components.WorkflowResponse](../../models/components/workflowresponse.md) | :heavy_minus_sign: | N/A | +| `templateIdentifier` | *string* | :heavy_minus_sign: | N/A | +| `title` | *string* | :heavy_minus_sign: | N/A | +| `transactionId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messageresponsedtooverrides.md b/docs/models/components/messageresponsedtooverrides.md deleted file mode 100644 index b68cdd52..00000000 --- a/docs/models/components/messageresponsedtooverrides.md +++ /dev/null @@ -1,9 +0,0 @@ -# MessageResponseDtoOverrides - -Provider specific overrides used when triggering the notification - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/notificationgroup.md b/docs/models/components/notificationgroup.md index 67d42bdf..bb1586c1 100644 --- a/docs/models/components/notificationgroup.md +++ b/docs/models/components/notificationgroup.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | | `environmentId` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `parentId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `parentId` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/notificationgroupresponsedto.md b/docs/models/components/notificationgroupresponsedto.md index 91bffdb0..cbb1588c 100644 --- a/docs/models/components/notificationgroupresponsedto.md +++ b/docs/models/components/notificationgroupresponsedto.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | | `environmentId` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `parentId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `parentId` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/notificationstep.md b/docs/models/components/notificationstep.md index 7d8faa6a..9f0c36a5 100644 --- a/docs/models/components/notificationstep.md +++ b/docs/models/components/notificationstep.md @@ -6,14 +6,14 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | N/A | -| `uuid` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | +| `parentId` | [components.ParentId](../../models/components/parentid.md) | :heavy_minus_sign: | N/A | | `templateId` | *string* | :heavy_minus_sign: | N/A | | `active` | *boolean* | :heavy_minus_sign: | N/A | -| `shouldStopOnFail` | *boolean* | :heavy_minus_sign: | N/A | -| `template` | [components.MessageTemplate](../../models/components/messagetemplate.md) | :heavy_minus_sign: | N/A | | `filters` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | -| `parentId` | [components.ParentId](../../models/components/parentid.md) | :heavy_minus_sign: | N/A | | `metadata` | *components.Metadata* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_minus_sign: | N/A | | `replyCallback` | [components.ReplyCallback](../../models/components/replycallback.md) | :heavy_minus_sign: | N/A | +| `shouldStopOnFail` | *boolean* | :heavy_minus_sign: | N/A | +| `template` | [components.MessageTemplate](../../models/components/messagetemplate.md) | :heavy_minus_sign: | N/A | +| `uuid` | *string* | :heavy_minus_sign: | N/A | | `variants` | [components.NotificationStepVariant](../../models/components/notificationstepvariant.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/notificationstepvariant.md b/docs/models/components/notificationstepvariant.md index d6daf2be..6e9f5dbd 100644 --- a/docs/models/components/notificationstepvariant.md +++ b/docs/models/components/notificationstepvariant.md @@ -6,13 +6,13 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_minus_sign: | N/A | -| `uuid` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | +| `parentId` | [components.NotificationStepVariantParentId](../../models/components/notificationstepvariantparentid.md) | :heavy_minus_sign: | N/A | | `templateId` | *string* | :heavy_minus_sign: | N/A | | `active` | *boolean* | :heavy_minus_sign: | N/A | -| `shouldStopOnFail` | *boolean* | :heavy_minus_sign: | N/A | -| `template` | [components.MessageTemplate](../../models/components/messagetemplate.md) | :heavy_minus_sign: | N/A | | `filters` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | -| `parentId` | [components.NotificationStepVariantParentId](../../models/components/notificationstepvariantparentid.md) | :heavy_minus_sign: | N/A | | `metadata` | *components.NotificationStepVariantMetadata* | :heavy_minus_sign: | N/A | -| `replyCallback` | [components.NotificationStepVariantReplyCallback](../../models/components/notificationstepvariantreplycallback.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `name` | *string* | :heavy_minus_sign: | N/A | +| `replyCallback` | [components.NotificationStepVariantReplyCallback](../../models/components/notificationstepvariantreplycallback.md) | :heavy_minus_sign: | N/A | +| `shouldStopOnFail` | *boolean* | :heavy_minus_sign: | N/A | +| `template` | [components.MessageTemplate](../../models/components/messagetemplate.md) | :heavy_minus_sign: | N/A | +| `uuid` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/notificationtrigger.md b/docs/models/components/notificationtrigger.md index 3b77f19b..7f4ef0b5 100644 --- a/docs/models/components/notificationtrigger.md +++ b/docs/models/components/notificationtrigger.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [components.NotificationTriggerType](../../models/components/notificationtriggertype.md) | :heavy_check_mark: | N/A | | `identifier` | *string* | :heavy_check_mark: | N/A | -| `variables` | [components.NotificationTriggerVariable](../../models/components/notificationtriggervariable.md)[] | :heavy_check_mark: | N/A | -| `subscriberVariables` | [components.NotificationTriggerVariable](../../models/components/notificationtriggervariable.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `subscriberVariables` | [components.NotificationTriggerVariable](../../models/components/notificationtriggervariable.md)[] | :heavy_minus_sign: | N/A | +| `type` | [components.NotificationTriggerType](../../models/components/notificationtriggertype.md) | :heavy_check_mark: | N/A | +| `variables` | [components.NotificationTriggerVariable](../../models/components/notificationtriggervariable.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/organizationbrandingresponsedto.md b/docs/models/components/organizationbrandingresponsedto.md index aeebc004..e8742d2f 100644 --- a/docs/models/components/organizationbrandingresponsedto.md +++ b/docs/models/components/organizationbrandingresponsedto.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `direction` | [components.Direction](../../models/components/direction.md) | :heavy_minus_sign: | N/A | -| `logo` | *string* | :heavy_check_mark: | N/A | | `color` | *string* | :heavy_check_mark: | N/A | -| `fontColor` | *string* | :heavy_check_mark: | N/A | | `contentBackground` | *string* | :heavy_check_mark: | N/A | -| `fontFamily` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `direction` | [components.Direction](../../models/components/direction.md) | :heavy_minus_sign: | N/A | +| `fontColor` | *string* | :heavy_check_mark: | N/A | +| `fontFamily` | *string* | :heavy_minus_sign: | N/A | +| `logo` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/organizationresponsedto.md b/docs/models/components/organizationresponsedto.md index 9c8327a9..0e8be077 100644 --- a/docs/models/components/organizationresponsedto.md +++ b/docs/models/components/organizationresponsedto.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `logo` | *string* | :heavy_minus_sign: | N/A | | `branding` | [components.OrganizationBrandingResponseDto](../../models/components/organizationbrandingresponsedto.md) | :heavy_check_mark: | N/A | +| `logo` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | | `partnerConfigurations` | [components.IPartnerConfigurationResponseDto](../../models/components/ipartnerconfigurationresponsedto.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/overrides.md b/docs/models/components/overrides.md index a7c3ddfa..2456f98e 100644 --- a/docs/models/components/overrides.md +++ b/docs/models/components/overrides.md @@ -1,6 +1,6 @@ # Overrides -This could be used to override provider specific configurations +Provider specific overrides used when triggering the notification ## Fields diff --git a/docs/models/components/payload.md b/docs/models/components/payload.md index d85bb5bb..803eba50 100644 --- a/docs/models/components/payload.md +++ b/docs/models/components/payload.md @@ -1,8 +1,5 @@ # Payload -The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. - This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. - ## Fields diff --git a/docs/models/components/preference.md b/docs/models/components/preference.md index 79b87f98..0a39e266 100644 --- a/docs/models/components/preference.md +++ b/docs/models/components/preference.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_check_mark: | Sets if the workflow is fully enabled for all channels or not for the subscriber. | -| `channels` | [components.PreferenceChannels](../../models/components/preferencechannels.md) | :heavy_check_mark: | Subscriber preferences for the different channels regarding this workflow | \ No newline at end of file +| `channels` | [components.PreferenceChannels](../../models/components/preferencechannels.md) | :heavy_check_mark: | Subscriber preferences for the different channels regarding this workflow | +| `enabled` | *boolean* | :heavy_check_mark: | Sets if the workflow is fully enabled for all channels or not for the subscriber. | \ No newline at end of file diff --git a/docs/models/components/preferencechannels.md b/docs/models/components/preferencechannels.md index 68249e83..2d975dbf 100644 --- a/docs/models/components/preferencechannels.md +++ b/docs/models/components/preferencechannels.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | +| `chat` | *boolean* | :heavy_minus_sign: | N/A | | `email` | *boolean* | :heavy_minus_sign: | N/A | -| `sms` | *boolean* | :heavy_minus_sign: | N/A | | `inApp` | *boolean* | :heavy_minus_sign: | N/A | -| `chat` | *boolean* | :heavy_minus_sign: | N/A | -| `push` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `push` | *boolean* | :heavy_minus_sign: | N/A | +| `sms` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/renametopicresponsedto.md b/docs/models/components/renametopicresponsedto.md index 59242e1b..254e4923 100644 --- a/docs/models/components/renametopicresponsedto.md +++ b/docs/models/components/renametopicresponsedto.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | | `key` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `subscribers` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stepfilter.md b/docs/models/components/stepfilter.md index d0394e8e..31739507 100644 --- a/docs/models/components/stepfilter.md +++ b/docs/models/components/stepfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `children` | [components.FieldFilterPart](../../models/components/fieldfilterpart.md)[] | :heavy_check_mark: | N/A | | `isNegated` | *boolean* | :heavy_check_mark: | N/A | -| `type` | [components.Type](../../models/components/type.md) | :heavy_check_mark: | N/A | -| `value` | [components.Value](../../models/components/value.md) | :heavy_check_mark: | N/A | -| `children` | [components.FieldFilterPart](../../models/components/fieldfilterpart.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.StepFilterType](../../models/components/stepfiltertype.md) | :heavy_check_mark: | N/A | +| `value` | [components.Value](../../models/components/value.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/subscriberchanneldto.md b/docs/models/components/subscriberchanneldto.md index 848ce9ec..54c8066f 100644 --- a/docs/models/components/subscriberchanneldto.md +++ b/docs/models/components/subscriberchanneldto.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `integrationIdentifier` | *string* | :heavy_minus_sign: | N/A | -| `providerId` | [components.ProviderId](../../models/components/providerid.md) | :heavy_check_mark: | N/A | -| `credentials` | [components.ChannelCredentialsDto](../../models/components/channelcredentialsdto.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `credentials` | [components.ChannelCredentialsDto](../../models/components/channelcredentialsdto.md) | :heavy_check_mark: | N/A | +| `integrationIdentifier` | *string* | :heavy_minus_sign: | N/A | +| `providerId` | [components.SubscriberChannelDtoProviderId](../../models/components/subscriberchanneldtoproviderid.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/subscriberpayloaddto.md b/docs/models/components/subscriberpayloaddto.md index 5db360b1..5c83af2e 100644 --- a/docs/models/components/subscriberpayloaddto.md +++ b/docs/models/components/subscriberpayloaddto.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `subscriberId` | *string* | :heavy_check_mark: | The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems | +| `avatar` | *string* | :heavy_minus_sign: | An http url to the profile image of your subscriber | +| `channels` | [components.SubscriberChannelDto](../../models/components/subscriberchanneldto.md)[] | :heavy_minus_sign: | N/A | +| `data` | [components.SubscriberPayloadDtoData](../../models/components/subscriberpayloaddtodata.md) | :heavy_minus_sign: | N/A | | `email` | *string* | :heavy_minus_sign: | N/A | | `firstName` | *string* | :heavy_minus_sign: | N/A | | `lastName` | *string* | :heavy_minus_sign: | N/A | -| `phone` | *string* | :heavy_minus_sign: | N/A | -| `avatar` | *string* | :heavy_minus_sign: | An http url to the profile image of your subscriber | | `locale` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.SubscriberPayloadDtoData](../../models/components/subscriberpayloaddtodata.md) | :heavy_minus_sign: | N/A | -| `channels` | [components.SubscriberChannelDto](../../models/components/subscriberchanneldto.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `phone` | *string* | :heavy_minus_sign: | N/A | +| `subscriberId` | *string* | :heavy_check_mark: | The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems | \ No newline at end of file diff --git a/docs/models/components/subscriberresponsedto.md b/docs/models/components/subscriberresponsedto.md index 490ca4b6..1d342ccf 100644 --- a/docs/models/components/subscriberresponsedto.md +++ b/docs/models/components/subscriberresponsedto.md @@ -5,20 +5,20 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `v` | *number* | :heavy_minus_sign: | N/A | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See `subscriberId` for that | -| `firstName` | *string* | :heavy_minus_sign: | N/A | -| `lastName` | *string* | :heavy_minus_sign: | N/A | -| `email` | *string* | :heavy_minus_sign: | N/A | -| `phone` | *string* | :heavy_minus_sign: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | | `avatar` | *string* | :heavy_minus_sign: | N/A | -| `locale` | *string* | :heavy_minus_sign: | N/A | -| `subscriberId` | *string* | :heavy_check_mark: | The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems | | `channels` | [components.ChannelSettings](../../models/components/channelsettings.md)[] | :heavy_minus_sign: | Channels settings for subscriber | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `deleted` | *boolean* | :heavy_check_mark: | N/A | +| `email` | *string* | :heavy_minus_sign: | N/A | +| `firstName` | *string* | :heavy_minus_sign: | N/A | | `isOnline` | *boolean* | :heavy_minus_sign: | N/A | +| `lastName` | *string* | :heavy_minus_sign: | N/A | | `lastOnlineAt` | *string* | :heavy_minus_sign: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `deleted` | *boolean* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `updatedAt` | *string* | :heavy_check_mark: | N/A | -| `v` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `locale` | *string* | :heavy_minus_sign: | N/A | +| `phone` | *string* | :heavy_minus_sign: | N/A | +| `subscriberId` | *string* | :heavy_check_mark: | The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems | +| `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/templateresponse.md b/docs/models/components/templateresponse.md index 6c6444c2..fee285e6 100644 --- a/docs/models/components/templateresponse.md +++ b/docs/models/components/templateresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | Unique identifier of the workflow | -| `name` | *string* | :heavy_check_mark: | Name of the workflow | | `critical` | *boolean* | :heavy_check_mark: | Critical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen | +| `name` | *string* | :heavy_check_mark: | Name of the workflow | | `triggers` | *string*[] | :heavy_check_mark: | Triggers are the events that will trigger the workflow. | \ No newline at end of file diff --git a/docs/models/components/tenantpayloaddto.md b/docs/models/components/tenantpayloaddto.md index e31c7e1d..fe6a6a86 100644 --- a/docs/models/components/tenantpayloaddto.md +++ b/docs/models/components/tenantpayloaddto.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `data` | [components.TenantPayloadDtoData](../../models/components/tenantpayloaddtodata.md) | :heavy_minus_sign: | N/A | | `identifier` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.TenantPayloadDtoData](../../models/components/tenantpayloaddtodata.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/timedconfig.md b/docs/models/components/timedconfig.md index 7d2b1b59..7dca0907 100644 --- a/docs/models/components/timedconfig.md +++ b/docs/models/components/timedconfig.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `atTime` | *string* | :heavy_minus_sign: | N/A | -| `weekDays` | [components.WeekDays](../../models/components/weekdays.md)[] | :heavy_minus_sign: | N/A | | `monthDays` | *string*[] | :heavy_minus_sign: | N/A | +| `monthlyType` | [components.MonthlyType](../../models/components/monthlytype.md) | :heavy_minus_sign: | N/A | | `ordinal` | [components.Ordinal](../../models/components/ordinal.md) | :heavy_minus_sign: | N/A | | `ordinalValue` | [components.OrdinalValue](../../models/components/ordinalvalue.md) | :heavy_minus_sign: | N/A | -| `monthlyType` | [components.MonthlyType](../../models/components/monthlytype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `weekDays` | [components.WeekDays](../../models/components/weekdays.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/topicdto.md b/docs/models/components/topicdto.md index 3f9dbfac..8e8f3ae4 100644 --- a/docs/models/components/topicdto.md +++ b/docs/models/components/topicdto.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | | `key` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `subscribers` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/topicsubscriberdto.md b/docs/models/components/topicsubscriberdto.md index f38ddd3e..3d2b1aab 100644 --- a/docs/models/components/topicsubscriberdto.md +++ b/docs/models/components/topicsubscriberdto.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `organizationId` | *string* | :heavy_check_mark: | N/A | | `environmentId` | *string* | :heavy_check_mark: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | | `subscriberId` | *string* | :heavy_check_mark: | N/A | | `topicId` | *string* | :heavy_check_mark: | N/A | -| `topicKey` | *string* | :heavy_check_mark: | N/A | -| `externalSubscriberId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `externalSubscriberId` | *string* | :heavy_check_mark: | N/A | +| `topicKey` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/triggereventrequestdto.md b/docs/models/components/triggereventrequestdto.md index dce01368..76da1d5a 100644 --- a/docs/models/components/triggereventrequestdto.md +++ b/docs/models/components/triggereventrequestdto.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `actor` | *components.Actor* | :heavy_minus_sign: | It is used to display the Avatar of the provided actor's subscriber id or actor object.
If a new actor object is provided, we will create a new subscriber in our system
| | | `name` | *string* | :heavy_check_mark: | The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page. | workflow_identifier | -| `payload` | [components.Payload](../../models/components/payload.md) | :heavy_minus_sign: | The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it.
This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. | {
"comment_id": "string",
"post": {
"text": "string"
}
} | -| `overrides` | [components.Overrides](../../models/components/overrides.md) | :heavy_minus_sign: | This could be used to override provider specific configurations | {
"fcm": {
"data": {
"key": "value"
}
}
} | +| `overrides` | [components.TriggerEventRequestDtoOverrides](../../models/components/triggereventrequestdtooverrides.md) | :heavy_minus_sign: | This could be used to override provider specific configurations | {
"fcm": {
"data": {
"key": "value"
}
}
} | +| `payload` | [components.TriggerEventRequestDtoPayload](../../models/components/triggereventrequestdtopayload.md) | :heavy_minus_sign: | The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it.
This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. | {
"comment_id": "string",
"post": {
"text": "string"
}
} | +| `tenant` | *components.Tenant* | :heavy_minus_sign: | It is used to specify a tenant context during trigger event.
Existing tenants will be updated with the provided details.
| | | `to` | *components.To*[] | :heavy_check_mark: | The recipients list of people who will receive the notification. | | -| `transactionId` | *string* | :heavy_minus_sign: | A unique identifier for this transaction, we will generated a UUID if not provided. | | -| `actor` | *components.Actor* | :heavy_minus_sign: | It is used to display the Avatar of the provided actor's subscriber id or actor object.
If a new actor object is provided, we will create a new subscriber in our system
| | -| `tenant` | *components.Tenant* | :heavy_minus_sign: | It is used to specify a tenant context during trigger event.
Existing tenants will be updated with the provided details.
| | \ No newline at end of file +| `transactionId` | *string* | :heavy_minus_sign: | A unique identifier for this transaction, we will generated a UUID if not provided. | | \ No newline at end of file diff --git a/docs/models/components/triggereventresponsedto.md b/docs/models/components/triggereventresponsedto.md index a449890d..449a85dd 100644 --- a/docs/models/components/triggereventresponsedto.md +++ b/docs/models/components/triggereventresponsedto.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `acknowledged` | *boolean* | :heavy_check_mark: | If trigger was acknowledged or not | -| `status` | [components.TriggerEventResponseDtoStatus](../../models/components/triggereventresponsedtostatus.md) | :heavy_check_mark: | Status for trigger | | `error` | *string*[] | :heavy_minus_sign: | In case of an error, this field will contain the error message | +| `status` | [components.TriggerEventResponseDtoStatus](../../models/components/triggereventresponsedtostatus.md) | :heavy_check_mark: | Status for trigger | | `transactionId` | *string* | :heavy_minus_sign: | Transaction id for trigger | \ No newline at end of file diff --git a/docs/models/components/triggereventtoallrequestdto.md b/docs/models/components/triggereventtoallrequestdto.md index 3e8a5b26..7e3fdab9 100644 --- a/docs/models/components/triggereventtoallrequestdto.md +++ b/docs/models/components/triggereventtoallrequestdto.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `actor` | *components.TriggerEventToAllRequestDtoActor* | :heavy_minus_sign: | It is used to display the Avatar of the provided actor's subscriber id or actor object.
If a new actor object is provided, we will create a new subscriber in our system
| | | `name` | *string* | :heavy_check_mark: | The trigger identifier associated for the template you wish to send. This identifier can be found on the template page. | | -| `payload` | [components.TriggerEventToAllRequestDtoPayload](../../models/components/triggereventtoallrequestdtopayload.md) | :heavy_check_mark: | The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it.
This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. | {
"comment_id": "string",
"post": {
"text": "string"
}
} | | `overrides` | [components.TriggerEventToAllRequestDtoOverrides](../../models/components/triggereventtoallrequestdtooverrides.md) | :heavy_minus_sign: | This could be used to override provider specific configurations | {
"fcm": {
"data": {
"key": "value"
}
}
} | -| `transactionId` | *string* | :heavy_minus_sign: | A unique identifier for this transaction, we will generated a UUID if not provided. | | -| `actor` | *components.TriggerEventToAllRequestDtoActor* | :heavy_minus_sign: | It is used to display the Avatar of the provided actor's subscriber id or actor object.
If a new actor object is provided, we will create a new subscriber in our system
| | -| `tenant` | *components.TriggerEventToAllRequestDtoTenant* | :heavy_minus_sign: | It is used to specify a tenant context during trigger event.
If a new tenant object is provided, we will create a new tenant.
| | \ No newline at end of file +| `payload` | [components.TriggerEventToAllRequestDtoPayload](../../models/components/triggereventtoallrequestdtopayload.md) | :heavy_check_mark: | The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it.
This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. | {
"comment_id": "string",
"post": {
"text": "string"
}
} | +| `tenant` | *components.TriggerEventToAllRequestDtoTenant* | :heavy_minus_sign: | It is used to specify a tenant context during trigger event.
If a new tenant object is provided, we will create a new tenant.
| | +| `transactionId` | *string* | :heavy_minus_sign: | A unique identifier for this transaction, we will generated a UUID if not provided. | | \ No newline at end of file diff --git a/docs/models/components/type.md b/docs/models/components/type.md index 89e98b5f..38f42197 100644 --- a/docs/models/components/type.md +++ b/docs/models/components/type.md @@ -3,13 +3,13 @@ ## Values -| Name | Value | -| ----------- | ----------- | -| `Boolean` | BOOLEAN | -| `Text` | TEXT | -| `Date` | DATE | -| `Number` | NUMBER | -| `Statement` | STATEMENT | -| `List` | LIST | -| `MultiList` | MULTI_LIST | -| `Group` | GROUP | \ No newline at end of file +| Name | Value | +| ---------------------- | ---------------------- | +| `Feed` | Feed | +| `MessageTemplate` | MessageTemplate | +| `Layout` | Layout | +| `DefaultLayout` | DefaultLayout | +| `NotificationTemplate` | NotificationTemplate | +| `NotificationGroup` | NotificationGroup | +| `TranslationGroup` | TranslationGroup | +| `Translation` | Translation | \ No newline at end of file diff --git a/docs/models/components/updatebrandingdetailsdto.md b/docs/models/components/updatebrandingdetailsdto.md index cff1d471..f9ead1bc 100644 --- a/docs/models/components/updatebrandingdetailsdto.md +++ b/docs/models/components/updatebrandingdetailsdto.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `logo` | *string* | :heavy_check_mark: | N/A | | `color` | *string* | :heavy_check_mark: | N/A | -| `fontColor` | *string* | :heavy_check_mark: | N/A | | `contentBackground` | *string* | :heavy_check_mark: | N/A | -| `fontFamily` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `fontColor` | *string* | :heavy_check_mark: | N/A | +| `fontFamily` | *string* | :heavy_minus_sign: | N/A | +| `logo` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/updateintegrationrequestdto.md b/docs/models/components/updateintegrationrequestdto.md index 6e0d9d93..78493d90 100644 --- a/docs/models/components/updateintegrationrequestdto.md +++ b/docs/models/components/updateintegrationrequestdto.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `identifier` | *string* | :heavy_minus_sign: | N/A | | `environmentId` | *string* | :heavy_minus_sign: | N/A | | `active` | *boolean* | :heavy_minus_sign: | If the integration is active the validation on the credentials field will run | -| `credentials` | [components.CredentialsDto](../../models/components/credentialsdto.md) | :heavy_minus_sign: | N/A | | `check` | *boolean* | :heavy_minus_sign: | N/A | -| `conditions` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `conditions` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_minus_sign: | N/A | +| `credentials` | [components.CredentialsDto](../../models/components/credentialsdto.md) | :heavy_minus_sign: | N/A | +| `identifier` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/updatelayoutrequestdto.md b/docs/models/components/updatelayoutrequestdto.md index 411e40d0..6b9c1dc2 100644 --- a/docs/models/components/updatelayoutrequestdto.md +++ b/docs/models/components/updatelayoutrequestdto.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | User defined custom name and provided by the user that will name the Layout updated. | -| `identifier` | *string* | :heavy_check_mark: | User defined custom key that will be a unique identifier for the Layout updated. | -| `description` | *string* | :heavy_minus_sign: | User defined description of the layout | | `content` | *string* | :heavy_minus_sign: | User defined content for the layout. | -| `variables` | [components.UpdateLayoutRequestDtoVariables](../../models/components/updatelayoutrequestdtovariables.md)[] | :heavy_minus_sign: | User defined variables to render in the layout placeholders. | -| `isDefault` | *boolean* | :heavy_minus_sign: | Variable that defines if the layout is chosen as default when creating a layout. | \ No newline at end of file +| `description` | *string* | :heavy_minus_sign: | User defined description of the layout | +| `identifier` | *string* | :heavy_check_mark: | User defined custom key that will be a unique identifier for the Layout updated. | +| `isDefault` | *boolean* | :heavy_minus_sign: | Variable that defines if the layout is chosen as default when creating a layout. | +| `name` | *string* | :heavy_minus_sign: | User defined custom name and provided by the user that will name the Layout updated. | +| `variables` | [components.UpdateLayoutRequestDtoVariables](../../models/components/updatelayoutrequestdtovariables.md)[] | :heavy_minus_sign: | User defined variables to render in the layout placeholders. | \ No newline at end of file diff --git a/docs/models/components/updatelayoutresponsedto.md b/docs/models/components/updatelayoutresponsedto.md index 599a85a7..8ba0ec6a 100644 --- a/docs/models/components/updatelayoutresponsedto.md +++ b/docs/models/components/updatelayoutresponsedto.md @@ -5,19 +5,19 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `creatorId` | *string* | :heavy_check_mark: | N/A | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `creatorId` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `identifier` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | +| `parentId` | *string* | :heavy_minus_sign: | N/A | | `channel` | [components.UpdateLayoutResponseDtoChannel](../../models/components/updatelayoutresponsedtochannel.md) | :heavy_check_mark: | N/A | | `content` | *string* | :heavy_check_mark: | N/A | | `contentType` | *string* | :heavy_check_mark: | N/A | -| `variables` | [components.UpdateLayoutResponseDtoVariables](../../models/components/updatelayoutresponsedtovariables.md)[] | :heavy_minus_sign: | N/A | +| `createdAt` | *string* | :heavy_minus_sign: | N/A | +| `description` | *string* | :heavy_minus_sign: | N/A | +| `identifier` | *string* | :heavy_check_mark: | N/A | | `isDefault` | *boolean* | :heavy_check_mark: | N/A | | `isDeleted` | *boolean* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_minus_sign: | N/A | -| `parentId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `variables` | [components.UpdateLayoutResponseDtoVariables](../../models/components/updatelayoutresponsedtovariables.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/updatesubscriberchannelrequestdto.md b/docs/models/components/updatesubscriberchannelrequestdto.md index 1c1f5e8c..0bdf07bc 100644 --- a/docs/models/components/updatesubscriberchannelrequestdto.md +++ b/docs/models/components/updatesubscriberchannelrequestdto.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `providerId` | [components.UpdateSubscriberChannelRequestDtoProviderId](../../models/components/updatesubscriberchannelrequestdtoproviderid.md) | :heavy_check_mark: | The provider identifier for the credentials | +| `credentials` | [components.ChannelCredentials](../../models/components/channelcredentials.md) | :heavy_check_mark: | Credentials payload for the specified provider | | `integrationIdentifier` | *string* | :heavy_minus_sign: | The integration identifier | -| `credentials` | [components.ChannelCredentials](../../models/components/channelcredentials.md) | :heavy_check_mark: | Credentials payload for the specified provider | \ No newline at end of file +| `providerId` | [components.UpdateSubscriberChannelRequestDtoProviderId](../../models/components/updatesubscriberchannelrequestdtoproviderid.md) | :heavy_check_mark: | The provider identifier for the credentials | \ No newline at end of file diff --git a/docs/models/components/updatesubscriberpreferenceresponsedto.md b/docs/models/components/updatesubscriberpreferenceresponsedto.md index 4d8e3c04..5241aea4 100644 --- a/docs/models/components/updatesubscriberpreferenceresponsedto.md +++ b/docs/models/components/updatesubscriberpreferenceresponsedto.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `template` | [components.TemplateResponse](../../models/components/templateresponse.md) | :heavy_check_mark: | The workflow information and if it is critical or not | -| `preference` | [components.Preference](../../models/components/preference.md) | :heavy_check_mark: | The preferences of the subscriber regarding the related workflow | \ No newline at end of file +| `preference` | [components.Preference](../../models/components/preference.md) | :heavy_check_mark: | The preferences of the subscriber regarding the related workflow | +| `template` | [components.TemplateResponse](../../models/components/templateresponse.md) | :heavy_check_mark: | The workflow information and if it is critical or not | \ No newline at end of file diff --git a/docs/models/components/updatesubscriberrequestdto.md b/docs/models/components/updatesubscriberrequestdto.md index 960cf2d8..950ffb51 100644 --- a/docs/models/components/updatesubscriberrequestdto.md +++ b/docs/models/components/updatesubscriberrequestdto.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `avatar` | *string* | :heavy_minus_sign: | N/A | +| `data` | [components.UpdateSubscriberRequestDtoData](../../models/components/updatesubscriberrequestdtodata.md) | :heavy_minus_sign: | N/A | | `email` | *string* | :heavy_minus_sign: | N/A | | `firstName` | *string* | :heavy_minus_sign: | N/A | | `lastName` | *string* | :heavy_minus_sign: | N/A | -| `phone` | *string* | :heavy_minus_sign: | N/A | -| `avatar` | *string* | :heavy_minus_sign: | N/A | | `locale` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.UpdateSubscriberRequestDtoData](../../models/components/updatesubscriberrequestdtodata.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `phone` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/updatetenantrequestdto.md b/docs/models/components/updatetenantrequestdto.md index bd6e923a..19f63a8d 100644 --- a/docs/models/components/updatetenantrequestdto.md +++ b/docs/models/components/updatetenantrequestdto.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `data` | [components.UpdateTenantRequestDtoData](../../models/components/updatetenantrequestdtodata.md) | :heavy_minus_sign: | N/A | | `identifier` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.UpdateTenantRequestDtoData](../../models/components/updatetenantrequestdtodata.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/updatetenantresponsedto.md b/docs/models/components/updatetenantresponsedto.md index a7c50fe9..5f054415 100644 --- a/docs/models/components/updatetenantresponsedto.md +++ b/docs/models/components/updatetenantresponsedto.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `environmentId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | +| `createdAt` | *string* | :heavy_check_mark: | N/A | +| `data` | [components.UpdateTenantResponseDtoData](../../models/components/updatetenantresponsedtodata.md) | :heavy_minus_sign: | N/A | | `identifier` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_minus_sign: | N/A | -| `data` | [components.UpdateTenantResponseDtoData](../../models/components/updatetenantresponsedtodata.md) | :heavy_minus_sign: | N/A | -| `environmentId` | *string* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/updateworkflowrequestdto.md b/docs/models/components/updateworkflowrequestdto.md index 74c39cf7..6b4e37f4 100644 --- a/docs/models/components/updateworkflowrequestdto.md +++ b/docs/models/components/updateworkflowrequestdto.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `tags` | *string*[] | :heavy_minus_sign: | N/A | +| `critical` | *boolean* | :heavy_minus_sign: | N/A | +| `data` | [components.UpdateWorkflowRequestDtoData](../../models/components/updateworkflowrequestdtodata.md) | :heavy_minus_sign: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `identifier` | *string* | :heavy_minus_sign: | N/A | -| `steps` | [components.NotificationStep](../../models/components/notificationstep.md)[] | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | | `notificationGroupId` | *string* | :heavy_check_mark: | N/A | -| `critical` | *boolean* | :heavy_minus_sign: | N/A | | `preferenceSettings` | [components.PreferenceChannels](../../models/components/preferencechannels.md) | :heavy_minus_sign: | N/A | -| `data` | [components.UpdateWorkflowRequestDtoData](../../models/components/updateworkflowrequestdtodata.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `steps` | [components.NotificationStep](../../models/components/notificationstep.md)[] | :heavy_minus_sign: | N/A | +| `tags` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/variablesresponsedto.md b/docs/models/components/variablesresponsedto.md index 16b15da8..034ffa8c 100644 --- a/docs/models/components/variablesresponsedto.md +++ b/docs/models/components/variablesresponsedto.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `translations` | [components.Translations](../../models/components/translations.md) | :heavy_check_mark: | N/A | -| `system` | [components.System](../../models/components/system.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `system` | [components.System](../../models/components/system.md) | :heavy_check_mark: | N/A | +| `translations` | [components.Translations](../../models/components/translations.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/workflowresponse.md b/docs/models/components/workflowresponse.md index 2585ee13..eac54f88 100644 --- a/docs/models/components/workflowresponse.md +++ b/docs/models/components/workflowresponse.md @@ -5,24 +5,24 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_check_mark: | N/A | -| `active` | *boolean* | :heavy_check_mark: | N/A | -| `draft` | *boolean* | :heavy_check_mark: | N/A | -| `preferenceSettings` | [components.PreferenceChannels](../../models/components/preferencechannels.md) | :heavy_check_mark: | N/A | -| `critical` | *boolean* | :heavy_check_mark: | N/A | -| `tags` | *string*[] | :heavy_check_mark: | N/A | -| `steps` | [components.NotificationStep](../../models/components/notificationstep.md)[] | :heavy_check_mark: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | | `creatorId` | *string* | :heavy_check_mark: | N/A | | `environmentId` | *string* | :heavy_check_mark: | N/A | -| `triggers` | [components.NotificationTrigger](../../models/components/notificationtrigger.md)[] | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | | `notificationGroupId` | *string* | :heavy_check_mark: | N/A | +| `organizationId` | *string* | :heavy_check_mark: | N/A | | `parentId` | *string* | :heavy_minus_sign: | N/A | +| `active` | *boolean* | :heavy_check_mark: | N/A | +| `critical` | *boolean* | :heavy_check_mark: | N/A | +| `data` | [components.WorkflowResponseData](../../models/components/workflowresponsedata.md) | :heavy_minus_sign: | N/A | | `deleted` | *boolean* | :heavy_check_mark: | N/A | | `deletedAt` | *string* | :heavy_check_mark: | N/A | | `deletedBy` | *string* | :heavy_check_mark: | N/A | +| `description` | *string* | :heavy_check_mark: | N/A | +| `draft` | *boolean* | :heavy_check_mark: | N/A | +| `name` | *string* | :heavy_check_mark: | N/A | | `notificationGroup` | [components.NotificationGroup](../../models/components/notificationgroup.md) | :heavy_minus_sign: | N/A | -| `data` | [components.Data](../../models/components/data.md) | :heavy_minus_sign: | N/A | +| `preferenceSettings` | [components.PreferenceChannels](../../models/components/preferencechannels.md) | :heavy_check_mark: | N/A | +| `steps` | [components.NotificationStep](../../models/components/notificationstep.md)[] | :heavy_check_mark: | N/A | +| `tags` | *string*[] | :heavy_check_mark: | N/A | +| `triggers` | [components.NotificationTrigger](../../models/components/notificationtrigger.md)[] | :heavy_check_mark: | N/A | | `workflowIntegrationStatus` | [components.WorkflowIntegrationStatus](../../models/components/workflowintegrationstatus.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/workflowsresponsedto.md b/docs/models/components/workflowsresponsedto.md index 57ef0f34..20842edd 100644 --- a/docs/models/components/workflowsresponsedto.md +++ b/docs/models/components/workflowsresponsedto.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `totalCount` | *number* | :heavy_check_mark: | N/A | | `data` | [components.WorkflowResponse](../../models/components/workflowresponse.md)[] | :heavy_check_mark: | N/A | +| `page` | *number* | :heavy_check_mark: | N/A | | `pageSize` | *number* | :heavy_check_mark: | N/A | -| `page` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/channel.md b/docs/models/operations/channel.md index e94defd2..1f3bfe77 100644 --- a/docs/models/operations/channel.md +++ b/docs/models/operations/channel.md @@ -1,5 +1,7 @@ # Channel +The channel of the message to be deleted + ## Values diff --git a/docs/models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md b/docs/models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md index ad067f6e..7dc3f11c 100644 --- a/docs/models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md +++ b/docs/models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `channel` | [operations.QueryParamChannel](../../models/operations/queryparamchannel.md) | :heavy_minus_sign: | The channel of the message to be deleted | -| `transactionId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `channel` | [operations.Channel](../../models/operations/channel.md) | :heavy_minus_sign: | The channel of the message to be deleted | +| `transactionId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/messagescontrollergetmessagesrequest.md b/docs/models/operations/messagescontrollergetmessagesrequest.md index a8d22e0f..729249a6 100644 --- a/docs/models/operations/messagescontrollergetmessagesrequest.md +++ b/docs/models/operations/messagescontrollergetmessagesrequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `channel` | [operations.Channel](../../models/operations/channel.md) | :heavy_minus_sign: | N/A | -| `subscriberId` | *string* | :heavy_minus_sign: | N/A | -| `transactionId` | *string*[] | :heavy_minus_sign: | N/A | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `limit` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `channel` | [operations.QueryParamChannel](../../models/operations/queryparamchannel.md) | :heavy_minus_sign: | N/A | +| `subscriberId` | *string* | :heavy_minus_sign: | N/A | +| `transactionId` | *string*[] | :heavy_minus_sign: | N/A | +| `page` | *number* | :heavy_minus_sign: | N/A | +| `limit` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/queryparamchannel.md b/docs/models/operations/queryparamchannel.md index 3f8d605e..35e6c229 100644 --- a/docs/models/operations/queryparamchannel.md +++ b/docs/models/operations/queryparamchannel.md @@ -1,7 +1,5 @@ # QueryParamChannel -The channel of the message to be deleted - ## Values diff --git a/docs/models/operations/subscriberscontrollergetnotificationsfeedresponsebody.md b/docs/models/operations/subscriberscontrollergetnotificationsfeedresponsebody.md index 28f7c164..a48b5aeb 100644 --- a/docs/models/operations/subscriberscontrollergetnotificationsfeedresponsebody.md +++ b/docs/models/operations/subscriberscontrollergetnotificationsfeedresponsebody.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `page` | *number* | :heavy_check_mark: | The current page of the paginated response | +| `data` | [components.FeedResponseDto](../../models/components/feedresponsedto.md)[] | :heavy_check_mark: | N/A | | `hasMore` | *boolean* | :heavy_check_mark: | Does the list have more items to fetch | -| `pageSize` | *number* | :heavy_check_mark: | Number of items on each page | -| `data` | [components.FeedResponseDto](../../models/components/feedresponsedto.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `page` | *number* | :heavy_check_mark: | The current page of the paginated response | +| `pageSize` | *number* | :heavy_check_mark: | Number of items on each page | \ No newline at end of file diff --git a/docs/models/operations/subscriberscontrollerlistsubscribersresponsebody.md b/docs/models/operations/subscriberscontrollerlistsubscribersresponsebody.md index 38eb0daf..3dd32484 100644 --- a/docs/models/operations/subscriberscontrollerlistsubscribersresponsebody.md +++ b/docs/models/operations/subscriberscontrollerlistsubscribersresponsebody.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `page` | *number* | :heavy_check_mark: | The current page of the paginated response | +| `data` | [components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)[] | :heavy_check_mark: | N/A | | `hasMore` | *boolean* | :heavy_check_mark: | Does the list have more items to fetch | -| `pageSize` | *number* | :heavy_check_mark: | Number of items on each page | -| `data` | [components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `page` | *number* | :heavy_check_mark: | The current page of the paginated response | +| `pageSize` | *number* | :heavy_check_mark: | Number of items on each page | \ No newline at end of file diff --git a/docs/models/operations/tenantcontrollerlisttenantsresponsebody.md b/docs/models/operations/tenantcontrollerlisttenantsresponsebody.md index cc1393fa..2238c6c4 100644 --- a/docs/models/operations/tenantcontrollerlisttenantsresponsebody.md +++ b/docs/models/operations/tenantcontrollerlisttenantsresponsebody.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `page` | *number* | :heavy_check_mark: | The current page of the paginated response | +| `data` | [components.GetTenantResponseDto](../../models/components/gettenantresponsedto.md)[] | :heavy_check_mark: | N/A | | `hasMore` | *boolean* | :heavy_check_mark: | Does the list have more items to fetch | -| `pageSize` | *number* | :heavy_check_mark: | Number of items on each page | -| `data` | [components.GetTenantResponseDto](../../models/components/gettenantresponsedto.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `page` | *number* | :heavy_check_mark: | The current page of the paginated response | +| `pageSize` | *number* | :heavy_check_mark: | Number of items on each page | \ No newline at end of file diff --git a/docs/sdks/authentication/README.md b/docs/sdks/authentication/README.md index 6fc0f976..98ee1dfe 100644 --- a/docs/sdks/authentication/README.md +++ b/docs/sdks/authentication/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [chatAccessOauthCallBack](#chataccessoauthcallback) - Handle providers oauth redirect * [chatAccessOauth](#chataccessoauth) - Handle chat oauth +* [chatAccessOauthCallBack](#chataccessoauthcallback) - Handle providers oauth redirect -## chatAccessOauthCallBack +## chatAccessOauth -Handle providers oauth redirect +Handle chat oauth ### Example Usage @@ -20,16 +20,14 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.authentication.chatAccessOauthCallBack({ + await novu.subscribers.authentication.chatAccessOauth({ subscriberId: "", providerId: "", - code: "", hmacHash: "", environmentId: "", }); - // Handle the result - console.log(result) + } run(); @@ -39,7 +37,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SubscribersControllerChatOauthCallbackRequest](../../models/operations/subscriberscontrollerchatoauthcallbackrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.SubscribersControllerChatAccessOauthRequest](../../models/operations/subscriberscontrollerchataccessoauthrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -47,16 +45,16 @@ run(); ### Response -**Promise\<[operations.SubscribersControllerChatOauthCallbackResponseBody](../../models/operations/subscriberscontrollerchatoauthcallbackresponsebody.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## chatAccessOauth +## chatAccessOauthCallBack -Handle chat oauth +Handle providers oauth redirect ### Example Usage @@ -68,14 +66,16 @@ const novu = new Novu({ }); async function run() { - await novu.subscribers.authentication.chatAccessOauth({ + const result = await novu.subscribers.authentication.chatAccessOauthCallBack({ subscriberId: "", providerId: "", + code: "", hmacHash: "", environmentId: "", }); - + // Handle the result + console.log(result) } run(); @@ -85,7 +85,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SubscribersControllerChatAccessOauthRequest](../../models/operations/subscriberscontrollerchataccessoauthrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.SubscribersControllerChatOauthCallbackRequest](../../models/operations/subscriberscontrollerchatoauthcallbackrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -93,7 +93,7 @@ run(); ### Response -**Promise\** +**Promise\<[operations.SubscribersControllerChatOauthCallbackResponseBody](../../models/operations/subscriberscontrollerchatoauthcallbackresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/branding/README.md b/docs/sdks/branding/README.md index f0f13bcf..ceb17018 100644 --- a/docs/sdks/branding/README.md +++ b/docs/sdks/branding/README.md @@ -20,10 +20,10 @@ const novu = new Novu({ async function run() { const result = await novu.organizations.branding.update({ - logo: "", color: "fuchsia", - fontColor: "", contentBackground: "", + fontColor: "", + logo: "", }); // Handle the result diff --git a/docs/sdks/changes/README.md b/docs/sdks/changes/README.md index 23950e2c..a8226938 100644 --- a/docs/sdks/changes/README.md +++ b/docs/sdks/changes/README.md @@ -8,14 +8,14 @@ Changes represent a change in state of an environment. They are analagous to a p ### Available Operations -* [retrieve](#retrieve) - Get changes -* [count](#count) - Get changes count -* [applyBulk](#applybulk) - Apply changes * [apply](#apply) - Apply change +* [applyBulk](#applybulk) - Apply changes +* [count](#count) - Get changes count +* [retrieve](#retrieve) - Get changes -## retrieve +## apply -Get changes +Apply change ### Example Usage @@ -27,9 +27,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.changes.retrieve({ - promoted: "false", - }); + const result = await novu.changes.apply(""); // Handle the result console.log(result) @@ -42,7 +40,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ChangesControllerGetChangesRequest](../../models/operations/changescontrollergetchangesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `changeId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -50,16 +48,16 @@ run(); ### Response -**Promise\<[components.ChangesResponseDto](../../models/components/changesresponsedto.md)\>** +**Promise\<[components.ChangeResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## count +## applyBulk -Get changes count +Apply changes ### Example Usage @@ -71,7 +69,11 @@ const novu = new Novu({ }); async function run() { - const result = await novu.changes.count(); + const result = await novu.changes.applyBulk({ + changeIds: [ + "", + ], + }); // Handle the result console.log(result) @@ -84,6 +86,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.BulkApplyChangeDto](../../models/components/bulkapplychangedto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -91,16 +94,16 @@ run(); ### Response -**Promise\<[components.DataNumberDto](../../models/components/datanumberdto.md)\>** +**Promise\<[components.ChangeResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## applyBulk +## count -Apply changes +Get changes count ### Example Usage @@ -112,11 +115,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.changes.applyBulk({ - changeIds: [ - "", - ], - }); + const result = await novu.changes.count(); // Handle the result console.log(result) @@ -129,7 +128,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.BulkApplyChangeDto](../../models/components/bulkapplychangedto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -137,16 +135,16 @@ run(); ### Response -**Promise\<[components.ChangeResponseDto[]](../../models/.md)\>** +**Promise\<[components.DataNumberDto](../../models/components/datanumberdto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## apply +## retrieve -Apply change +Get changes ### Example Usage @@ -158,7 +156,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.changes.apply(""); + const result = await novu.changes.retrieve({ + promoted: "false", + }); // Handle the result console.log(result) @@ -171,7 +171,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `changeId` | *string* | :heavy_check_mark: | N/A | +| `request` | [operations.ChangesControllerGetChangesRequest](../../models/operations/changescontrollergetchangesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -179,7 +179,7 @@ run(); ### Response -**Promise\<[components.ChangeResponseDto[]](../../models/.md)\>** +**Promise\<[components.ChangesResponseDto](../../models/components/changesresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/credentials/README.md b/docs/sdks/credentials/README.md index 39b9f99a..92094d3b 100644 --- a/docs/sdks/credentials/README.md +++ b/docs/sdks/credentials/README.md @@ -3,13 +3,14 @@ ### Available Operations -* [update](#update) - Update subscriber credentials * [append](#append) - Modify subscriber credentials * [delete](#delete) - Delete subscriber credentials by providerId +* [update](#update) - Update subscriber credentials -## update +## append Subscriber credentials associated to the delivery methods such as slack and push tokens. + This endpoint appends provided credentials and deviceTokens to the existing ones. ### Example Usage @@ -22,11 +23,11 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.credentials.update("", { - providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad, + const result = await novu.subscribers.credentials.append("", { credentials: { webhookUrl: "", }, + providerId: UpdateSubscriberChannelRequestDtoProviderId.Zulip, }); // Handle the result @@ -56,31 +57,23 @@ run(); | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## append +## delete -Subscriber credentials associated to the delivery methods such as slack and push tokens. - This endpoint appends provided credentials and deviceTokens to the existing ones. +Delete subscriber credentials such as slack and expo tokens. ### Example Usage ```typescript import { Novu } from "novu-sdk"; -import { UpdateSubscriberChannelRequestDtoProviderId } from "novu-sdk/models/components"; const novu = new Novu({ apiKey: "", }); async function run() { - const result = await novu.subscribers.credentials.append("", { - providerId: UpdateSubscriberChannelRequestDtoProviderId.Zulip, - credentials: { - webhookUrl: "", - }, - }); + await novu.subscribers.credentials.delete("", ""); - // Handle the result - console.log(result) + } run(); @@ -91,7 +84,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `updateSubscriberChannelRequestDto` | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.md) | :heavy_check_mark: | N/A | +| `providerId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -99,30 +92,37 @@ run(); ### Response -**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## update -Delete subscriber credentials such as slack and expo tokens. +Subscriber credentials associated to the delivery methods such as slack and push tokens. ### Example Usage ```typescript import { Novu } from "novu-sdk"; +import { UpdateSubscriberChannelRequestDtoProviderId } from "novu-sdk/models/components"; const novu = new Novu({ apiKey: "", }); async function run() { - await novu.subscribers.credentials.delete("", ""); + const result = await novu.subscribers.credentials.update("", { + credentials: { + webhookUrl: "", + }, + providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad, + }); - + // Handle the result + console.log(result) } run(); @@ -133,7 +133,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `providerId` | *string* | :heavy_check_mark: | N/A | +| `updateSubscriberChannelRequestDto` | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -141,7 +141,7 @@ run(); ### Response -**Promise\** +**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/environments/README.md b/docs/sdks/environments/README.md index 292d977e..1553c198 100644 --- a/docs/sdks/environments/README.md +++ b/docs/sdks/environments/README.md @@ -8,12 +8,12 @@ Novu uses the concept of environments to ensure logical separation of your data ### Available Operations -* [retrieve](#retrieve) - Get current environment * [list](#list) - Get environments +* [retrieve](#retrieve) - Get current environment -## retrieve +## list -Get current environment +Get environments ### Example Usage @@ -25,7 +25,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.environments.retrieve(); + const result = await novu.environments.list(); // Handle the result console.log(result) @@ -45,16 +45,16 @@ run(); ### Response -**Promise\<[components.EnvironmentResponseDto](../../models/components/environmentresponsedto.md)\>** +**Promise\<[components.EnvironmentResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## list +## retrieve -Get environments +Get current environment ### Example Usage @@ -66,7 +66,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.environments.list(); + const result = await novu.environments.retrieve(); // Handle the result console.log(result) @@ -86,7 +86,7 @@ run(); ### Response -**Promise\<[components.EnvironmentResponseDto[]](../../models/.md)\>** +**Promise\<[components.EnvironmentResponseDto](../../models/components/environmentresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/events/README.md b/docs/sdks/events/README.md index 2884ac9b..c432c747 100644 --- a/docs/sdks/events/README.md +++ b/docs/sdks/events/README.md @@ -8,41 +8,29 @@ Events represent a change in state of a subscriber. They are used to trigger wor ### Available Operations +* [cancel](#cancel) - Cancel triggered event * [trigger](#trigger) - Trigger event -* [triggerBulk](#triggerbulk) - Bulk trigger event * [triggerBroadcast](#triggerbroadcast) - Broadcast event to all -* [cancel](#cancel) - Cancel triggered event +* [triggerBulk](#triggerbulk) - Bulk trigger event -## trigger +## cancel - 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. + Using a previously generated transactionId during the event trigger, + will cancel any active or pending workflows. This is useful to cancel active digests, delays etc... ### Example Usage ```typescript import { Novu } from "novu-sdk"; -import { TopicPayloadDtoType } from "novu-sdk/models/components"; const novu = new Novu({ apiKey: "", }); async function run() { - const result = await novu.events.trigger({ - name: "workflow_identifier", - payload: {}, - overrides: {}, - to: [ - { - topicKey: "topic_key", - type: TopicPayloadDtoType.Topic, - }, - ], - }); + const result = await novu.events.cancel(""); // Handle the result console.log(result) @@ -55,7 +43,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.TriggerEventRequestDto](../../models/components/triggereventrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `transactionId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -63,18 +51,19 @@ run(); ### Response -**Promise\<[components.TriggerEventResponseDto](../../models/components/triggereventresponsedto.md)\>** +**Promise\<[components.DataBooleanDto](../../models/components/databooleandto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## triggerBulk +## trigger - Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. - The bulk API is limited to 100 events per request. + 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. ### Example Usage @@ -88,19 +77,15 @@ const novu = new Novu({ }); async function run() { - const result = await novu.events.triggerBulk({ - events: [ - { - name: "workflow_identifier", - payload: {}, - overrides: {}, - to: [ - { - topicKey: "topic_key", - type: TopicPayloadDtoType.Topic, - }, - ], - }, + const result = await novu.events.trigger({ + name: "workflow_identifier", + overrides: {}, + payload: {}, + to: [ + { + topicKey: "topic_key", + type: TopicPayloadDtoType.Topic, + }, ], }); @@ -115,7 +100,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.BulkTriggerEventDto](../../models/components/bulktriggereventdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [components.TriggerEventRequestDto](../../models/components/triggereventrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -123,7 +108,7 @@ run(); ### Response -**Promise\<[components.TriggerEventResponseDto[]](../../models/.md)\>** +**Promise\<[components.TriggerEventResponseDto](../../models/components/triggereventresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -147,8 +132,8 @@ const novu = new Novu({ async function run() { const result = await novu.events.triggerBroadcast({ name: "", - payload: {}, overrides: {}, + payload: {}, }); // Handle the result @@ -177,24 +162,39 @@ run(); | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## cancel +## triggerBulk - Using a previously generated transactionId during the event trigger, - will cancel any active or pending workflows. This is useful to cancel active digests, delays etc... + Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. + The bulk API is limited to 100 events per request. ### Example Usage ```typescript import { Novu } from "novu-sdk"; +import { TopicPayloadDtoType } from "novu-sdk/models/components"; const novu = new Novu({ apiKey: "", }); async function run() { - const result = await novu.events.cancel(""); + const result = await novu.events.triggerBulk({ + events: [ + { + name: "workflow_identifier", + overrides: {}, + payload: {}, + to: [ + { + topicKey: "topic_key", + type: TopicPayloadDtoType.Topic, + }, + ], + }, + ], + }); // Handle the result console.log(result) @@ -207,7 +207,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `transactionId` | *string* | :heavy_check_mark: | N/A | +| `request` | [components.BulkTriggerEventDto](../../models/components/bulktriggereventdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -215,7 +215,7 @@ run(); ### Response -**Promise\<[components.DataBooleanDto](../../models/components/databooleandto.md)\>** +**Promise\<[components.TriggerEventResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/feeds/README.md b/docs/sdks/feeds/README.md index 22758f05..13cca04e 100644 --- a/docs/sdks/feeds/README.md +++ b/docs/sdks/feeds/README.md @@ -8,13 +8,13 @@ Novu provides a notification activity feed that monitors every outgoing message ### Available Operations -* [retrieve](#retrieve) - Get feeds * [create](#create) - Create feed * [delete](#delete) - Delete feed +* [retrieve](#retrieve) - Get feeds -## retrieve +## create -Get feeds +Create feed ### Example Usage @@ -26,7 +26,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.feeds.retrieve(); + const result = await novu.feeds.create({ + name: "", + }); // Handle the result console.log(result) @@ -39,6 +41,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.CreateFeedRequestDto](../../models/components/createfeedrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -46,16 +49,16 @@ run(); ### Response -**Promise\<[components.FeedResponseDto[]](../../models/.md)\>** +**Promise\<[components.FeedResponseDto](../../models/components/feedresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## delete -Create feed +Delete feed ### Example Usage @@ -67,9 +70,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.feeds.create({ - name: "", - }); + const result = await novu.feeds.delete(""); // Handle the result console.log(result) @@ -82,7 +83,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateFeedRequestDto](../../models/components/createfeedrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `feedId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -90,16 +91,16 @@ run(); ### Response -**Promise\<[components.FeedResponseDto](../../models/components/feedresponsedto.md)\>** +**Promise\<[components.FeedResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## retrieve -Delete feed +Get feeds ### Example Usage @@ -111,7 +112,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.feeds.delete(""); + const result = await novu.feeds.retrieve(); // Handle the result console.log(result) @@ -124,7 +125,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `feedId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | diff --git a/docs/sdks/integrations/README.md b/docs/sdks/integrations/README.md index 4e3533fa..3c240247 100644 --- a/docs/sdks/integrations/README.md +++ b/docs/sdks/integrations/README.md @@ -8,28 +8,32 @@ With the help of the Integration Store, you can easily integrate your favorite d ### Available Operations -* [list](#list) - Get integrations * [create](#create) - Create integration -* [listActive](#listactive) - Get active integrations -* [update](#update) - Update integration * [delete](#delete) - Delete integration +* [list](#list) - Get integrations +* [listActive](#listactive) - Get active integrations * [setAsPrimary](#setasprimary) - Set integration as primary +* [update](#update) - Update integration -## list +## create -Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change +Create an integration for the current environment the user is based on the API key provided ### Example Usage ```typescript import { Novu } from "novu-sdk"; +import { Channel } from "novu-sdk/models/components"; const novu = new Novu({ apiKey: "", }); async function run() { - const result = await novu.integrations.list(); + const result = await novu.integrations.create({ + channel: Channel.Sms, + providerId: "", + }); // Handle the result console.log(result) @@ -42,6 +46,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.CreateIntegrationRequestDto](../../models/components/createintegrationrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -49,32 +54,28 @@ run(); ### Response -**Promise\<[components.IntegrationResponseDto[]](../../models/.md)\>** +**Promise\<[components.IntegrationResponseDto](../../models/components/integrationresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## delete -Create an integration for the current environment the user is based on the API key provided +Delete integration ### Example Usage ```typescript import { Novu } from "novu-sdk"; -import { CreateIntegrationRequestDtoChannel } from "novu-sdk/models/components"; const novu = new Novu({ apiKey: "", }); async function run() { - const result = await novu.integrations.create({ - providerId: "", - channel: CreateIntegrationRequestDtoChannel.Sms, - }); + const result = await novu.integrations.delete(""); // Handle the result console.log(result) @@ -87,7 +88,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateIntegrationRequestDto](../../models/components/createintegrationrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `integrationId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -95,16 +96,16 @@ run(); ### Response -**Promise\<[components.IntegrationResponseDto](../../models/components/integrationresponsedto.md)\>** +**Promise\<[components.IntegrationResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## listActive +## list -Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change +Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change ### Example Usage @@ -116,7 +117,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.integrations.listActive(); + const result = await novu.integrations.list(); // Handle the result console.log(result) @@ -143,9 +144,9 @@ run(); | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## update +## listActive -Update integration +Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change ### Example Usage @@ -157,7 +158,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.integrations.update("", {}); + const result = await novu.integrations.listActive(); // Handle the result console.log(result) @@ -170,8 +171,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `integrationId` | *string* | :heavy_check_mark: | N/A | -| `updateIntegrationRequestDto` | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -179,16 +178,16 @@ run(); ### Response -**Promise\<[components.IntegrationResponseDto](../../models/components/integrationresponsedto.md)\>** +**Promise\<[components.IntegrationResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## setAsPrimary -Delete integration +Set integration as primary ### Example Usage @@ -200,7 +199,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.integrations.delete(""); + const result = await novu.integrations.setAsPrimary(""); // Handle the result console.log(result) @@ -221,16 +220,16 @@ run(); ### Response -**Promise\<[components.IntegrationResponseDto[]](../../models/.md)\>** +**Promise\<[components.IntegrationResponseDto](../../models/components/integrationresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## setAsPrimary +## update -Set integration as primary +Update integration ### Example Usage @@ -242,7 +241,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.integrations.setAsPrimary(""); + const result = await novu.integrations.update("", {}); // Handle the result console.log(result) @@ -256,6 +255,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `integrationId` | *string* | :heavy_check_mark: | N/A | +| `updateIntegrationRequestDto` | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | diff --git a/docs/sdks/layouts/README.md b/docs/sdks/layouts/README.md index b88e850f..ed9e2b24 100644 --- a/docs/sdks/layouts/README.md +++ b/docs/sdks/layouts/README.md @@ -8,16 +8,16 @@ Novu allows the creation of layouts - a specific HTML design or structure to wra ### Available Operations -* [list](#list) - Filter layouts * [create](#create) - Layout creation -* [retrieve](#retrieve) - Get layout * [delete](#delete) - Delete layout -* [update](#update) - Update a layout +* [list](#list) - Filter layouts +* [retrieve](#retrieve) - Get layout * [setAsDefault](#setasdefault) - Set default layout +* [update](#update) - Update a layout -## list +## create -Returns a list of layouts that can be paginated using the `page` query parameter and filtered by the environment where it is executed from the organization the user belongs to. +Create a layout ### Example Usage @@ -29,9 +29,10 @@ const novu = new Novu({ }); async function run() { - await novu.layouts.list({}); + const result = await novu.layouts.create(); - + // Handle the result + console.log(result) } run(); @@ -41,7 +42,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LayoutsControllerListLayoutsRequest](../../models/operations/layoutscontrollerlistlayoutsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -49,16 +49,16 @@ run(); ### Response -**Promise\** +**Promise\<[components.CreateLayoutResponseDto](../../models/components/createlayoutresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## delete -Create a layout +Execute a soft delete of a layout given a certain ID. ### Example Usage @@ -70,10 +70,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.layouts.create(); + await novu.layouts.delete(""); - // Handle the result - console.log(result) + } run(); @@ -83,6 +82,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `layoutId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -90,16 +90,16 @@ run(); ### Response -**Promise\<[components.CreateLayoutResponseDto](../../models/components/createlayoutresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieve +## list -Get a layout by its ID +Returns a list of layouts that can be paginated using the `page` query parameter and filtered by the environment where it is executed from the organization the user belongs to. ### Example Usage @@ -111,10 +111,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.layouts.retrieve(""); + await novu.layouts.list({}); - // Handle the result - console.log(result) + } run(); @@ -124,7 +123,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `layoutId` | *string* | :heavy_check_mark: | N/A | +| `request` | [operations.LayoutsControllerListLayoutsRequest](../../models/operations/layoutscontrollerlistlayoutsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -132,16 +131,16 @@ run(); ### Response -**Promise\<[components.GetLayoutResponseDto](../../models/components/getlayoutresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## retrieve -Execute a soft delete of a layout given a certain ID. +Get a layout by its ID ### Example Usage @@ -153,9 +152,10 @@ const novu = new Novu({ }); async function run() { - await novu.layouts.delete(""); + const result = await novu.layouts.retrieve(""); - + // Handle the result + console.log(result) } run(); @@ -173,16 +173,16 @@ run(); ### Response -**Promise\** +**Promise\<[components.GetLayoutResponseDto](../../models/components/getlayoutresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## update +## setAsDefault -Update the name, content and variables of a layout. Also change it to be default or no. +Sets the default layout for the environment and updates to non default to the existing default layout (if any). ### Example Usage @@ -194,12 +194,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.layouts.update("", { - identifier: "", - }); + await novu.layouts.setAsDefault(""); - // Handle the result - console.log(result) + } run(); @@ -210,7 +207,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `layoutId` | *string* | :heavy_check_mark: | N/A | -| `updateLayoutRequestDto` | [components.UpdateLayoutRequestDto](../../models/components/updatelayoutrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -218,16 +214,16 @@ run(); ### Response -**Promise\<[components.UpdateLayoutResponseDto](../../models/components/updatelayoutresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## setAsDefault +## update -Sets the default layout for the environment and updates to non default to the existing default layout (if any). +Update the name, content and variables of a layout. Also change it to be default or no. ### Example Usage @@ -239,9 +235,12 @@ const novu = new Novu({ }); async function run() { - await novu.layouts.setAsDefault(""); + const result = await novu.layouts.update("", { + identifier: "", + }); - + // Handle the result + console.log(result) } run(); @@ -252,6 +251,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `layoutId` | *string* | :heavy_check_mark: | N/A | +| `updateLayoutRequestDto` | [components.UpdateLayoutRequestDto](../../models/components/updatelayoutrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -259,7 +259,7 @@ run(); ### Response -**Promise\** +**Promise\<[components.UpdateLayoutResponseDto](../../models/components/updatelayoutresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/messages/README.md b/docs/sdks/messages/README.md index 1597d0b9..20603e57 100644 --- a/docs/sdks/messages/README.md +++ b/docs/sdks/messages/README.md @@ -8,13 +8,13 @@ A message in Novu represents a notification delivered to a recipient on a partic ### Available Operations -* [retrieve](#retrieve) - Get messages * [delete](#delete) - Delete message * [deleteByTransactionId](#deletebytransactionid) - Delete messages by transactionId +* [retrieve](#retrieve) - Get messages -## retrieve +## delete -Returns a list of messages, could paginate using the `page` query parameter +Deletes a message entity from the Novu platform ### Example Usage @@ -26,7 +26,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.messages.retrieve({}); + const result = await novu.messages.delete(""); // Handle the result console.log(result) @@ -39,7 +39,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.MessagesControllerGetMessagesRequest](../../models/operations/messagescontrollergetmessagesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `messageId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -47,31 +47,31 @@ run(); ### Response -**Promise\<[components.ActivitiesResponseDto](../../models/components/activitiesresponsedto.md)\>** +**Promise\<[components.DeleteMessageResponseDto](../../models/components/deletemessageresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## deleteByTransactionId -Deletes a message entity from the Novu platform +Deletes messages entity from the Novu platform using TransactionId of message ### Example Usage ```typescript import { Novu } from "novu-sdk"; +import { Channel } from "novu-sdk/models/operations"; const novu = new Novu({ apiKey: "", }); async function run() { - const result = await novu.messages.delete(""); + await novu.messages.deleteByTransactionId("", Channel.Push); - // Handle the result - console.log(result) + } run(); @@ -81,7 +81,8 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `messageId` | *string* | :heavy_check_mark: | N/A | +| `transactionId` | *string* | :heavy_check_mark: | N/A | +| `channel` | [operations.Channel](../../models/operations/channel.md) | :heavy_minus_sign: | The channel of the message to be deleted | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -89,31 +90,31 @@ run(); ### Response -**Promise\<[components.DeleteMessageResponseDto](../../models/components/deletemessageresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## deleteByTransactionId +## retrieve -Deletes messages entity from the Novu platform using TransactionId of message +Returns a list of messages, could paginate using the `page` query parameter ### Example Usage ```typescript import { Novu } from "novu-sdk"; -import { QueryParamChannel } from "novu-sdk/models/operations"; const novu = new Novu({ apiKey: "", }); async function run() { - await novu.messages.deleteByTransactionId("", QueryParamChannel.Push); + const result = await novu.messages.retrieve({}); - + // Handle the result + console.log(result) } run(); @@ -123,8 +124,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `transactionId` | *string* | :heavy_check_mark: | N/A | -| `channel` | [operations.QueryParamChannel](../../models/operations/queryparamchannel.md) | :heavy_minus_sign: | The channel of the message to be deleted | +| `request` | [operations.MessagesControllerGetMessagesRequest](../../models/operations/messagescontrollergetmessagesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -132,7 +132,7 @@ run(); ### Response -**Promise\** +**Promise\<[components.ActivitiesResponseDto](../../models/components/activitiesresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/novumessages/README.md b/docs/sdks/novumessages/README.md index 2ed91ee3..7a1d1f5b 100644 --- a/docs/sdks/novumessages/README.md +++ b/docs/sdks/novumessages/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [markAllAs](#markallas) - Mark a subscriber messages as seen, read, unseen or unread * [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed. +* [markAllAs](#markallas) - Mark a subscriber messages as seen, read, unseen or unread * [updateAsSeen](#updateasseen) - Mark message action as seen -## markAllAs +## markAll -Mark a subscriber messages as seen, read, unseen or unread +Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed. ### Example Usage @@ -22,8 +22,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.messages.markAllAs("", { - messageId: "", + const result = await novu.subscribers.messages.markAll("", { markAs: MarkAs.Seen, }); @@ -39,7 +38,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `messageMarkAsRequestDto` | [components.MessageMarkAsRequestDto](../../models/components/messagemarkasrequestdto.md) | :heavy_check_mark: | N/A | +| `markAllMessageAsRequestDto` | [components.MarkAllMessageAsRequestDto](../../models/components/markallmessageasrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -47,30 +46,31 @@ run(); ### Response -**Promise\<[components.MessageEntity[]](../../models/.md)\>** +**Promise\<[number](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## markAll +## markAllAs -Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed. +Mark a subscriber messages as seen, read, unseen or unread ### Example Usage ```typescript import { Novu } from "novu-sdk"; -import { MarkAllMessageAsRequestDtoMarkAs } from "novu-sdk/models/components"; +import { MessageMarkAsRequestDtoMarkAs } from "novu-sdk/models/components"; const novu = new Novu({ apiKey: "", }); async function run() { - const result = await novu.subscribers.messages.markAll("", { - markAs: MarkAllMessageAsRequestDtoMarkAs.Seen, + const result = await novu.subscribers.messages.markAllAs("", { + markAs: MessageMarkAsRequestDtoMarkAs.Seen, + messageId: "", }); // Handle the result @@ -85,7 +85,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `markAllMessageAsRequestDto` | [components.MarkAllMessageAsRequestDto](../../models/components/markallmessageasrequestdto.md) | :heavy_check_mark: | N/A | +| `messageMarkAsRequestDto` | [components.MessageMarkAsRequestDto](../../models/components/messagemarkasrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -93,7 +93,7 @@ run(); ### Response -**Promise\<[number](../../models/.md)\>** +**Promise\<[components.MessageEntity[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/novusubscribers/README.md b/docs/sdks/novusubscribers/README.md index e00bdf5b..6b96a93e 100644 --- a/docs/sdks/novusubscribers/README.md +++ b/docs/sdks/novusubscribers/README.md @@ -4,8 +4,8 @@ ### Available Operations * [assign](#assign) - Subscribers addition -* [retrieve](#retrieve) - Check topic subscriber * [delete](#delete) - Subscribers removal +* [retrieve](#retrieve) - Check topic subscriber ## assign @@ -53,9 +53,9 @@ run(); | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieve +## delete -Check if a subscriber belongs to a certain topic +Remove subscribers from a topic ### Example Usage @@ -67,10 +67,13 @@ const novu = new Novu({ }); async function run() { - const result = await novu.topics.subscribers.retrieve("", ""); + await novu.topics.subscribers.delete("", { + subscribers: [ + "", + ], + }); - // Handle the result - console.log(result) + } run(); @@ -81,7 +84,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `topicKey` | *string* | :heavy_check_mark: | N/A | -| `externalSubscriberId` | *string* | :heavy_check_mark: | N/A | +| `removeSubscribersRequestDto` | [components.RemoveSubscribersRequestDto](../../models/components/removesubscribersrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -89,16 +92,16 @@ run(); ### Response -**Promise\<[components.TopicSubscriberDto](../../models/components/topicsubscriberdto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## retrieve -Remove subscribers from a topic +Check if a subscriber belongs to a certain topic ### Example Usage @@ -110,13 +113,10 @@ const novu = new Novu({ }); async function run() { - await novu.topics.subscribers.delete("", { - subscribers: [ - "", - ], - }); + const result = await novu.topics.subscribers.retrieve("", ""); - + // Handle the result + console.log(result) } run(); @@ -127,7 +127,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `topicKey` | *string* | :heavy_check_mark: | N/A | -| `removeSubscribersRequestDto` | [components.RemoveSubscribersRequestDto](../../models/components/removesubscribersrequestdto.md) | :heavy_check_mark: | N/A | +| `externalSubscriberId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -135,7 +135,7 @@ run(); ### Response -**Promise\** +**Promise\<[components.TopicSubscriberDto](../../models/components/topicsubscriberdto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/organizations/README.md b/docs/sdks/organizations/README.md index 1fc3f4dc..13c5c886 100644 --- a/docs/sdks/organizations/README.md +++ b/docs/sdks/organizations/README.md @@ -8,14 +8,14 @@ An organization serves as a separate entity within your Novu account. Each organ ### Available Operations -* [list](#list) - Fetch all organizations * [create](#create) - Create an organization +* [list](#list) - Fetch all organizations * [rename](#rename) - Rename organization name * [retrieve](#retrieve) - Fetch current organization details -## list +## create -Fetch all organizations +Create an organization ### Example Usage @@ -27,7 +27,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.organizations.list(); + const result = await novu.organizations.create({ + name: "", + }); // Handle the result console.log(result) @@ -40,6 +42,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.CreateOrganizationDto](../../models/components/createorganizationdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -47,16 +50,16 @@ run(); ### Response -**Promise\<[components.OrganizationResponseDto[]](../../models/.md)\>** +**Promise\<[components.OrganizationResponseDto](../../models/components/organizationresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## list -Create an organization +Fetch all organizations ### Example Usage @@ -68,9 +71,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.organizations.create({ - name: "", - }); + const result = await novu.organizations.list(); // Handle the result console.log(result) @@ -83,7 +84,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateOrganizationDto](../../models/components/createorganizationdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -91,7 +91,7 @@ run(); ### Response -**Promise\<[components.OrganizationResponseDto](../../models/components/organizationresponsedto.md)\>** +**Promise\<[components.OrganizationResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/preferences/README.md b/docs/sdks/preferences/README.md index 40c56649..75836848 100644 --- a/docs/sdks/preferences/README.md +++ b/docs/sdks/preferences/README.md @@ -4,9 +4,9 @@ ### Available Operations * [list](#list) - Get subscriber preferences -* [updateGlobal](#updateglobal) - Update subscriber global preferences * [retrieveByLevel](#retrievebylevel) - Get subscriber preferences by level * [update](#update) - Update subscriber preference +* [updateGlobal](#updateglobal) - Update subscriber global preferences ## list @@ -50,9 +50,9 @@ run(); | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## updateGlobal +## retrieveByLevel -Update subscriber global preferences +Get subscriber preferences by level ### Example Usage @@ -64,7 +64,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.preferences.updateGlobal("", {}); + const result = await novu.subscribers.preferences.retrieveByLevel("", ""); // Handle the result console.log(result) @@ -77,8 +77,8 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `parameter` | *string* | :heavy_check_mark: | N/A | | `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `updateSubscriberGlobalPreferencesRequestDto` | [components.UpdateSubscriberGlobalPreferencesRequestDto](../../models/components/updatesubscriberglobalpreferencesrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -86,16 +86,16 @@ run(); ### Response -**Promise\<[components.UpdateSubscriberPreferenceResponseDto](../../models/components/updatesubscriberpreferenceresponsedto.md)\>** +**Promise\<[components.GetSubscriberPreferencesResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieveByLevel +## update -Get subscriber preferences by level +Update subscriber preference ### Example Usage @@ -107,7 +107,11 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.preferences.retrieveByLevel("", ""); + const result = await novu.subscribers.preferences.update({ + subscriberId: "", + parameter: "", + updateSubscriberPreferenceRequestDto: {}, + }); // Handle the result console.log(result) @@ -120,8 +124,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `parameter` | *string* | :heavy_check_mark: | N/A | -| `subscriberId` | *string* | :heavy_check_mark: | N/A | +| `request` | [operations.SubscribersControllerUpdateSubscriberPreferenceRequest](../../models/operations/subscriberscontrollerupdatesubscriberpreferencerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -129,16 +132,16 @@ run(); ### Response -**Promise\<[components.GetSubscriberPreferencesResponseDto[]](../../models/.md)\>** +**Promise\<[components.UpdateSubscriberPreferenceResponseDto](../../models/components/updatesubscriberpreferenceresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## update +## updateGlobal -Update subscriber preference +Update subscriber global preferences ### Example Usage @@ -150,11 +153,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.preferences.update({ - subscriberId: "", - parameter: "", - updateSubscriberPreferenceRequestDto: {}, - }); + const result = await novu.subscribers.preferences.updateGlobal("", {}); // Handle the result console.log(result) @@ -167,7 +166,8 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SubscribersControllerUpdateSubscriberPreferenceRequest](../../models/operations/subscriberscontrollerupdatesubscriberpreferencerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `subscriberId` | *string* | :heavy_check_mark: | N/A | +| `updateSubscriberGlobalPreferencesRequestDto` | [components.UpdateSubscriberGlobalPreferencesRequestDto](../../models/components/updatesubscriberglobalpreferencesrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | diff --git a/docs/sdks/stats/README.md b/docs/sdks/stats/README.md index 61380967..809e51bb 100644 --- a/docs/sdks/stats/README.md +++ b/docs/sdks/stats/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [retrieve](#retrieve) - Get notification statistics * [graph](#graph) - Get notification graph statistics +* [retrieve](#retrieve) - Get notification statistics -## retrieve +## graph -Get notification statistics +Get notification graph statistics ### Example Usage @@ -20,7 +20,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.notifications.stats.retrieve(); + const result = await novu.notifications.stats.graph(4018.61); // Handle the result console.log(result) @@ -33,6 +33,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `days` | *number* | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -40,16 +41,16 @@ run(); ### Response -**Promise\<[components.ActivityStatsResponseDto](../../models/components/activitystatsresponsedto.md)\>** +**Promise\<[components.ActivityGraphStatesResponse[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## graph +## retrieve -Get notification graph statistics +Get notification statistics ### Example Usage @@ -61,7 +62,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.notifications.stats.graph(4018.61); + const result = await novu.notifications.stats.retrieve(); // Handle the result console.log(result) @@ -74,7 +75,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `days` | *number* | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -82,7 +82,7 @@ run(); ### Response -**Promise\<[components.ActivityGraphStatesResponse[]](../../models/.md)\>** +**Promise\<[components.ActivityStatsResponseDto](../../models/components/activitystatsresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/subscribers/README.md b/docs/sdks/subscribers/README.md index 8a2f0246..a2828970 100644 --- a/docs/sdks/subscribers/README.md +++ b/docs/sdks/subscribers/README.md @@ -8,16 +8,16 @@ A subscriber in Novu represents someone who should receive a message. A subscrib ### Available Operations -* [list](#list) - Get subscribers * [create](#create) - Create subscriber +* [createBulk](#createbulk) - Bulk create subscribers +* [delete](#delete) - Delete subscriber +* [list](#list) - Get subscribers * [retrieve](#retrieve) - Get subscriber * [update](#update) - Update subscriber -* [delete](#delete) - Delete subscriber -* [createBulk](#createbulk) - Bulk create subscribers -## list +## create -Returns a list of subscribers, could paginated using the `page` and `limit` query parameter +Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity. ### Example Usage @@ -29,11 +29,12 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.list(7685.78, 10); + const result = await novu.subscribers.create({ + subscriberId: "", + }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); @@ -43,8 +44,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `limit` | *number* | :heavy_minus_sign: | N/A | +| `request` | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -52,16 +52,19 @@ run(); ### Response -**Promise\<[operations.SubscribersControllerListSubscribersResponse](../../models/operations/subscriberscontrollerlistsubscribersresponse.md)\>** +**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## createBulk -Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity. + + Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API. + The bulk API is limited to 500 subscribers per request. + ### Example Usage @@ -73,12 +76,15 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.create({ - subscriberId: "", + await novu.subscribers.createBulk({ + subscribers: [ + { + subscriberId: "", + }, + ], }); - // Handle the result - console.log(result) + } run(); @@ -88,7 +94,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -96,16 +102,16 @@ run(); ### Response -**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieve +## delete -Get subscriber by your internal id used to identify the subscriber +Deletes a subscriber entity from the Novu platform ### Example Usage @@ -117,7 +123,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.retrieve(""); + const result = await novu.subscribers.delete(""); // Handle the result console.log(result) @@ -138,16 +144,16 @@ run(); ### Response -**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** +**Promise\<[components.DeleteSubscriberResponseDto](../../models/components/deletesubscriberresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## update +## list -Used to update the subscriber entity with new information +Returns a list of subscribers, could paginated using the `page` and `limit` query parameter ### Example Usage @@ -159,10 +165,11 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.update("", {}); + const result = await novu.subscribers.list(7685.78, 10); - // Handle the result - console.log(result) + for await (const page of result) { + // handle page + } } run(); @@ -172,8 +179,8 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `subscriberId` | *string* | :heavy_check_mark: | N/A | -| `updateSubscriberRequestDto` | [components.UpdateSubscriberRequestDto](../../models/components/updatesubscriberrequestdto.md) | :heavy_check_mark: | N/A | +| `page` | *number* | :heavy_minus_sign: | N/A | +| `limit` | *number* | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -181,16 +188,16 @@ run(); ### Response -**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** +**Promise\<[operations.SubscribersControllerListSubscribersResponse](../../models/operations/subscriberscontrollerlistsubscribersresponse.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## retrieve -Deletes a subscriber entity from the Novu platform +Get subscriber by your internal id used to identify the subscriber ### Example Usage @@ -202,7 +209,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.subscribers.delete(""); + const result = await novu.subscribers.retrieve(""); // Handle the result console.log(result) @@ -223,19 +230,16 @@ run(); ### Response -**Promise\<[components.DeleteSubscriberResponseDto](../../models/components/deletesubscriberresponsedto.md)\>** +**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## createBulk - +## update - Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API. - The bulk API is limited to 500 subscribers per request. - +Used to update the subscriber entity with new information ### Example Usage @@ -247,15 +251,10 @@ const novu = new Novu({ }); async function run() { - await novu.subscribers.createBulk({ - subscribers: [ - { - subscriberId: "", - }, - ], - }); + const result = await novu.subscribers.update("", {}); - + // Handle the result + console.log(result) } run(); @@ -265,7 +264,8 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.md) | :heavy_check_mark: | The request object to use for the request. | +| `subscriberId` | *string* | :heavy_check_mark: | N/A | +| `updateSubscriberRequestDto` | [components.UpdateSubscriberRequestDto](../../models/components/updatesubscriberrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -273,7 +273,7 @@ run(); ### Response -**Promise\** +**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/tenants/README.md b/docs/sdks/tenants/README.md index 126e1845..bfab0db2 100644 --- a/docs/sdks/tenants/README.md +++ b/docs/sdks/tenants/README.md @@ -8,15 +8,15 @@ A tenant represents a group of users. As a developer, when your apps have organi ### Available Operations -* [list](#list) - Get tenants * [create](#create) - Create tenant -* [retrieve](#retrieve) - Get tenant * [delete](#delete) - Delete tenant +* [list](#list) - Get tenants +* [retrieve](#retrieve) - Get tenant * [update](#update) - Update tenant -## list +## create -Returns a list of tenants, could paginated using the `page` and `limit` query parameter +Create tenant under the current environment ### Example Usage @@ -28,11 +28,13 @@ const novu = new Novu({ }); async function run() { - const result = await novu.tenants.list(7685.78, 10); + const result = await novu.tenants.create({ + identifier: "", + name: "", + }); - for await (const page of result) { - // handle page - } + // Handle the result + console.log(result) } run(); @@ -42,8 +44,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `limit` | *number* | :heavy_minus_sign: | N/A | +| `request` | [components.CreateTenantRequestDto](../../models/components/createtenantrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -51,16 +52,16 @@ run(); ### Response -**Promise\<[operations.TenantControllerListTenantsResponse](../../models/operations/tenantcontrollerlisttenantsresponse.md)\>** +**Promise\<[components.CreateTenantResponseDto](../../models/components/createtenantresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## delete -Create tenant under the current environment +Deletes a tenant entity from the Novu platform ### Example Usage @@ -72,13 +73,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.tenants.create({ - identifier: "", - name: "", - }); + await novu.tenants.delete(""); - // Handle the result - console.log(result) + } run(); @@ -88,7 +85,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateTenantRequestDto](../../models/components/createtenantrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `identifier` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -96,16 +93,16 @@ run(); ### Response -**Promise\<[components.CreateTenantResponseDto](../../models/components/createtenantresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieve +## list -Get tenant by your internal id used to identify the tenant +Returns a list of tenants, could paginated using the `page` and `limit` query parameter ### Example Usage @@ -117,10 +114,11 @@ const novu = new Novu({ }); async function run() { - const result = await novu.tenants.retrieve(""); + const result = await novu.tenants.list(7685.78, 10); - // Handle the result - console.log(result) + for await (const page of result) { + // handle page + } } run(); @@ -130,7 +128,8 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `identifier` | *string* | :heavy_check_mark: | N/A | +| `page` | *number* | :heavy_minus_sign: | N/A | +| `limit` | *number* | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -138,16 +137,16 @@ run(); ### Response -**Promise\<[components.GetTenantResponseDto](../../models/components/gettenantresponsedto.md)\>** +**Promise\<[operations.TenantControllerListTenantsResponse](../../models/operations/tenantcontrollerlisttenantsresponse.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## retrieve -Deletes a tenant entity from the Novu platform +Get tenant by your internal id used to identify the tenant ### Example Usage @@ -159,9 +158,10 @@ const novu = new Novu({ }); async function run() { - await novu.tenants.delete(""); + const result = await novu.tenants.retrieve(""); - + // Handle the result + console.log(result) } run(); @@ -179,7 +179,7 @@ run(); ### Response -**Promise\** +**Promise\<[components.GetTenantResponseDto](../../models/components/gettenantresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/topics/README.md b/docs/sdks/topics/README.md index f55b19c4..9160c933 100644 --- a/docs/sdks/topics/README.md +++ b/docs/sdks/topics/README.md @@ -8,15 +8,15 @@ Topics are a way to group subscribers together so that they can be notified of e ### Available Operations -* [list](#list) - Filter topics * [create](#create) - Topic creation -* [retrieve](#retrieve) - Get topic * [delete](#delete) - Delete topic +* [list](#list) - Filter topics * [rename](#rename) - Rename a topic +* [retrieve](#retrieve) - Get topic -## list +## create -Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter +Create a topic ### Example Usage @@ -28,7 +28,10 @@ const novu = new Novu({ }); async function run() { - const result = await novu.topics.list({}); + const result = await novu.topics.create({ + key: "", + name: "", + }); // Handle the result console.log(result) @@ -41,7 +44,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.TopicsControllerListTopicsRequest](../../models/operations/topicscontrollerlisttopicsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [components.CreateTopicRequestDto](../../models/components/createtopicrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -49,16 +52,16 @@ run(); ### Response -**Promise\<[components.FilterTopicsResponseDto](../../models/components/filtertopicsresponsedto.md)\>** +**Promise\<[components.CreateTopicResponseDto](../../models/components/createtopicresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## delete -Create a topic +Delete a topic by its topic key if it has no subscribers ### Example Usage @@ -70,13 +73,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.topics.create({ - key: "", - name: "", - }); + await novu.topics.delete(""); - // Handle the result - console.log(result) + } run(); @@ -86,7 +85,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateTopicRequestDto](../../models/components/createtopicrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `topicKey` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -94,16 +93,16 @@ run(); ### Response -**Promise\<[components.CreateTopicResponseDto](../../models/components/createtopicresponsedto.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieve +## list -Get a topic by its topic key +Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter ### Example Usage @@ -115,7 +114,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.topics.retrieve(""); + const result = await novu.topics.list({}); // Handle the result console.log(result) @@ -128,7 +127,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `topicKey` | *string* | :heavy_check_mark: | N/A | +| `request` | [operations.TopicsControllerListTopicsRequest](../../models/operations/topicscontrollerlisttopicsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -136,16 +135,16 @@ run(); ### Response -**Promise\<[components.GetTopicResponseDto](../../models/components/gettopicresponsedto.md)\>** +**Promise\<[components.FilterTopicsResponseDto](../../models/components/filtertopicsresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## rename -Delete a topic by its topic key if it has no subscribers +Rename a topic by providing a new name ### Example Usage @@ -157,9 +156,12 @@ const novu = new Novu({ }); async function run() { - await novu.topics.delete(""); + const result = await novu.topics.rename("", { + name: "", + }); - + // Handle the result + console.log(result) } run(); @@ -170,6 +172,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `topicKey` | *string* | :heavy_check_mark: | N/A | +| `renameTopicRequestDto` | [components.RenameTopicRequestDto](../../models/components/renametopicrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -177,16 +180,16 @@ run(); ### Response -**Promise\** +**Promise\<[components.RenameTopicResponseDto](../../models/components/renametopicresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## rename +## retrieve -Rename a topic by providing a new name +Get a topic by its topic key ### Example Usage @@ -198,9 +201,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.topics.rename("", { - name: "", - }); + const result = await novu.topics.retrieve(""); // Handle the result console.log(result) @@ -214,7 +215,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `topicKey` | *string* | :heavy_check_mark: | N/A | -| `renameTopicRequestDto` | [components.RenameTopicRequestDto](../../models/components/renametopicrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -222,7 +222,7 @@ run(); ### Response -**Promise\<[components.RenameTopicResponseDto](../../models/components/renametopicresponsedto.md)\>** +**Promise\<[components.GetTopicResponseDto](../../models/components/gettopicresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/workflowgroups/README.md b/docs/sdks/workflowgroups/README.md index c802db72..de92ff32 100644 --- a/docs/sdks/workflowgroups/README.md +++ b/docs/sdks/workflowgroups/README.md @@ -7,13 +7,13 @@ Workflow groups are used to organize workflows into logical groups. ### Available Operations -* [list](#list) - Get workflow groups * [create](#create) - Create workflow group -* [retrieve](#retrieve) - Get workflow group * [delete](#delete) - Delete workflow group +* [list](#list) - Get workflow groups +* [retrieve](#retrieve) - Get workflow group * [update](#update) - Update workflow group -## list +## create workflow group was previously named notification group @@ -27,7 +27,9 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflowGroups.list(); + const result = await novu.workflowGroups.create({ + name: "", + }); // Handle the result console.log(result) @@ -40,6 +42,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [components.CreateNotificationGroupRequestDto](../../models/components/createnotificationgrouprequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -47,14 +50,14 @@ run(); ### Response -**Promise\<[components.NotificationGroupResponseDto[]](../../models/.md)\>** +**Promise\<[components.NotificationGroupResponseDto](../../models/components/notificationgroupresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## delete workflow group was previously named notification group @@ -68,9 +71,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflowGroups.create({ - name: "", - }); + const result = await novu.workflowGroups.delete(""); // Handle the result console.log(result) @@ -83,7 +84,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateNotificationGroupRequestDto](../../models/components/createnotificationgrouprequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `id` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -91,14 +92,14 @@ run(); ### Response -**Promise\<[components.NotificationGroupResponseDto](../../models/components/notificationgroupresponsedto.md)\>** +**Promise\<[components.DeleteNotificationGroupResponseDto](../../models/components/deletenotificationgroupresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieve +## list workflow group was previously named notification group @@ -112,7 +113,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflowGroups.retrieve(""); + const result = await novu.workflowGroups.list(); // Handle the result console.log(result) @@ -125,7 +126,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -133,14 +133,14 @@ run(); ### Response -**Promise\<[components.NotificationGroupResponseDto](../../models/components/notificationgroupresponsedto.md)\>** +**Promise\<[components.NotificationGroupResponseDto[]](../../models/.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## retrieve workflow group was previously named notification group @@ -154,7 +154,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflowGroups.delete(""); + const result = await novu.workflowGroups.retrieve(""); // Handle the result console.log(result) @@ -175,7 +175,7 @@ run(); ### Response -**Promise\<[components.DeleteNotificationGroupResponseDto](../../models/components/deletenotificationgroupresponsedto.md)\>** +**Promise\<[components.NotificationGroupResponseDto](../../models/components/notificationgroupresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/workflows/README.md b/docs/sdks/workflows/README.md index 5f6067df..2e15134d 100644 --- a/docs/sdks/workflows/README.md +++ b/docs/sdks/workflows/README.md @@ -8,15 +8,15 @@ All notifications are sent via a workflow. Each workflow acts as a container for ### Available Operations -* [list](#list) - Get workflows * [create](#create) - Create workflow +* [delete](#delete) - Delete workflow +* [list](#list) - Get workflows * [retrieve](#retrieve) - Get workflow * [update](#update) - Update workflow -* [delete](#delete) - Delete workflow -## list +## create -Workflows were previously named notification templates +Workflow was previously named notification template ### Example Usage @@ -28,7 +28,13 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflows.list({}); + const result = await novu.workflows.create({ + name: "", + notificationGroupId: "", + steps: [ + {}, + ], + }); // Handle the result console.log(result) @@ -41,7 +47,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.WorkflowControllerListWorkflowsRequest](../../models/operations/workflowcontrollerlistworkflowsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [components.CreateWorkflowRequestDto](../../models/components/createworkflowrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -49,14 +55,14 @@ run(); ### Response -**Promise\<[components.WorkflowsResponseDto](../../models/components/workflowsresponsedto.md)\>** +**Promise\<[components.WorkflowResponse](../../models/components/workflowresponse.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## create +## delete Workflow was previously named notification template @@ -70,13 +76,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflows.create({ - name: "", - notificationGroupId: "", - steps: [ - {}, - ], - }); + const result = await novu.workflows.delete(""); // Handle the result console.log(result) @@ -89,7 +89,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.CreateWorkflowRequestDto](../../models/components/createworkflowrequestdto.md) | :heavy_check_mark: | The request object to use for the request. | +| `workflowId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -97,16 +97,16 @@ run(); ### Response -**Promise\<[components.WorkflowResponse](../../models/components/workflowresponse.md)\>** +**Promise\<[components.DataBooleanDto](../../models/components/databooleandto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## retrieve +## list -Workflow was previously named notification template +Workflows were previously named notification templates ### Example Usage @@ -118,7 +118,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflows.retrieve(""); + const result = await novu.workflows.list({}); // Handle the result console.log(result) @@ -131,7 +131,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `workflowId` | *string* | :heavy_check_mark: | N/A | +| `request` | [operations.WorkflowControllerListWorkflowsRequest](../../models/operations/workflowcontrollerlistworkflowsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -139,14 +139,14 @@ run(); ### Response -**Promise\<[components.WorkflowResponse](../../models/components/workflowresponse.md)\>** +**Promise\<[components.WorkflowsResponseDto](../../models/components/workflowsresponsedto.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## update +## retrieve Workflow was previously named notification template @@ -160,10 +160,7 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflows.update("", { - name: "", - notificationGroupId: "", - }); + const result = await novu.workflows.retrieve(""); // Handle the result console.log(result) @@ -177,7 +174,6 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `workflowId` | *string* | :heavy_check_mark: | N/A | -| `updateWorkflowRequestDto` | [components.UpdateWorkflowRequestDto](../../models/components/updateworkflowrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -192,7 +188,7 @@ run(); | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | -## delete +## update Workflow was previously named notification template @@ -206,7 +202,10 @@ const novu = new Novu({ }); async function run() { - const result = await novu.workflows.delete(""); + const result = await novu.workflows.update("", { + name: "", + notificationGroupId: "", + }); // Handle the result console.log(result) @@ -220,6 +219,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `workflowId` | *string* | :heavy_check_mark: | N/A | +| `updateWorkflowRequestDto` | [components.UpdateWorkflowRequestDto](../../models/components/updateworkflowrequestdto.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -227,7 +227,7 @@ run(); ### Response -**Promise\<[components.DataBooleanDto](../../models/components/databooleandto.md)\>** +**Promise\<[components.WorkflowResponse](../../models/components/workflowresponse.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/jsr.json b/jsr.json index 3a173825..f8ead0b8 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "novu-sdk", - "version": "0.0.1-alpha.1", + "version": "0.0.1-alpha.2", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index ec560798..01cf09a9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "novu-sdk", - "version": "0.0.1-alpha.1", + "version": "0.0.1-alpha.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "novu-sdk", - "version": "0.0.1-alpha.1", + "version": "0.0.1-alpha.2", "dependencies": { "jsonpath": "^1.1.1" }, diff --git a/package.json b/package.json index 1f7c2aa3..1eee0d40 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "novu-sdk", - "version": "0.0.1-alpha.1", + "version": "0.0.1-alpha.2", "author": "Novu", "main": "./index.js", "sideEffects": false, diff --git a/sources/openapi.sdk.json b/sources/openapi.sdk.json new file mode 100644 index 00000000..6eedda0e --- /dev/null +++ b/sources/openapi.sdk.json @@ -0,0 +1 @@ +{"openapi":"3.0.0","paths":{"/v1/organizations":{"post":{"operationId":"OrganizationController_createOrganization","summary":"Create an organization","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Organizations"],"security":[{"api-key":[]}]},"get":{"operationId":"OrganizationController_listOrganizations","summary":"Fetch all organizations","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Organizations"],"security":[{"api-key":[]}]},"patch":{"operationId":"OrganizationController_rename","x-speakeasy-name-override":"rename","summary":"Rename organization name","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameOrganizationDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameOrganizationDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Organizations"],"security":[{"api-key":[]}]}},"/v1/organizations/me":{"get":{"operationId":"OrganizationController_getSelfOrganizationData","summary":"Fetch current organization details","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Organizations"],"security":[{"api-key":[]}]}},"/v1/organizations/members/{memberId}":{"delete":{"operationId":"OrganizationController_remove","x-speakeasy-group":"Organizations.Members","summary":"Remove a member from organization using memberId","parameters":[{"name":"memberId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Organizations"],"security":[{"api-key":[]}]}},"/v1/organizations/members":{"get":{"operationId":"OrganizationController_listOrganizationMembers","x-speakeasy-group":"Organizations.Members","summary":"Fetch all members of current organizations","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Organizations"],"security":[{"api-key":[]}]}},"/v1/organizations/branding":{"put":{"operationId":"OrganizationController_updateBrandingDetails","x-speakeasy-group":"Organizations.Branding","summary":"Update organization branding details","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandingDetailsDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationBrandingResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Organizations"],"security":[{"api-key":[]}]}},"/v1/environments/me":{"get":{"operationId":"EnvironmentsController_getCurrentEnvironment","summary":"Get current environment","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Environments"],"security":[{"api-key":[]}]}},"/v1/environments":{"get":{"operationId":"EnvironmentsController_listMyEnvironments","summary":"Get environments","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Environments"],"security":[{"api-key":[]}]}},"/v1/environments/api-keys":{"get":{"operationId":"EnvironmentsController_listOrganizationApiKeys","x-speakeasy-group":"Environments.ApiKeys","summary":"Get api keys","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Environments"],"security":[{"api-key":[]}]}},"/v1/environments/api-keys/regenerate":{"post":{"operationId":"EnvironmentsController_regenerateOrganizationApiKeys","x-speakeasy-name-override":"regenerate","x-speakeasy-group":"Environments.ApiKeys","summary":"Regenerate api keys","parameters":[],"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Environments"],"security":[{"api-key":[]}]}},"/v1/execution-details":{"get":{"operationId":"ExecutionDetailsController_getExecutionDetailsForNotification","summary":"Get execution details","parameters":[{"name":"notificationId","required":true,"in":"query","schema":{"type":"string"}},{"name":"subscriberId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionDetailsResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Execution Details"],"security":[{"api-key":[]}]}},"/v1/workflows":{"get":{"operationId":"WorkflowController_listWorkflows","summary":"Get workflows","description":"Workflows were previously named notification templates","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":100,"default":10,"type":"number"}},{"name":"query","required":false,"in":"query","description":"A query string to filter the results. It allows filtering based on either the name or trigger identifier of the workflow items.","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowsResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflows"],"security":[{"api-key":[]}]},"post":{"operationId":"WorkflowController_create","summary":"Create workflow","description":"Workflow was previously named notification template","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRequestDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflows"],"security":[{"api-key":[]}]}},"/v1/workflows/{workflowId}":{"put":{"operationId":"WorkflowController_updateWorkflowById","summary":"Update workflow","description":"Workflow was previously named notification template","parameters":[{"name":"workflowId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflows"],"security":[{"api-key":[]}]},"delete":{"operationId":"WorkflowController_deleteWorkflowById","summary":"Delete workflow","description":"Workflow was previously named notification template","parameters":[{"name":"workflowId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataBooleanDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflows"],"security":[{"api-key":[]}]},"get":{"operationId":"WorkflowController_getWorkflowById","summary":"Get workflow","description":"Workflow was previously named notification template","parameters":[{"name":"workflowId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflows"],"security":[{"api-key":[]}]}},"/v1/workflows/variables":{"get":{"operationId":"WorkflowController_getWorkflowVariables","x-speakeasy-group":"Workflows.Variables","summary":"Get available variables","description":"Get the variables that can be used in the workflow","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariablesResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflows"],"security":[{"api-key":[]}]}},"/v1/workflows/{workflowId}/status":{"put":{"operationId":"WorkflowController_updateActiveStatus","x-speakeasy-group":"Workflows.Status","summary":"Update workflow status","description":"Workflow was previously named notification template","parameters":[{"name":"workflowId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeWorkflowStatusRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflows"],"security":[{"api-key":[]}]}},"/v1/events/trigger":{"post":{"operationId":"EventsController_trigger","x-speakeasy-usage-example":{"title":"Trigger Notification Event"},"x-speakeasy-name-override":"trigger","summary":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. \n The trigger identifier is used to match the particular workflow associated with it. \n Additional information can be passed according the body interface below.\n ","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerEventRequestDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerEventResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Events"],"security":[{"api-key":[]}]}},"/v1/events/trigger/bulk":{"post":{"operationId":"EventsController_triggerBulk","x-speakeasy-name-override":"triggerBulk","summary":"Bulk trigger event","description":"\n Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.\n The bulk API is limited to 100 events per request.\n ","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTriggerEventDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TriggerEventResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Events"],"security":[{"api-key":[]}]}},"/v1/events/trigger/broadcast":{"post":{"operationId":"EventsController_broadcastEventToAll","x-speakeasy-name-override":"triggerBroadcast","summary":"Broadcast event to all","description":"Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.\n In the future could be used to trigger events to a subset of subscribers based on defined filters.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerEventToAllRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerEventResponseDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerEventResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Events"],"security":[{"api-key":[]}]}},"/v1/events/trigger/{transactionId}":{"delete":{"operationId":"EventsController_cancel","x-speakeasy-name-override":"cancel","summary":"Cancel triggered event","description":"\n Using a previously generated transactionId during the event trigger,\n will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...\n ","parameters":[{"name":"transactionId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataBooleanDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Events"],"security":[{"api-key":[]}]}},"/v1/notifications":{"get":{"operationId":"NotificationsController_listNotifications","summary":"Get notifications","parameters":[{"name":"channels","required":true,"in":"query","schema":{"type":"array","items":{"type":"string","enum":["in_app","email","sms","chat","push"]}}},{"name":"templates","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"emails","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"search","required":true,"in":"query","deprecated":true,"schema":{"type":"string"}},{"name":"subscriberIds","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"page","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"transactionId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivitiesResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Notifications"],"security":[{"api-key":[]}]}},"/v1/notifications/stats":{"get":{"operationId":"NotificationsController_getActivityStats","x-speakeasy-group":"Notifications.Stats","summary":"Get notification statistics","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityStatsResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Notifications"],"security":[{"api-key":[]}]}},"/v1/notifications/graph/stats":{"get":{"operationId":"NotificationsController_getActivityGraphStats","x-speakeasy-name-override":"graph","x-speakeasy-group":"Notifications.Stats","summary":"Get notification graph statistics","parameters":[{"name":"days","required":false,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActivityGraphStatesResponse"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Notifications"],"security":[{"api-key":[]}]}},"/v1/notifications/{notificationId}":{"get":{"operationId":"NotificationsController_getNotification","summary":"Get notification","parameters":[{"name":"notificationId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityNotificationResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Notifications"],"security":[{"api-key":[]}]}},"/v1/notification-groups":{"post":{"operationId":"NotificationGroupsController_createNotificationGroup","summary":"Create workflow group","description":"workflow group was previously named notification group","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotificationGroupRequestDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationGroupResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflow groups"],"security":[{"api-key":[]}]},"get":{"operationId":"NotificationGroupsController_listNotificationGroups","summary":"Get workflow groups","description":"workflow group was previously named notification group","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationGroupResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflow groups"],"security":[{"api-key":[]}]}},"/v1/notification-groups/{id}":{"get":{"operationId":"NotificationGroupsController_getNotificationGroup","summary":"Get workflow group","description":"workflow group was previously named notification group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationGroupResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflow groups"],"security":[{"api-key":[]}]},"patch":{"operationId":"NotificationGroupsController_updateNotificationGroup","summary":"Update workflow group","description":"workflow group was previously named notification group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotificationGroupRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationGroupResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflow groups"],"security":[{"api-key":[]}]},"delete":{"operationId":"NotificationGroupsController_deleteNotificationGroup","summary":"Delete workflow group","description":"workflow group was previously named notification group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNotificationGroupResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Workflow groups"],"security":[{"api-key":[]}]}},"/v1/integrations":{"get":{"operationId":"IntegrationsController_listIntegrations","summary":"Get integrations","description":"Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change","parameters":[],"responses":{"200":{"description":"The list of integrations belonging to the organization that are successfully returned.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Integrations"],"security":[{"api-key":[]}]},"post":{"operationId":"IntegrationsController_createIntegration","summary":"Create integration","description":"Create an integration for the current environment the user is based on the API key provided","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationRequestDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Integrations"],"security":[{"api-key":[]}]}},"/v1/integrations/active":{"get":{"operationId":"IntegrationsController_getActiveIntegrations","x-speakeasy-name-override":"listActive","summary":"Get active integrations","description":"Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change","parameters":[],"responses":{"200":{"description":"The list of active integrations belonging to the organization that are successfully returned.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Integrations"],"security":[{"api-key":[]}]}},"/v1/integrations/webhook/provider/{providerOrIntegrationId}/status":{"get":{"operationId":"IntegrationsController_getWebhookSupportStatus","x-speakeasy-group":"Integrations.Webhooks","summary":"Get webhook support status for provider","description":"Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value","parameters":[{"name":"providerOrIntegrationId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The status of the webhook for the provider requested","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"boolean"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Integrations"],"security":[{"api-key":[]}]}},"/v1/integrations/{integrationId}":{"put":{"operationId":"IntegrationsController_updateIntegrationById","summary":"Update integration","parameters":[{"name":"integrationId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponseDto"}}}},"404":{"description":"The integration with the integrationId provided does not exist in the database.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Integrations"],"security":[{"api-key":[]}]},"delete":{"operationId":"IntegrationsController_removeIntegration","summary":"Delete integration","parameters":[{"name":"integrationId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Integrations"],"security":[{"api-key":[]}]}},"/v1/integrations/{integrationId}/set-primary":{"post":{"operationId":"IntegrationsController_setIntegrationAsPrimary","x-speakeasy-name-override":"setAsPrimary","summary":"Set integration as primary","parameters":[{"name":"integrationId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponseDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponseDto"}}}},"404":{"description":"The integration with the integrationId provided does not exist in the database.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Integrations"],"security":[{"api-key":[]}]}},"/v1/changes":{"get":{"operationId":"ChangesController_getChanges","summary":"Get changes","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":100,"default":10,"type":"number"}},{"name":"promoted","required":true,"in":"query","schema":{"default":"false","type":"string"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangesResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Changes"],"security":[{"api-key":[]}]}},"/v1/changes/count":{"get":{"operationId":"ChangesController_getChangesCount","x-speakeasy-name-override":"count","summary":"Get changes count","parameters":[],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataNumberDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Changes"],"security":[{"api-key":[]}]}},"/v1/changes/bulk/apply":{"post":{"operationId":"ChangesController_bulkApplyDiff","x-speakeasy-name-override":"applyBulk","summary":"Apply changes","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkApplyChangeDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChangeResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Changes"],"security":[{"api-key":[]}]}},"/v1/changes/{changeId}/apply":{"post":{"operationId":"ChangesController_applyDiff","x-speakeasy-name-override":"apply","summary":"Apply change","parameters":[{"name":"changeId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChangeResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Changes"],"security":[{"api-key":[]}]}},"/v1/subscribers":{"get":{"operationId":"SubscribersController_listSubscribers","x-speakeasy-pagination":{"type":"offsetLimit","inputs":[{"name":"page","in":"parameters","type":"page"},{"name":"limit","in":"parameters","type":"limit"}],"outputs":{"results":"$.data.resultArray"}},"summary":"Get subscribers","description":"Returns a list of subscribers, could paginated using the `page` and `limit` query parameter","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":100,"default":10,"type":"number"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponseDto"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberResponseDto"}}}}]}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]},"post":{"operationId":"SubscribersController_createSubscriber","summary":"Create subscriber","description":"Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriberRequestDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}":{"get":{"operationId":"SubscribersController_getSubscriber","summary":"Get subscriber","description":"Get subscriber by your internal id used to identify the subscriber","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]},"put":{"operationId":"SubscribersController_updateSubscriber","summary":"Update subscriber","description":"Used to update the subscriber entity with new information","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]},"delete":{"operationId":"SubscribersController_removeSubscriber","summary":"Delete subscriber","description":"Deletes a subscriber entity from the Novu platform","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSubscriberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/bulk":{"post":{"operationId":"SubscribersController_bulkCreateSubscribers","x-speakeasy-name-override":"createBulk","summary":"Bulk create subscribers","description":"\n Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.\n The bulk API is limited to 500 subscribers per request.\n ","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSubscriberCreateDto"}}}},"responses":{"201":{"description":""},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/credentials":{"put":{"operationId":"SubscribersController_updateSubscriberChannel","x-speakeasy-group":"Subscribers.Credentials","summary":"Update subscriber credentials","description":"Subscriber credentials associated to the delivery methods such as slack and push tokens.","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberChannelRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]},"patch":{"operationId":"SubscribersController_modifySubscriberChannel","x-speakeasy-name-override":"append","x-speakeasy-group":"Subscribers.Credentials","summary":"Modify subscriber credentials","description":"Subscriber credentials associated to the delivery methods such as slack and push tokens.\n This endpoint appends provided credentials and deviceTokens to the existing ones.","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberChannelRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/credentials/{providerId}":{"delete":{"operationId":"SubscribersController_deleteSubscriberCredentials","x-speakeasy-group":"Subscribers.Credentials","summary":"Delete subscriber credentials by providerId","description":"Delete subscriber credentials such as slack and expo tokens.","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"providerId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":""},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/online-status":{"patch":{"operationId":"SubscribersController_updateSubscriberOnlineFlag","x-speakeasy-name-override":"updateOnlineFlag","x-speakeasy-group":"Subscribers.properties","summary":"Update subscriber online status","description":"Used to update the subscriber isOnline flag.","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberOnlineFlagRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/preferences":{"get":{"operationId":"SubscribersController_listSubscriberPreferences","x-speakeasy-group":"Subscribers.Preferences","summary":"Get subscriber preferences","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateSubscriberPreferenceResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]},"patch":{"operationId":"SubscribersController_updateSubscriberGlobalPreferences","x-speakeasy-name-override":"updateGlobal","x-speakeasy-group":"Subscribers.Preferences","summary":"Update subscriber global preferences","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberGlobalPreferencesRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberPreferenceResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/preferences/{parameter}":{"get":{"operationId":"SubscribersController_getSubscriberPreferenceByLevel","x-speakeasy-name-override":"retrieveByLevel","x-speakeasy-group":"Subscribers.Preferences","summary":"Get subscriber preferences by level","parameters":[{"name":"parameter","required":true,"in":"path","schema":{"type":"string"}},{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetSubscriberPreferencesResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]},"patch":{"operationId":"SubscribersController_updateSubscriberPreference","x-speakeasy-group":"Subscribers.Preferences","summary":"Update subscriber preference","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"parameter","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberPreferenceRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberPreferenceResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/notifications/feed":{"get":{"operationId":"SubscribersController_getNotificationsFeed","x-speakeasy-group":"Subscribers.Notifications","summary":"Get in-app notification feed for a particular subscriber","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":100,"default":10,"type":"number"}},{"name":"read","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"seen","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"payload","required":false,"in":"query","description":"Base64 encoded string of the partial payload JSON object","example":"btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=","schema":{"type":"string"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponseDto"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FeedResponseDto"}}}}]}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/notifications/unseen":{"get":{"operationId":"SubscribersController_getUnseenCount","x-speakeasy-name-override":"unseenCount","x-speakeasy-group":"Subscribers.Notifications","summary":"Get the unseen in-app notifications count for subscribers feed","parameters":[{"name":"seen","required":true,"in":"query","schema":{"type":"boolean"}},{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnseenCountResponse"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/messages/mark-as":{"post":{"operationId":"SubscribersController_markMessagesAs","x-speakeasy-name-override":"markAllAs","x-speakeasy-group":"Subscribers.Messages","summary":"Mark a subscriber messages as seen, read, unseen or unread","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageMarkAsRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/messages/mark-all":{"post":{"operationId":"SubscribersController_markAllUnreadAsRead","x-speakeasy-name-override":"markAll","x-speakeasy-group":"Subscribers.Messages","summary":"Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkAllMessageAsRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"number"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}":{"post":{"operationId":"SubscribersController_markActionAsSeen","x-speakeasy-name-override":"updateAsSeen","x-speakeasy-group":"Subscribers.Messages","summary":"Mark message action as seen","parameters":[{"name":"messageId","required":true,"in":"path","schema":{"type":"string"}},{"name":"type","required":true,"in":"path","schema":{"type":"string"}},{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkMessageActionAsSeenDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback":{"get":{"operationId":"SubscribersController_chatOauthCallback","x-speakeasy-name-override":"chatAccessOauthCallBack","x-speakeasy-group":"Subscribers.Authentication","summary":"Handle providers oauth redirect","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"providerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"code","required":true,"in":"query","schema":{"type":"string"}},{"name":"hmacHash","required":true,"in":"query","schema":{"type":"string"}},{"name":"environmentId","required":true,"in":"query","schema":{"type":"string"}},{"name":"integrationIdentifier","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth":{"get":{"operationId":"SubscribersController_chatAccessOauth","x-speakeasy-name-override":"chatAccessOauth","x-speakeasy-group":"Subscribers.Authentication","summary":"Handle chat oauth","parameters":[{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"providerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"hmacHash","required":true,"in":"query","schema":{"type":"string"}},{"name":"environmentId","required":true,"in":"query","schema":{"type":"string"}},{"name":"integrationIdentifier","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Subscribers"],"security":[{"api-key":[]}]}},"/v1/feeds":{"post":{"operationId":"FeedsController_createFeed","summary":"Create feed","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedRequestDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Feeds"],"security":[{"api-key":[]}]},"get":{"operationId":"FeedsController_getFeeds","summary":"Get feeds","parameters":[],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FeedResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Feeds"],"security":[{"api-key":[]}]}},"/v1/feeds/{feedId}":{"delete":{"operationId":"FeedsController_deleteFeedById","summary":"Delete feed","parameters":[{"name":"feedId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FeedResponseDto"}}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Feeds"],"security":[{"api-key":[]}]}},"/v1/layouts":{"post":{"operationId":"LayoutsController_PropertyDescriptor","x-speakeasy-name-override":"create","summary":"Layout creation","description":"Create a layout","parameters":[],"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLayoutResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Layouts"],"security":[{"api-key":[]}]},"get":{"operationId":"LayoutsController_listLayouts","summary":"Filter layouts","description":"Returns a list of layouts that can be paginated using the `page` query parameter and filtered by the environment where it is executed from the organization the user belongs to.","parameters":[{"name":"page","required":false,"in":"query","description":"Number of page for pagination","schema":{"minimum":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Size of page for pagination","schema":{"minimum":0,"type":"number"}},{"name":"sortBy","required":false,"in":"query","description":"Sort field. Currently only supported `createdAt`","schema":{"type":"string"}},{"name":"orderBy","required":false,"in":"query","description":"Direction of the sorting query param","schema":{"enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"The list of layouts that match the criteria of the query params are successfully returned.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"400":{"description":"Page size can not be larger than the page size limit.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Layouts"],"security":[{"api-key":[]}]}},"/v1/layouts/{layoutId}":{"get":{"operationId":"LayoutsController_getLayout","summary":"Get layout","description":"Get a layout by its ID","parameters":[{"name":"layoutId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLayoutResponseDto"}}}},"404":{"description":"The layout with the layoutId provided does not exist in the database.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Layouts"],"security":[{"api-key":[]}]},"delete":{"operationId":"LayoutsController_deleteLayout","summary":"Delete layout","description":"Execute a soft delete of a layout given a certain ID.","parameters":[{"name":"layoutId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":"The layout has been deleted correctly","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"404":{"description":"The layout with the layoutId provided does not exist in the database so it can not be deleted.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"Either you are trying to delete a layout that is being used or a layout that is the default in the environment.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Layouts"],"security":[{"api-key":[]}]},"patch":{"operationId":"LayoutsController_updateLayout","summary":"Update a layout","description":"Update the name, content and variables of a layout. Also change it to be default or no.","parameters":[{"name":"layoutId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLayoutRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLayoutResponseDto"}}}},"400":{"description":"The payload provided or the URL param are not right.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"404":{"description":"The layout with the layoutId provided does not exist in the database so it can not be updated.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"One default layout is needed. If you are trying to turn a default layout as not default, you should turn a different layout as default first and automatically it will be done by the system.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"example":"One default layout is required"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Layouts"],"security":[{"api-key":[]}]}},"/v1/layouts/{layoutId}/default":{"post":{"operationId":"LayoutsController_setDefaultLayout","x-speakeasy-name-override":"setAsDefault","summary":"Set default layout","description":"Sets the default layout for the environment and updates to non default to the existing default layout (if any).","parameters":[{"name":"layoutId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":"The selected layout has been set as the default for the environment.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"404":{"description":"The layout with the layoutId provided does not exist in the database so it can not be set as the default for the environment.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Layouts"],"security":[{"api-key":[]}]}},"/v1/messages":{"get":{"operationId":"MessagesController_getMessages","summary":"Get messages","description":"Returns a list of messages, could paginate using the `page` query parameter","parameters":[{"name":"channel","required":false,"in":"query","schema":{"enum":["in_app","email","sms","chat","push"],"type":"string"}},{"name":"subscriberId","required":false,"in":"query","schema":{"type":"string"}},{"name":"transactionId","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"page","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"default":10,"type":"number"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivitiesResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Messages"],"security":[{"api-key":[]}]}},"/v1/messages/{messageId}":{"delete":{"operationId":"MessagesController_deleteMessage","summary":"Delete message","description":"Deletes a message entity from the Novu platform","parameters":[{"name":"messageId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Messages"],"security":[{"api-key":[]}]}},"/v1/messages/transaction/{transactionId}":{"delete":{"operationId":"MessagesController_deleteMessagesByTransactionId","x-speakeasy-name-override":"deleteByTransactionId","summary":"Delete messages by transactionId","description":"Deletes messages entity from the Novu platform using TransactionId of message","parameters":[{"name":"channel","required":false,"in":"query","description":"The channel of the message to be deleted","schema":{"enum":["in_app","email","sms","chat","push"],"type":"string"}},{"name":"transactionId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":""},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Messages"],"security":[{"api-key":[]}]}},"/v1/topics":{"post":{"operationId":"TopicsController_createTopic","summary":"Topic creation","description":"Create a topic","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTopicRequestDto"}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTopicResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]},"get":{"operationId":"TopicsController_listTopics","summary":"Filter topics","description":"Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter","parameters":[{"name":"page","required":false,"in":"query","description":"Number of page for the pagination","schema":{"minimum":0,"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Size of page for the pagination","schema":{"minimum":0,"default":10,"type":"number"}},{"name":"key","required":false,"in":"query","description":"Topic key","schema":{"type":"string"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterTopicsResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]}},"/v1/topics/{topicKey}/subscribers":{"post":{"operationId":"TopicsController_addSubscribers","x-speakeasy-name-override":"assign","x-speakeasy-group":"Topics.Subscribers","summary":"Subscribers addition","description":"Add subscribers to a topic by key","parameters":[{"name":"topicKey","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSubscribersRequestDto"}}}},"responses":{"200":{"description":""},"204":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":""},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]}},"/v1/topics/{topicKey}/subscribers/{externalSubscriberId}":{"get":{"operationId":"TopicsController_getTopicSubscriber","x-speakeasy-group":"Topics.Subscribers","summary":"Check topic subscriber","description":"Check if a subscriber belongs to a certain topic","parameters":[{"name":"topicKey","required":true,"in":"path","schema":{"type":"string"}},{"name":"externalSubscriberId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicSubscriberDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]}},"/v1/topics/{topicKey}/subscribers/removal":{"post":{"operationId":"TopicsController_removeSubscribers","x-speakeasy-group":"Topics.Subscribers","summary":"Subscribers removal","description":"Remove subscribers from a topic","parameters":[{"name":"topicKey","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveSubscribersRequestDto"}}}},"responses":{"204":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":""},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]}},"/v1/topics/{topicKey}":{"delete":{"operationId":"TopicsController_deleteTopic","summary":"Delete topic","description":"Delete a topic by its topic key if it has no subscribers","parameters":[{"name":"topicKey","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":"The topic has been deleted correctly","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"404":{"description":"The topic with the key provided does not exist in the database so it can not be deleted.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The topic you are trying to delete has subscribers assigned to it. Delete the subscribers before deleting the topic.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]},"get":{"operationId":"TopicsController_getTopic","summary":"Get topic","description":"Get a topic by its topic key","parameters":[{"name":"topicKey","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTopicResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]},"patch":{"operationId":"TopicsController_renameTopic","x-speakeasy-name-override":"rename","summary":"Rename a topic","description":"Rename a topic by providing a new name","parameters":[{"name":"topicKey","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameTopicRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameTopicResponseDto"}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Topics"],"security":[{"api-key":[]}]}},"/v1/tenants":{"get":{"operationId":"TenantController_listTenants","x-speakeasy-pagination":{"type":"offsetLimit","inputs":[{"name":"page","in":"parameters","type":"page"},{"name":"limit","in":"parameters","type":"limit"}],"outputs":{"results":"$.data.resultArray"}},"summary":"Get tenants","description":"Returns a list of tenants, could paginated using the `page` and `limit` query parameter","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":100,"default":10,"type":"number"}}],"responses":{"200":{"headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponseDto"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetTenantResponseDto"}}}}]}}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Tenants"],"security":[{"api-key":[]}]},"post":{"operationId":"TenantController_createTenant","summary":"Create tenant","description":"Create tenant under the current environment","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTenantRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTenantResponseDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTenantResponseDto"}}}},"409":{"description":"A tenant with the same identifier is already exist.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Tenants"],"security":[{"api-key":[]}]}},"/v1/tenants/{identifier}":{"get":{"operationId":"TenantController_getTenantById","summary":"Get tenant","description":"Get tenant by your internal id used to identify the tenant","parameters":[{"name":"identifier","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTenantResponseDto"}}}},"404":{"description":"The tenant with the identifier provided does not exist in the database.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Tenants"],"security":[{"api-key":[]}]},"patch":{"operationId":"TenantController_updateTenant","summary":"Update tenant","description":"Update tenant by your internal id used to identify the tenant","parameters":[{"name":"identifier","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTenantRequestDto"}}}},"responses":{"200":{"description":"Ok","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTenantResponseDto"}}}},"404":{"description":"The tenant with the identifier provided does not exist in the database.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Tenants"],"security":[{"api-key":[]}]},"delete":{"operationId":"TenantController_removeTenant","summary":"Delete tenant","description":"Deletes a tenant entity from the Novu platform","parameters":[{"name":"identifier","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":"The tenant has been deleted correctly","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"404":{"description":"The tenant with the identifier provided does not exist in the database so it can not be deleted.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"}}},"409":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Link":{"$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}}}},"429":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded"}}}},"503":{"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.","headers":{"Content-Type":{"$ref":"#/components/headers/Content-Type"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Idempotency-Replay":{"$ref":"#/components/headers/Idempotency-Replay"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again."}}}}},"tags":["Tenants"],"security":[{"api-key":[]}]}}},"info":{"title":"Novu API","description":"Novu REST API. Please see https://docs.novu.co/api-reference for more details.","version":"1.0","contact":{"name":"Novu Support","url":"https://discord.gg/novu","email":"support@novu.co"},"termsOfService":"https://novu.co/terms","license":{"name":"MIT","url":"https://opensource.org/license/mit"}},"tags":[{"name":"Events","description":"Events represent a change in state of a subscriber. They are used to trigger workflows, and enable you to send notifications to subscribers based on their actions.","externalDocs":{"url":"https://docs.novu.co/workflows"}},{"name":"Subscribers","description":"A subscriber in Novu represents someone who should receive a message. A subscriber’s profile information contains important attributes about the subscriber that will be used in messages (name, email). The subscriber object can contain other key-value pairs that can be used to further personalize your messages.","externalDocs":{"url":"https://docs.novu.co/subscribers/subscribers"}},{"name":"Topics","description":"Topics are a way to group subscribers together so that they can be notified of events at once. A topic is identified by a custom key. This can be helpful for things like sending out marketing emails or notifying users of new features. Topics can also be used to send notifications to the subscribers who have been grouped together based on their interests, location, activities and much more.","externalDocs":{"url":"https://docs.novu.co/subscribers/topics"}},{"name":"Notification","description":"A notification conveys information from source to recipient, triggered by a workflow acting as a message blueprint. Notifications can be individual or bundled as digest for user-friendliness.","externalDocs":{"url":"https://docs.novu.co/getting-started/introduction"}},{"name":"Integrations","description":"With the help of the Integration Store, you can easily integrate your favorite delivery provider. During the runtime of the API, the Integrations Store is responsible for storing the configurations of all the providers.","externalDocs":{"url":"https://docs.novu.co/channels-and-providers/integration-store"}},{"name":"Layouts","description":"Novu allows the creation of layouts - a specific HTML design or structure to wrap content of email notifications. Layouts can be manipulated and assigned to new or existing workflows within the Novu platform, allowing users to create, manage, and assign these layouts to workflows, so they can be reused to structure the appearance of notifications sent through the platform.","externalDocs":{"url":"https://docs.novu.co/content-creation-design/layouts"}},{"name":"Workflows","description":"All notifications are sent via a workflow. Each workflow acts as a container for the logic and blueprint that are associated with a type of notification in your system.","externalDocs":{"url":"https://docs.novu.co/workflows"}},{"name":"Notification Templates","description":"Deprecated. Use Workflows (/workflows) instead, which provide the same functionality under a new name."},{"name":"Workflow groups","description":"Workflow groups are used to organize workflows into logical groups."},{"name":"Changes","description":"Changes represent a change in state of an environment. They are analagous to a pending pull request in git, enabling you to test changes before they are applied to your environment and atomically apply them when you are ready.","externalDocs":{"url":"https://docs.novu.co/platform/environments#promoting-pending-changes-to-production"}},{"name":"Environments","description":"Novu uses the concept of environments to ensure logical separation of your data and configuration. This means that subscribers, and preferences created in one environment are never accessible to another.","externalDocs":{"url":"https://docs.novu.co/platform/environments"}},{"name":"Inbound Parse","description":"Inbound Webhook is a feature that allows processing of incoming emails for a domain or subdomain. The feature parses the contents of the email and POSTs the information to a specified URL in a multipart/form-data format.","externalDocs":{"url":"https://docs.novu.co/platform/inbound-parse-webhook"}},{"name":"Feeds","description":"Novu provides a notification activity feed that monitors every outgoing message associated with its relevant metadata. This can be used to monitor activity and discover potential issues with a specific provider or a channel type.","externalDocs":{"url":"https://docs.novu.co/activity-feed"}},{"name":"Tenants","description":"A tenant represents a group of users. As a developer, when your apps have organizations, they are referred to as tenants. Tenants in Novu provides the ability to tailor specific notification experiences to users of different groups or organizations.","externalDocs":{"url":"https://docs.novu.co/tenants"}},{"name":"Messages","description":"A message in Novu represents a notification delivered to a recipient on a particular channel. Messages contain information about the request that triggered its delivery, a view of the data sent to the recipient, and a timeline of its lifecycle events. Learn more about messages.","externalDocs":{"url":"https://docs.novu.co/workflows/messages"}},{"name":"Organizations","description":"An organization serves as a separate entity within your Novu account. Each organization you create has its own separate integration store, workflows, subscribers, and API keys. This separation of resources allows you to manage multi-tenant environments and separate domains within a single account.","externalDocs":{"url":"https://docs.novu.co/platform/organizations"}},{"name":"Execution Details","description":"Execution details are used to track the execution of a workflow. They provided detailed information on the execution of a workflow, including the status of each step, the input and output of each step, and the overall status of the execution.","externalDocs":{"url":"https://docs.novu.co/activity-feed"}}],"servers":[{"url":"https://api.novu.co"},{"url":"https://eu.api.novu.co"}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"Authorization","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \"."}},"schemas":{"DataWrapperDto":{"type":"object","properties":{"data":{"type":"object"}},"required":["data"]},"OrganizationBrandingResponseDto":{"type":"object","properties":{"direction":{"enum":["ltr","trl"],"type":"string"},"logo":{"type":"string"},"color":{"type":"string"},"fontColor":{"type":"string"},"contentBackground":{"type":"string"},"fontFamily":{"type":"string"}},"required":["logo","color","fontColor","contentBackground"]},"IPartnerConfigurationResponseDto":{"type":"object","properties":{"projectIds":{"type":"array","items":{"type":"string"}},"accessToken":{"type":"string"},"configurationId":{"type":"string"},"teamId":{"type":"string"},"partnerType":{"type":"string","enum":["vercel"],"description":"Partner Type Enum"}},"required":["accessToken","configurationId","partnerType"]},"OrganizationResponseDto":{"type":"object","properties":{"name":{"type":"string"},"logo":{"type":"string"},"branding":{"$ref":"#/components/schemas/OrganizationBrandingResponseDto"},"partnerConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/IPartnerConfigurationResponseDto"}}},"required":["name","branding"]},"CreateOrganizationDto":{"type":"object","properties":{"name":{"type":"string"},"logo":{"type":"string"},"jobTitle":{"enum":["engineer","engineering_manager","architect","product_manager","designer","cxo_founder","marketing_manager","other"],"type":"string"},"domain":{"type":"string"},"productUseCases":{"type":"object"}},"required":["name"]},"MemberUserDto":{"type":"object","properties":{"_id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["_id","firstName","lastName","email"]},"MemberInviteDTO":{"type":"object","properties":{"email":{"type":"string"},"token":{"type":"string"},"invitationDate":{"format":"date-time","type":"string"},"answerDate":{"format":"date-time","type":"string"},"_inviterId":{"type":"string"}},"required":["email","token","invitationDate","_inviterId"]},"MemberResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_userId":{"type":"string"},"user":{"$ref":"#/components/schemas/MemberUserDto"},"roles":{"enum":["admin","member"],"type":"string"},"invite":{"$ref":"#/components/schemas/MemberInviteDTO"},"memberStatus":{"enum":["new","active","invited"],"type":"string"},"_organizationId":{"type":"string"}},"required":["_id","_userId","_organizationId"]},"UpdateBrandingDetailsDto":{"type":"object","properties":{"logo":{"type":"string"},"color":{"type":"string"},"fontColor":{"type":"string"},"contentBackground":{"type":"string"},"fontFamily":{"type":"string"}},"required":["logo","color","fontColor","contentBackground"]},"RenameOrganizationDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"EnvironmentResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"_organizationId":{"type":"string"},"identifier":{"type":"string"},"apiKeys":{"type":"array","items":{"type":"object"}},"_parentId":{"type":"string"}},"required":["name","_organizationId","identifier","_parentId"]},"ApiKey":{"type":"object","properties":{"key":{"type":"string"},"_userId":{"type":"string"}},"required":["key","_userId"]},"ExecutionDetailsResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_organizationId":{"type":"string"},"_jobId":{"type":"string"},"_environmentId":{"type":"string"},"_notificationId":{"type":"string"},"_notificationTemplateId":{"type":"string"},"_subscriberId":{"type":"string"},"_messageId":{"type":"string"},"providerId":{"type":"string"},"transactionId":{"type":"string"},"channel":{"type":"string","enum":["in_app","email","sms","chat","push","digest","trigger","delay","custom"]},"detail":{"type":"string"},"source":{"type":"string","enum":["Credentials","Internal","Payload","Webhook"]},"status":{"type":"string","enum":["Success","Warning","Failed","Pending","Queued","ReadConfirmation"]},"isTest":{"type":"boolean"},"isRetry":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["_organizationId","_jobId","_environmentId","_notificationId","_notificationTemplateId","_subscriberId","transactionId","channel","detail","source","status","isTest","isRetry"]},"NotificationGroup":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"_environmentId":{"type":"string"},"_organizationId":{"type":"string"},"_parentId":{"type":"string"}},"required":["name","_environmentId","_organizationId"]},"PreferenceChannels":{"type":"object","properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"},"in_app":{"type":"boolean"},"chat":{"type":"boolean"},"push":{"type":"boolean"}}},"DigestRegularMetadata":{"type":"object","properties":{"amount":{"type":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"]},"digestKey":{"type":"string"},"type":{"type":"string","enum":["regular","backoff"]},"backoff":{"type":"boolean"},"backoffAmount":{"type":"number"},"backoffUnit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"]},"updateMode":{"type":"boolean"}},"required":["type"]},"TimedConfig":{"type":"object","properties":{"atTime":{"type":"string"},"weekDays":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]}},"monthDays":{"type":"array","items":{"type":"string"}},"ordinal":{"type":"string","enum":["1","2","3","4","5","last"]},"ordinalValue":{"type":"string","enum":["day","weekday","weekend","sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"monthlyType":{"type":"string","enum":["each","on"]}}},"DigestTimedMetadata":{"type":"object","properties":{"amount":{"type":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"]},"digestKey":{"type":"string"},"type":{"type":"string","enum":["timed"]},"timed":{"$ref":"#/components/schemas/TimedConfig"}},"required":["type"]},"DelayRegularMetadata":{"type":"object","properties":{"amount":{"type":"number"},"unit":{"type":"string","enum":["seconds","minutes","hours","days","weeks","months"]},"type":{"type":"string","enum":["regular"]}},"required":["type"]},"DelayScheduledMetadata":{"type":"object","properties":{"type":{"type":"string","enum":["scheduled"]},"delayPath":{"type":"string"}},"required":["type","delayPath"]},"MessageTemplate":{"type":"object","properties":{}},"FieldFilterPart":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"operator":{"type":"string","enum":["LARGER","SMALLER","LARGER_EQUAL","SMALLER_EQUAL","EQUAL","NOT_EQUAL","ALL_IN","ANY_IN","NOT_IN","BETWEEN","NOT_BETWEEN","LIKE","NOT_LIKE","IN"]},"on":{"type":"string","enum":["subscriber","payload"]}},"required":["field","value","operator","on"]},"StepFilter":{"type":"object","properties":{"isNegated":{"type":"boolean"},"type":{"type":"string","enum":["BOOLEAN","TEXT","DATE","NUMBER","STATEMENT","LIST","MULTI_LIST","GROUP"]},"value":{"type":"string","enum":["AND","OR"]},"children":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterPart"}}},"required":["isNegated","type","value","children"]},"NotificationStepVariant":{"type":"object","properties":{"_id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"_templateId":{"type":"string"},"active":{"type":"boolean"},"shouldStopOnFail":{"type":"boolean"},"template":{"$ref":"#/components/schemas/MessageTemplate"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/StepFilter"}},"_parentId":{"type":"object"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/DigestRegularMetadata"},{"$ref":"#/components/schemas/DigestTimedMetadata"},{"$ref":"#/components/schemas/DelayRegularMetadata"},{"$ref":"#/components/schemas/DelayScheduledMetadata"}]},"replyCallback":{"type":"object"}}},"NotificationStep":{"type":"object","properties":{"_id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"_templateId":{"type":"string"},"active":{"type":"boolean"},"shouldStopOnFail":{"type":"boolean"},"template":{"$ref":"#/components/schemas/MessageTemplate"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/StepFilter"}},"_parentId":{"type":"object"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/DigestRegularMetadata"},{"$ref":"#/components/schemas/DigestTimedMetadata"},{"$ref":"#/components/schemas/DelayRegularMetadata"},{"$ref":"#/components/schemas/DelayScheduledMetadata"}]},"replyCallback":{"type":"object"},"variants":{"$ref":"#/components/schemas/NotificationStepVariant"}}},"NotificationTriggerVariable":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"NotificationTrigger":{"type":"object","properties":{"type":{"type":"string","enum":["event"]},"identifier":{"type":"string"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/NotificationTriggerVariable"}},"subscriberVariables":{"type":"array","items":{"$ref":"#/components/schemas/NotificationTriggerVariable"}}},"required":["type","identifier","variables"]},"WorkflowResponse":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean"},"draft":{"type":"boolean"},"preferenceSettings":{"$ref":"#/components/schemas/PreferenceChannels"},"critical":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/NotificationStep"}},"_organizationId":{"type":"string"},"_creatorId":{"type":"string"},"_environmentId":{"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/NotificationTrigger"}},"_notificationGroupId":{"type":"string"},"_parentId":{"type":"string"},"deleted":{"type":"boolean"},"deletedAt":{"type":"string"},"deletedBy":{"type":"string"},"notificationGroup":{"$ref":"#/components/schemas/NotificationGroup"},"data":{"type":"object"},"workflowIntegrationStatus":{"type":"object"}},"required":["name","description","active","draft","preferenceSettings","critical","tags","steps","_organizationId","_creatorId","_environmentId","triggers","_notificationGroupId","deleted","deletedAt","deletedBy"]},"WorkflowsResponseDto":{"type":"object","properties":{"totalCount":{"type":"number"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowResponse"}},"pageSize":{"type":"number"},"page":{"type":"number"}},"required":["totalCount","data","pageSize","page"]},"UpdateWorkflowRequestDto":{"type":"object","properties":{"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"description":{"type":"string","maxLength":300},"identifier":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/NotificationStep"}},"notificationGroupId":{"type":"string"},"critical":{"type":"boolean"},"preferenceSettings":{"$ref":"#/components/schemas/PreferenceChannels"},"data":{"type":"object"}},"required":["name","notificationGroupId"]},"DataBooleanDto":{"type":"object","properties":{"data":{"type":"boolean"}},"required":["data"]},"VariablesResponseDto":{"type":"object","properties":{"translations":{"type":"object"},"system":{"type":"object"}},"required":["translations","system"]},"CreateWorkflowRequestDto":{"type":"object","properties":{"name":{"type":"string"},"notificationGroupId":{"type":"string"},"notificationGroup":{"type":"object"},"tags":{"type":"array","items":{"type":"string"}},"description":{"type":"string","maxLength":1000},"steps":{"type":"array","items":{"$ref":"#/components/schemas/NotificationStep"}},"active":{"type":"boolean"},"draft":{"type":"boolean","deprecated":true},"critical":{"type":"boolean"},"preferenceSettings":{"$ref":"#/components/schemas/PreferenceChannels"},"blueprintId":{"type":"string"},"data":{"type":"object"}},"required":["name","notificationGroupId","steps"]},"ChangeWorkflowStatusRequestDto":{"type":"object","properties":{"active":{"type":"boolean"}},"required":["active"]},"TriggerEventResponseDto":{"type":"object","properties":{"acknowledged":{"type":"boolean","description":"If trigger was acknowledged or not"},"status":{"enum":["error","trigger_not_active","no_workflow_active_steps_defined","no_workflow_steps_defined","processed","subscriber_id_missing","no_tenant_found"],"type":"string","description":"Status for trigger"},"error":{"description":"In case of an error, this field will contain the error message","type":"array","items":{"type":"string"}},"transactionId":{"type":"string","description":"Transaction id for trigger"}},"required":["acknowledged","status"]},"TopicPayloadDto":{"type":"object","properties":{"topicKey":{"type":"string","example":"topic_key"},"type":{"enum":["Subscriber","Topic"],"type":"string","example":"Topic"}},"required":["topicKey","type"]},"TenantPayloadDto":{"type":"object","properties":{"identifier":{"type":"string"},"name":{"type":"string"},"data":{"type":"object"}}},"ChannelCredentialsDto":{"type":"object","properties":{"webhookUrl":{"type":"string"},"deviceTokens":{"type":"array","items":{"type":"string"}}}},"SubscriberChannelDto":{"type":"object","properties":{"integrationIdentifier":{"type":"string"},"providerId":{"type":"object"},"credentials":{"$ref":"#/components/schemas/ChannelCredentialsDto"}},"required":["providerId","credentials"]},"SubscriberPayloadDto":{"type":"object","properties":{"subscriberId":{"type":"string","description":"The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"avatar":{"type":"string","description":"An http url to the profile image of your subscriber"},"locale":{"type":"string"},"data":{"type":"object"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberChannelDto"}}},"required":["subscriberId"]},"TriggerEventRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.","example":"workflow_identifier"},"payload":{"type":"object","description":"The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. \n This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.","example":{"comment_id":"string","post":{"text":"string"}}},"overrides":{"type":"object","description":"This could be used to override provider specific configurations","example":{"fcm":{"data":{"key":"value"}}}},"to":{"type":"array","description":"The recipients list of people who will receive the notification.","items":{"oneOf":[{"$ref":"#/components/schemas/SubscriberPayloadDto"},{"type":"string","description":"Unique identifier of a subscriber in your systems","example":"SUBSCRIBER_ID"},{"$ref":"#/components/schemas/TopicPayloadDto"}]}},"transactionId":{"type":"string","description":"A unique identifier for this transaction, we will generated a UUID if not provided."},"actor":{"description":"It is used to display the Avatar of the provided actor's subscriber id or actor object.\n If a new actor object is provided, we will create a new subscriber in our system\n ","oneOf":[{"type":"string","description":"Unique identifier of a subscriber in your systems"},{"$ref":"#/components/schemas/SubscriberPayloadDto"}]},"tenant":{"description":"It is used to specify a tenant context during trigger event.\n Existing tenants will be updated with the provided details.\n ","oneOf":[{"type":"string","description":"Unique identifier of a tenant in your system"},{"$ref":"#/components/schemas/TenantPayloadDto"}]}},"required":["name","to"]},"BulkTriggerEventDto":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/TriggerEventRequestDto"}}},"required":["events"]},"TriggerEventToAllRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The trigger identifier associated for the template you wish to send. This identifier can be found on the template page."},"payload":{"type":"object","description":"The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. \n This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.","example":{"comment_id":"string","post":{"text":"string"}}},"overrides":{"type":"object","description":"This could be used to override provider specific configurations","example":{"fcm":{"data":{"key":"value"}}}},"transactionId":{"type":"string","description":"A unique identifier for this transaction, we will generated a UUID if not provided."},"actor":{"description":"It is used to display the Avatar of the provided actor's subscriber id or actor object.\n If a new actor object is provided, we will create a new subscriber in our system\n ","oneOf":[{"type":"string","description":"Unique identifier of a subscriber in your systems"},{"$ref":"#/components/schemas/SubscriberPayloadDto"}]},"tenant":{"description":"It is used to specify a tenant context during trigger event.\n If a new tenant object is provided, we will create a new tenant.\n ","oneOf":[{"type":"string","description":"Unique identifier of a tenant in your system"},{"$ref":"#/components/schemas/TenantPayloadDto"}]}},"required":["name","payload"]},"ActivityNotificationSubscriberResponseDto":{"type":"object","properties":{"firstName":{"type":"string"},"_id":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"}},"required":["_id"]},"ActivityNotificationTemplateResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/NotificationTrigger"}}},"required":["name","triggers"]},"ActivityNotificationExecutionDetailResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_jobId":{"type":"string"},"status":{"enum":["Success","Warning","Failed","Pending","Queued","ReadConfirmation"],"type":"string"},"detail":{"type":"string"},"isRetry":{"type":"boolean"},"isTest":{"type":"boolean"},"providerId":{"type":"object"},"raw":{"type":"string"},"source":{"enum":["Credentials","Internal","Payload","Webhook"],"type":"string"}},"required":["_id","_jobId","status","detail","isRetry","isTest","providerId","source"]},"MessageTemplateDto":{"type":"object","properties":{}},"ActivityNotificationStepResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"filters":{"$ref":"#/components/schemas/StepFilter"},"template":{"$ref":"#/components/schemas/MessageTemplateDto"}},"required":["_id","active","filters"]},"ActivityNotificationJobResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"type":{"type":"string"},"digest":{"type":"object"},"executionDetails":{"type":"array","items":{"$ref":"#/components/schemas/ActivityNotificationExecutionDetailResponseDto"}},"step":{"$ref":"#/components/schemas/ActivityNotificationStepResponseDto"},"payload":{"type":"object"},"providerId":{"type":"object"},"status":{"type":"string"}},"required":["_id","type","executionDetails","step","providerId","status"]},"ActivityNotificationResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_environmentId":{"type":"string"},"_organizationId":{"type":"string"},"transactionId":{"type":"string"},"createdAt":{"type":"string"},"channels":{"type":"string","items":{"type":"string","enum":["in_app","email","sms","chat","push","digest","trigger","delay","custom"]},"enum":["in_app","email","sms","chat","push","digest","trigger","delay","custom"]},"subscriber":{"$ref":"#/components/schemas/ActivityNotificationSubscriberResponseDto"},"template":{"$ref":"#/components/schemas/ActivityNotificationTemplateResponseDto"},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/ActivityNotificationJobResponseDto"}}},"required":["_environmentId","_organizationId","transactionId"]},"ActivitiesResponseDto":{"type":"object","properties":{"hasMore":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityNotificationResponseDto"}},"pageSize":{"type":"number"},"page":{"type":"number"}},"required":["hasMore","data","pageSize","page"]},"ActivityStatsResponseDto":{"type":"object","properties":{"weeklySent":{"type":"number"},"monthlySent":{"type":"number"}},"required":["weeklySent","monthlySent"]},"ActivityGraphStatesResponse":{"type":"object","properties":{"_id":{"type":"string"},"count":{"type":"number"},"templates":{"type":"array","items":{"type":"string"}},"channels":{"type":"array","items":{"type":"string","enum":["in_app","email","sms","chat","push"]}}},"required":["_id","count","templates","channels"]},"NotificationGroupResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"_environmentId":{"type":"string"},"_organizationId":{"type":"string"},"_parentId":{"type":"string"}},"required":["name","_environmentId","_organizationId"]},"CreateNotificationGroupRequestDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"DeleteNotificationGroupResponseDto":{"type":"object","properties":{"acknowledged":{"type":"boolean","description":"A boolean stating the success of the action"},"status":{"type":"string","description":"The status enum for the performed action","enum":["deleted"]}},"required":["acknowledged","status"]},"CredentialsDto":{"type":"object","properties":{"apiKey":{"type":"string"},"user":{"type":"string"},"secretKey":{"type":"string"},"domain":{"type":"string"},"password":{"type":"string"},"host":{"type":"string"},"port":{"type":"string"},"secure":{"type":"boolean"},"region":{"type":"string"},"accountSid":{"type":"string"},"messageProfileId":{"type":"string"},"token":{"type":"string"},"from":{"type":"string"},"senderName":{"type":"string"},"projectName":{"type":"string"},"applicationId":{"type":"string"},"clientId":{"type":"string"},"requireTls":{"type":"boolean"},"ignoreTls":{"type":"boolean"},"tlsOptions":{"type":"object"},"baseUrl":{"type":"string"},"webhookUrl":{"type":"string"},"redirectUrl":{"type":"string"},"hmac":{"type":"boolean"},"serviceAccount":{"type":"string"},"ipPoolName":{"type":"string"},"apiKeyRequestHeader":{"type":"string"},"secretKeyRequestHeader":{"type":"string"},"idPath":{"type":"string"},"datePath":{"type":"string"},"apiToken":{"type":"string"},"authenticateByToken":{"type":"boolean"},"authenticationTokenKey":{"type":"string"},"instanceId":{"type":"string"},"alertUid":{"type":"string"},"title":{"type":"string"},"imageUrl":{"type":"string"},"state":{"type":"string"},"externalLink":{"type":"string"},"channelId":{"type":"string"},"phoneNumberIdentification":{"type":"string"}}},"IntegrationResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_environmentId":{"type":"string"},"_organizationId":{"type":"string"},"name":{"type":"string"},"identifier":{"type":"string"},"providerId":{"type":"string"},"channel":{"enum":["in_app","email","sms","chat","push"],"type":"string"},"credentials":{"$ref":"#/components/schemas/CredentialsDto"},"active":{"type":"boolean"},"deleted":{"type":"boolean"},"deletedAt":{"type":"string"},"deletedBy":{"type":"string"},"primary":{"type":"boolean"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/StepFilter"}}},"required":["_environmentId","_organizationId","name","identifier","providerId","channel","credentials","active","deleted","deletedAt","deletedBy","primary"]},"CreateIntegrationRequestDto":{"type":"object","properties":{"name":{"type":"string"},"identifier":{"type":"string"},"_environmentId":{"type":"string"},"providerId":{"type":"string"},"channel":{"enum":["in_app","email","sms","chat","push"],"type":"string"},"credentials":{"$ref":"#/components/schemas/CredentialsDto"},"active":{"type":"boolean","description":"If the integration is active the validation on the credentials field will run"},"check":{"type":"boolean"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/StepFilter"}}},"required":["providerId","channel"]},"UpdateIntegrationRequestDto":{"type":"object","properties":{"name":{"type":"string"},"identifier":{"type":"string"},"_environmentId":{"type":"string"},"active":{"type":"boolean","description":"If the integration is active the validation on the credentials field will run"},"credentials":{"$ref":"#/components/schemas/CredentialsDto"},"check":{"type":"boolean"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/StepFilter"}}}},"ChangeResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_creatorId":{"type":"string"},"_environmentId":{"type":"string"},"_organizationId":{"type":"string"},"_entityId":{"type":"string"},"enabled":{"type":"boolean"},"type":{"enum":["Feed","MessageTemplate","Layout","DefaultLayout","NotificationTemplate","NotificationGroup","TranslationGroup","Translation"],"type":"string"},"change":{"type":"object"},"createdAt":{"type":"string"},"_parentId":{"type":"string"}},"required":["_creatorId","_environmentId","_organizationId","_entityId","enabled","type","change","createdAt"]},"ChangesResponseDto":{"type":"object","properties":{"totalCount":{"type":"number"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ChangeResponseDto"}},"pageSize":{"type":"number"},"page":{"type":"number"}},"required":["totalCount","data","pageSize","page"]},"DataNumberDto":{"type":"object","properties":{"data":{"type":"number"}},"required":["data"]},"BulkApplyChangeDto":{"type":"object","properties":{"changeIds":{"type":"array","items":{"type":"string"}}},"required":["changeIds"]},"PaginatedResponseDto":{"type":"object","properties":{"page":{"type":"number","description":"The current page of the paginated response"},"hasMore":{"type":"boolean","description":"Does the list have more items to fetch"},"pageSize":{"type":"number","description":"Number of items on each page"},"data":{"description":"The list of items matching the query","type":"array","items":{"type":"object"}}},"required":["page","hasMore","pageSize","data"]},"ChannelCredentials":{"type":"object","properties":{"webhookUrl":{"type":"string","description":"Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider."},"channel":{"type":"string","description":"Channel specification for Mattermost chat notifications"},"deviceTokens":{"description":"Contains an array of the subscriber device tokens for a given provider. Used on Push integrations","type":"array","items":{"type":"string"}},"alertUid":{"type":"string","description":"alert_uid for grafana on-call webhook payload"},"title":{"type":"string","description":"title to be used with grafana on call webhook"},"imageUrl":{"type":"string","description":"image_url property fo grafana on call webhook"},"state":{"type":"string","description":"state property fo grafana on call webhook"},"externalUrl":{"type":"string","description":"link_to_upstream_details property fo grafana on call webhook"}},"required":["webhookUrl"]},"ChannelSettings":{"type":"object","properties":{"providerId":{"type":"string","enum":["slack","discord","msteams","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams"],"description":"The provider identifier for the credentials"},"integrationIdentifier":{"type":"string","description":"The integration identifier"},"credentials":{"description":"Credentials payload for the specified provider","allOf":[{"$ref":"#/components/schemas/ChannelCredentials"}]},"_integrationId":{"type":"string","description":"Id of the integration that is used for this channel"}},"required":["providerId","credentials","_integrationId"]},"SubscriberResponseDto":{"type":"object","properties":{"_id":{"type":"string","description":"The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See `subscriberId` for that"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"avatar":{"type":"string"},"locale":{"type":"string"},"subscriberId":{"type":"string","description":"The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems"},"channels":{"description":"Channels settings for subscriber","type":"array","items":{"$ref":"#/components/schemas/ChannelSettings"}},"isOnline":{"type":"boolean"},"lastOnlineAt":{"type":"string"},"_organizationId":{"type":"string"},"_environmentId":{"type":"string"},"deleted":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"__v":{"type":"number"}},"required":["subscriberId","_organizationId","_environmentId","deleted","createdAt","updatedAt"]},"CreateSubscriberRequestDto":{"type":"object","properties":{"subscriberId":{"type":"string","description":"The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"avatar":{"type":"string","description":"An http url to the profile image of your subscriber"},"locale":{"type":"string"},"data":{"type":"object"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberChannelDto"}}},"required":["subscriberId"]},"BulkSubscriberCreateDto":{"type":"object","properties":{"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/CreateSubscriberRequestDto"}}},"required":["subscribers"]},"UpdateSubscriberRequestDto":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"avatar":{"type":"string"},"locale":{"type":"string"},"data":{"type":"object"}}},"UpdateSubscriberChannelRequestDto":{"type":"object","properties":{"providerId":{"type":"string","enum":["slack","discord","msteams","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams"],"description":"The provider identifier for the credentials"},"integrationIdentifier":{"type":"string","description":"The integration identifier"},"credentials":{"description":"Credentials payload for the specified provider","allOf":[{"$ref":"#/components/schemas/ChannelCredentials"}]}},"required":["providerId","credentials"]},"UpdateSubscriberOnlineFlagRequestDto":{"type":"object","properties":{"isOnline":{"type":"boolean"}},"required":["isOnline"]},"DeleteSubscriberResponseDto":{"type":"object","properties":{"acknowledged":{"type":"boolean","description":"A boolean stating the success of the action"},"status":{"type":"string","description":"The status enum for the performed action","enum":["deleted"]}},"required":["acknowledged","status"]},"TemplateResponse":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier of the workflow"},"name":{"type":"string","description":"Name of the workflow"},"critical":{"type":"boolean","description":"Critical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen"},"triggers":{"description":"Triggers are the events that will trigger the workflow.","type":"array","items":{"type":"string"}}},"required":["_id","name","critical","triggers"]},"Preference":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Sets if the workflow is fully enabled for all channels or not for the subscriber."},"channels":{"description":"Subscriber preferences for the different channels regarding this workflow","allOf":[{"$ref":"#/components/schemas/PreferenceChannels"}]}},"required":["enabled","channels"]},"UpdateSubscriberPreferenceResponseDto":{"type":"object","properties":{"template":{"description":"The workflow information and if it is critical or not","allOf":[{"$ref":"#/components/schemas/TemplateResponse"}]},"preference":{"description":"The preferences of the subscriber regarding the related workflow","allOf":[{"$ref":"#/components/schemas/Preference"}]}},"required":["template","preference"]},"GetSubscriberPreferencesResponseDto":{"type":"object","properties":{"template":{"description":"The workflow information and if it is critical or not","allOf":[{"$ref":"#/components/schemas/TemplateResponse"}]},"preference":{"description":"The preferences of the subscriber regarding the related workflow","allOf":[{"$ref":"#/components/schemas/Preference"}]}},"required":["preference"]},"ChannelPreference":{"type":"object","properties":{"type":{"type":"string","enum":["in_app","email","sms","chat","push"],"description":"The type of channel that is enabled or not"},"enabled":{"type":"boolean","description":"If channel is enabled or not"}},"required":["type","enabled"]},"UpdateSubscriberPreferenceRequestDto":{"type":"object","properties":{"channel":{"description":"The subscriber preferences for every ChannelTypeEnum for the workflow assigned.","allOf":[{"$ref":"#/components/schemas/ChannelPreference"}]},"enabled":{"type":"boolean","description":"Sets if the workflow is fully enabled for all channels or not for the subscriber."}}},"UpdateSubscriberGlobalPreferencesRequestDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable or disable the subscriber global preferences."},"preferences":{"description":"The subscriber global preferences for every ChannelTypeEnum.","type":"array","items":{"$ref":"#/components/schemas/ChannelPreference"}}}},"EmailBlockStyles":{"type":"object","properties":{"textAlign":{"enum":["left","right","center"],"type":"string"}}},"EmailBlock":{"type":"object","properties":{"type":{"enum":["text","button"],"type":"string"},"content":{"type":"string"},"url":{"type":"string"},"styles":{"$ref":"#/components/schemas/EmailBlockStyles"}},"required":["type","content"]},"MessageCTAData":{"type":"object","properties":{"url":{"type":"string"}}},"MessageButton":{"type":"object","properties":{"type":{"enum":["primary","secondary","clicked"],"type":"string"},"content":{"type":"string"},"resultContent":{"type":"string"}},"required":["type","content"]},"MessageActionResult":{"type":"object","properties":{"payload":{"type":"object"},"type":{"enum":["primary","secondary","clicked"],"type":"string"}}},"MessageAction":{"type":"object","properties":{"status":{"enum":["pending","done"],"type":"string"},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/MessageButton"}},"result":{"$ref":"#/components/schemas/MessageActionResult"}}},"MessageCTA":{"type":"object","properties":{"type":{"type":"string","enum":["redirect"]},"data":{"$ref":"#/components/schemas/MessageCTAData"},"action":{"$ref":"#/components/schemas/MessageAction"}},"required":["data"]},"Actor":{"type":"object","properties":{"data":{"type":"string","nullable":true},"type":{"enum":["none","user","system_icon","system_custom"],"type":"string"}},"required":["data","type"]},"NotificationDto":{"type":"object","properties":{"_id":{"type":"string"},"_templateId":{"type":"string"},"_environmentId":{"type":"string"},"_messageTemplateId":{"type":"string"},"_organizationId":{"type":"string"},"_notificationId":{"type":"string"},"_subscriberId":{"type":"string"},"_feedId":{"type":"string"},"_jobId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"expireAt":{"type":"string"},"actor":{"$ref":"#/components/schemas/Actor"},"subscriber":{"$ref":"#/components/schemas/SubscriberResponseDto"},"transactionId":{"type":"string"},"templateIdentifier":{"type":"string"},"providerId":{"type":"string"},"content":{"type":"string"},"subject":{"type":"string"},"channel":{"enum":["in_app","email","sms","chat","push"],"type":"string"},"read":{"type":"boolean"},"seen":{"type":"boolean"},"deleted":{"type":"boolean"},"deviceTokens":{"type":"array","items":{"type":"string"}},"cta":{"$ref":"#/components/schemas/MessageCTA"},"status":{"type":"string","enum":["sent","error","warning"]},"payload":{"type":"object","description":"The payload that was used to send the notification trigger"},"overrides":{"type":"object","description":"Provider specific overrides used when triggering the notification"}},"required":["_templateId","_environmentId","_messageTemplateId","_organizationId","_notificationId","_subscriberId","_feedId","_jobId","transactionId","content","channel","read","seen","deleted","cta","status","payload","overrides"]},"FeedResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"identifier":{"type":"string"},"_environmentId":{"type":"string"},"_organizationId":{"type":"string"}},"required":["name","identifier","_environmentId","_organizationId"]},"UnseenCountResponse":{"type":"object","properties":{"count":{"type":"number"}},"required":["count"]},"MessageMarkAsRequestDto":{"type":"object","properties":{"messageId":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"markAs":{"enum":["read","seen","unread","unseen"],"type":"string"}},"required":["messageId","markAs"]},"MessageEntity":{"type":"object","properties":{}},"MarkAllMessageAsRequestDto":{"type":"object","properties":{"feedIdentifier":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Optional feed identifier or array of feed identifiers"},"markAs":{"enum":["read","seen","unread","unseen"],"type":"string","description":"Mark all subscriber messages as read, unread, seen or unseen"}},"required":["markAs"]},"MessageResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_templateId":{"type":"string"},"_environmentId":{"type":"string"},"_messageTemplateId":{"type":"string"},"_organizationId":{"type":"string"},"_notificationId":{"type":"string"},"_subscriberId":{"type":"string"},"subscriber":{"$ref":"#/components/schemas/SubscriberResponseDto"},"template":{"$ref":"#/components/schemas/WorkflowResponse"},"templateIdentifier":{"type":"string"},"createdAt":{"type":"string"},"lastSeenDate":{"type":"string"},"lastReadDate":{"type":"string"},"content":{"oneOf":[{"$ref":"#/components/schemas/EmailBlock"},{"type":"string"}]},"transactionId":{"type":"string"},"subject":{"type":"string"},"channel":{"enum":["in_app","email","sms","chat","push"],"type":"string"},"read":{"type":"boolean"},"seen":{"type":"boolean"},"email":{"type":"string"},"phone":{"type":"string"},"directWebhookUrl":{"type":"string"},"providerId":{"type":"string"},"deviceTokens":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"cta":{"$ref":"#/components/schemas/MessageCTA"},"_feedId":{"type":"string","nullable":true},"status":{"type":"string","enum":["sent","error","warning"]},"errorId":{"type":"string"},"errorText":{"type":"string"},"payload":{"type":"object","description":"The payload that was used to send the notification trigger"},"overrides":{"type":"object","description":"Provider specific overrides used when triggering the notification"}},"required":["_templateId","_environmentId","_messageTemplateId","_organizationId","_notificationId","_subscriberId","createdAt","content","transactionId","channel","read","seen","cta","status","errorId","errorText","payload","overrides"]},"MarkMessageActionAsSeenDto":{"type":"object","properties":{"status":{"enum":["pending","done"],"type":"string","description":"Message action status"},"payload":{"type":"object","description":"Message action payload"}},"required":["status"]},"CreateFeedRequestDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"CreateLayoutResponseDto":{"type":"object","properties":{"_id":{"type":"string"}},"required":["_id"]},"GetLayoutResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_organizationId":{"type":"string"},"_environmentId":{"type":"string"},"_creatorId":{"type":"string"},"name":{"type":"string"},"identifier":{"type":"string"},"description":{"type":"string"},"channel":{"enum":["in_app","email","sms","chat","push"],"type":"string"},"content":{"type":"string"},"contentType":{"type":"string"},"variables":{"type":"array","items":{"type":"object"}},"isDefault":{"type":"boolean"},"isDeleted":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"_parentId":{"type":"string"}},"required":["_organizationId","_environmentId","_creatorId","name","identifier","channel","content","contentType","isDefault","isDeleted"]},"UpdateLayoutResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_organizationId":{"type":"string"},"_environmentId":{"type":"string"},"_creatorId":{"type":"string"},"name":{"type":"string"},"identifier":{"type":"string"},"description":{"type":"string"},"channel":{"enum":["in_app","email","sms","chat","push"],"type":"string"},"content":{"type":"string"},"contentType":{"type":"string"},"variables":{"type":"array","items":{"type":"object"}},"isDefault":{"type":"boolean"},"isDeleted":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"_parentId":{"type":"string"}},"required":["_organizationId","_environmentId","_creatorId","name","identifier","channel","content","contentType","isDefault","isDeleted"]},"UpdateLayoutRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"User defined custom name and provided by the user that will name the Layout updated."},"identifier":{"type":"string","description":"User defined custom key that will be a unique identifier for the Layout updated."},"description":{"type":"string","description":"User defined description of the layout"},"content":{"type":"string","description":"User defined content for the layout."},"variables":{"description":"User defined variables to render in the layout placeholders.","type":"array","items":{"type":"object"}},"isDefault":{"type":"boolean","description":"Variable that defines if the layout is chosen as default when creating a layout."}},"required":["identifier"]},"DeleteMessageResponseDto":{"type":"object","properties":{"acknowledged":{"type":"boolean","description":"A boolean stating the success of the action"},"status":{"type":"string","description":"The status enum for the performed action","enum":["deleted"]}},"required":["acknowledged","status"]},"CreateTopicResponseDto":{"type":"object","properties":{}},"CreateTopicRequestDto":{"type":"object","properties":{"key":{"type":"string","description":"User defined custom key and provided by the user that will be an unique identifier for the Topic created."},"name":{"type":"string","description":"User defined custom name and provided by the user that will name the Topic created."}},"required":["key","name"]},"AddSubscribersRequestDto":{"type":"object","properties":{"subscribers":{"description":"List of subscriber identifiers that will be associated to the topic","type":"array","items":{"type":"string"}}},"required":["subscribers"]},"TopicSubscriberDto":{"type":"object","properties":{"_organizationId":{"type":"string"},"_environmentId":{"type":"string"},"_subscriberId":{"type":"string"},"_topicId":{"type":"string"},"topicKey":{"type":"string"},"externalSubscriberId":{"type":"string"}},"required":["_organizationId","_environmentId","_subscriberId","_topicId","topicKey","externalSubscriberId"]},"RemoveSubscribersRequestDto":{"type":"object","properties":{"subscribers":{"description":"List of subscriber identifiers that will be removed to the topic","type":"array","items":{"type":"string"}}},"required":["subscribers"]},"TopicDto":{"type":"object","properties":{"_id":{"type":"string"},"_organizationId":{"type":"string"},"_environmentId":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"subscribers":{"type":"array","items":{"type":"string"}}},"required":["_organizationId","_environmentId","key","name","subscribers"]},"FilterTopicsResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TopicDto"}},"page":{"type":"number"},"pageSize":{"type":"number"},"totalCount":{"type":"number"}},"required":["data","page","pageSize","totalCount"]},"GetTopicResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_organizationId":{"type":"string"},"_environmentId":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"subscribers":{"type":"array","items":{"type":"string"}}},"required":["_organizationId","_environmentId","key","name","subscribers"]},"RenameTopicResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"_organizationId":{"type":"string"},"_environmentId":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"subscribers":{"type":"array","items":{"type":"string"}}},"required":["_organizationId","_environmentId","key","name","subscribers"]},"RenameTopicRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"User defined custom name and provided by the user to rename the topic."}},"required":["name"]},"GetTenantResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"identifier":{"type":"string"},"name":{"type":"string"},"data":{"type":"object"},"_environmentId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["_id","identifier","_environmentId","createdAt","updatedAt"]},"CreateTenantResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"identifier":{"type":"string"},"name":{"type":"string"},"data":{"type":"object"},"_environmentId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["_id","identifier","_environmentId","createdAt","updatedAt"]},"CreateTenantRequestDto":{"type":"object","properties":{"identifier":{"type":"string"},"name":{"type":"string"},"data":{"type":"object"}},"required":["identifier","name"]},"UpdateTenantResponseDto":{"type":"object","properties":{"_id":{"type":"string"},"identifier":{"type":"string"},"name":{"type":"string"},"data":{"type":"object"},"_environmentId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["_id","identifier","_environmentId","createdAt","updatedAt"]},"UpdateTenantRequestDto":{"type":"object","properties":{"identifier":{"type":"string"},"name":{"type":"string"},"data":{"type":"object"}}}},"headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Retry-After":{"required":false,"description":"The number of seconds after which the client may retry the request that was previously rejected.","schema":{"type":"string"},"example":"8"},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"},"Link":{"required":false,"description":"A link to the documentation.","schema":{"type":"string"},"example":"https://docs.novu.co/"}}},"externalDocs":{"description":"Novu Documentation","url":"https://docs.novu.co"},"x-speakeasy-name-override":[{"operationId":"^.*get.*","methodNameOverride":"retrieve"},{"operationId":"^.*retrieve.*","methodNameOverride":"retrieve"},{"operationId":"^.*create.*","methodNameOverride":"create"},{"operationId":"^.*update.*","methodNameOverride":"update"},{"operationId":"^.*list.*","methodNameOverride":"list"},{"operationId":"^.*delete.*","methodNameOverride":"delete"},{"operationId":"^.*remove.*","methodNameOverride":"delete"}],"x-speakeasy-retries":{"strategy":"backoff","backoff":{"initialInterval":500,"maxInterval":30000,"maxElapsedTime":3600000,"exponent":1.5},"statusCodes":["408","409","429","5XX"],"retryConnectionErrors":true}} \ No newline at end of file diff --git a/sources/remove-headers-overlay.yaml b/sources/remove-headers-overlay.yaml new file mode 100644 index 00000000..b42a0af6 --- /dev/null +++ b/sources/remove-headers-overlay.yaml @@ -0,0 +1,7 @@ +overlay: 1.0.0 +info: + title: Remove headers from all responses + version: 0.0.0 +actions: + - target: $.paths.*.*.responses.*.headers + remove: true \ No newline at end of file diff --git a/src/lib/config.ts b/src/lib/config.ts index a8cfa37d..dc58f0eb 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -49,7 +49,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "1.0", - sdkVersion: "0.0.1-alpha.1", - genVersion: "2.342.2", - userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.1 2.342.2 1.0 novu-sdk", + sdkVersion: "0.0.1-alpha.2", + genVersion: "2.342.6", + userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.2 2.342.6 1.0 novu-sdk", } as const; diff --git a/src/models/components/activitiesresponsedto.ts b/src/models/components/activitiesresponsedto.ts index 23d5d93a..b290fb4c 100644 --- a/src/models/components/activitiesresponsedto.ts +++ b/src/models/components/activitiesresponsedto.ts @@ -9,33 +9,33 @@ import { import * as z from "zod"; export type ActivitiesResponseDto = { - hasMore: boolean; data: Array; - pageSize: number; + hasMore: boolean; page: number; + pageSize: number; }; /** @internal */ export namespace ActivitiesResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - hasMore: z.boolean(), data: z.array(ActivityNotificationResponseDto$.inboundSchema), - pageSize: z.number(), + hasMore: z.boolean(), page: z.number(), + pageSize: z.number(), }); export type Outbound = { - hasMore: boolean; data: Array; - pageSize: number; + hasMore: boolean; page: number; + pageSize: number; }; export const outboundSchema: z.ZodType = z.object({ - hasMore: z.boolean(), data: z.array(ActivityNotificationResponseDto$.outboundSchema), - pageSize: z.number(), + hasMore: z.boolean(), page: z.number(), + pageSize: z.number(), }); } diff --git a/src/models/components/activitygraphstatesresponse.ts b/src/models/components/activitygraphstatesresponse.ts index a01303db..08ff7d5a 100644 --- a/src/models/components/activitygraphstatesresponse.ts +++ b/src/models/components/activitygraphstatesresponse.ts @@ -6,27 +6,25 @@ import { remap as remap$ } from "../../lib/primitives"; import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const ActivityGraphStatesResponseChannels = { +export const Channels = { InApp: "in_app", Email: "email", Sms: "sms", Chat: "chat", Push: "push", } as const; -export type ActivityGraphStatesResponseChannels = ClosedEnum< - typeof ActivityGraphStatesResponseChannels ->; +export type Channels = ClosedEnum; export type ActivityGraphStatesResponse = { id: string; + channels: Array; count: number; templates: Array; - channels: Array; }; /** @internal */ -export namespace ActivityGraphStatesResponseChannels$ { - export const inboundSchema = z.nativeEnum(ActivityGraphStatesResponseChannels); +export namespace Channels$ { + export const inboundSchema = z.nativeEnum(Channels); export const outboundSchema = inboundSchema; } @@ -35,9 +33,9 @@ export namespace ActivityGraphStatesResponse$ { export const inboundSchema: z.ZodType = z .object({ _id: z.string(), + channels: z.array(Channels$.inboundSchema), count: z.number(), templates: z.array(z.string()), - channels: z.array(ActivityGraphStatesResponseChannels$.inboundSchema), }) .transform((v) => { return remap$(v, { @@ -47,17 +45,17 @@ export namespace ActivityGraphStatesResponse$ { export type Outbound = { _id: string; + channels: Array; count: number; templates: Array; - channels: Array; }; export const outboundSchema: z.ZodType = z .object({ id: z.string(), + channels: z.array(Channels$.outboundSchema), count: z.number(), templates: z.array(z.string()), - channels: z.array(ActivityGraphStatesResponseChannels$.outboundSchema), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/activitynotificationexecutiondetailresponsedto.ts b/src/models/components/activitynotificationexecutiondetailresponsedto.ts index e6a429aa..aff8754c 100644 --- a/src/models/components/activitynotificationexecutiondetailresponsedto.ts +++ b/src/models/components/activitynotificationexecutiondetailresponsedto.ts @@ -6,7 +6,17 @@ import { remap as remap$ } from "../../lib/primitives"; import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const ActivityNotificationExecutionDetailResponseDtoStatus = { +export type ProviderId = {}; + +export const Source = { + Credentials: "Credentials", + Internal: "Internal", + Payload: "Payload", + Webhook: "Webhook", +} as const; +export type Source = ClosedEnum; + +export const Status = { Success: "Success", Warning: "Warning", Failed: "Failed", @@ -14,60 +24,38 @@ export const ActivityNotificationExecutionDetailResponseDtoStatus = { Queued: "Queued", ReadConfirmation: "ReadConfirmation", } as const; -export type ActivityNotificationExecutionDetailResponseDtoStatus = ClosedEnum< - typeof ActivityNotificationExecutionDetailResponseDtoStatus ->; - -export type ActivityNotificationExecutionDetailResponseDtoProviderId = {}; - -export const ActivityNotificationExecutionDetailResponseDtoSource = { - Credentials: "Credentials", - Internal: "Internal", - Payload: "Payload", - Webhook: "Webhook", -} as const; -export type ActivityNotificationExecutionDetailResponseDtoSource = ClosedEnum< - typeof ActivityNotificationExecutionDetailResponseDtoSource ->; +export type Status = ClosedEnum; export type ActivityNotificationExecutionDetailResponseDto = { id: string; jobId: string; - status: ActivityNotificationExecutionDetailResponseDtoStatus; detail: string; isRetry: boolean; isTest: boolean; - providerId: ActivityNotificationExecutionDetailResponseDtoProviderId; + providerId: ProviderId; raw?: string | undefined; - source: ActivityNotificationExecutionDetailResponseDtoSource; + source: Source; + status: Status; }; /** @internal */ -export namespace ActivityNotificationExecutionDetailResponseDtoStatus$ { - export const inboundSchema = z.nativeEnum(ActivityNotificationExecutionDetailResponseDtoStatus); - export const outboundSchema = inboundSchema; -} - -/** @internal */ -export namespace ActivityNotificationExecutionDetailResponseDtoProviderId$ { - export const inboundSchema: z.ZodType< - ActivityNotificationExecutionDetailResponseDtoProviderId, - z.ZodTypeDef, - unknown - > = z.object({}); +export namespace ProviderId$ { + export const inboundSchema: z.ZodType = z.object({}); export type Outbound = {}; - export const outboundSchema: z.ZodType< - Outbound, - z.ZodTypeDef, - ActivityNotificationExecutionDetailResponseDtoProviderId - > = z.object({}); + export const outboundSchema: z.ZodType = z.object({}); } /** @internal */ -export namespace ActivityNotificationExecutionDetailResponseDtoSource$ { - export const inboundSchema = z.nativeEnum(ActivityNotificationExecutionDetailResponseDtoSource); +export namespace Source$ { + export const inboundSchema = z.nativeEnum(Source); + export const outboundSchema = inboundSchema; +} + +/** @internal */ +export namespace Status$ { + export const inboundSchema = z.nativeEnum(Status); export const outboundSchema = inboundSchema; } @@ -81,15 +69,13 @@ export namespace ActivityNotificationExecutionDetailResponseDto$ { .object({ _id: z.string(), _jobId: z.string(), - status: ActivityNotificationExecutionDetailResponseDtoStatus$.inboundSchema, detail: z.string(), isRetry: z.boolean(), isTest: z.boolean(), - providerId: z.lazy( - () => ActivityNotificationExecutionDetailResponseDtoProviderId$.inboundSchema - ), + providerId: z.lazy(() => ProviderId$.inboundSchema), raw: z.string().optional(), - source: ActivityNotificationExecutionDetailResponseDtoSource$.inboundSchema, + source: Source$.inboundSchema, + status: Status$.inboundSchema, }) .transform((v) => { return remap$(v, { @@ -101,13 +87,13 @@ export namespace ActivityNotificationExecutionDetailResponseDto$ { export type Outbound = { _id: string; _jobId: string; - status: string; detail: string; isRetry: boolean; isTest: boolean; - providerId: ActivityNotificationExecutionDetailResponseDtoProviderId$.Outbound; + providerId: ProviderId$.Outbound; raw?: string | undefined; source: string; + status: string; }; export const outboundSchema: z.ZodType< @@ -118,15 +104,13 @@ export namespace ActivityNotificationExecutionDetailResponseDto$ { .object({ id: z.string(), jobId: z.string(), - status: ActivityNotificationExecutionDetailResponseDtoStatus$.outboundSchema, detail: z.string(), isRetry: z.boolean(), isTest: z.boolean(), - providerId: z.lazy( - () => ActivityNotificationExecutionDetailResponseDtoProviderId$.outboundSchema - ), + providerId: z.lazy(() => ProviderId$.outboundSchema), raw: z.string().optional(), - source: ActivityNotificationExecutionDetailResponseDtoSource$.outboundSchema, + source: Source$.outboundSchema, + status: Status$.outboundSchema, }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/activitynotificationjobresponsedto.ts b/src/models/components/activitynotificationjobresponsedto.ts index 9f257ca4..9189f86d 100644 --- a/src/models/components/activitynotificationjobresponsedto.ts +++ b/src/models/components/activitynotificationjobresponsedto.ts @@ -15,19 +15,19 @@ import * as z from "zod"; export type Digest = {}; -export type ActivityNotificationJobResponseDtoPayload = {}; +export type Payload = {}; export type ActivityNotificationJobResponseDtoProviderId = {}; export type ActivityNotificationJobResponseDto = { id: string; - type: string; digest?: Digest | undefined; executionDetails: Array; - step: ActivityNotificationStepResponseDto; - payload?: ActivityNotificationJobResponseDtoPayload | undefined; + payload?: Payload | undefined; providerId: ActivityNotificationJobResponseDtoProviderId; status: string; + step: ActivityNotificationStepResponseDto; + type: string; }; /** @internal */ @@ -40,20 +40,12 @@ export namespace Digest$ { } /** @internal */ -export namespace ActivityNotificationJobResponseDtoPayload$ { - export const inboundSchema: z.ZodType< - ActivityNotificationJobResponseDtoPayload, - z.ZodTypeDef, - unknown - > = z.object({}); +export namespace Payload$ { + export const inboundSchema: z.ZodType = z.object({}); export type Outbound = {}; - export const outboundSchema: z.ZodType< - Outbound, - z.ZodTypeDef, - ActivityNotificationJobResponseDtoPayload - > = z.object({}); + export const outboundSchema: z.ZodType = z.object({}); } /** @internal */ @@ -82,17 +74,15 @@ export namespace ActivityNotificationJobResponseDto$ { > = z .object({ _id: z.string(), - type: z.string(), digest: z.lazy(() => Digest$.inboundSchema).optional(), executionDetails: z.array( ActivityNotificationExecutionDetailResponseDto$.inboundSchema ), - step: ActivityNotificationStepResponseDto$.inboundSchema, - payload: z - .lazy(() => ActivityNotificationJobResponseDtoPayload$.inboundSchema) - .optional(), + payload: z.lazy(() => Payload$.inboundSchema).optional(), providerId: z.lazy(() => ActivityNotificationJobResponseDtoProviderId$.inboundSchema), status: z.string(), + step: ActivityNotificationStepResponseDto$.inboundSchema, + type: z.string(), }) .transform((v) => { return remap$(v, { @@ -102,13 +92,13 @@ export namespace ActivityNotificationJobResponseDto$ { export type Outbound = { _id: string; - type: string; digest?: Digest$.Outbound | undefined; executionDetails: Array; - step: ActivityNotificationStepResponseDto$.Outbound; - payload?: ActivityNotificationJobResponseDtoPayload$.Outbound | undefined; + payload?: Payload$.Outbound | undefined; providerId: ActivityNotificationJobResponseDtoProviderId$.Outbound; status: string; + step: ActivityNotificationStepResponseDto$.Outbound; + type: string; }; export const outboundSchema: z.ZodType< @@ -118,17 +108,15 @@ export namespace ActivityNotificationJobResponseDto$ { > = z .object({ id: z.string(), - type: z.string(), digest: z.lazy(() => Digest$.outboundSchema).optional(), executionDetails: z.array( ActivityNotificationExecutionDetailResponseDto$.outboundSchema ), - step: ActivityNotificationStepResponseDto$.outboundSchema, - payload: z - .lazy(() => ActivityNotificationJobResponseDtoPayload$.outboundSchema) - .optional(), + payload: z.lazy(() => Payload$.outboundSchema).optional(), providerId: z.lazy(() => ActivityNotificationJobResponseDtoProviderId$.outboundSchema), status: z.string(), + step: ActivityNotificationStepResponseDto$.outboundSchema, + type: z.string(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/activitynotificationresponsedto.ts b/src/models/components/activitynotificationresponsedto.ts index 4dfb3d1f..79f8b4e4 100644 --- a/src/models/components/activitynotificationresponsedto.ts +++ b/src/models/components/activitynotificationresponsedto.ts @@ -18,7 +18,7 @@ import { } from "./activitynotificationtemplateresponsedto"; import * as z from "zod"; -export const Channels = { +export const ActivityNotificationResponseDtoChannels = { InApp: "in_app", Email: "email", Sms: "sms", @@ -29,23 +29,25 @@ export const Channels = { Delay: "delay", Custom: "custom", } as const; -export type Channels = ClosedEnum; +export type ActivityNotificationResponseDtoChannels = ClosedEnum< + typeof ActivityNotificationResponseDtoChannels +>; export type ActivityNotificationResponseDto = { - id?: string | undefined; environmentId: string; + id?: string | undefined; organizationId: string; - transactionId: string; + channels?: ActivityNotificationResponseDtoChannels | undefined; createdAt?: string | undefined; - channels?: Channels | undefined; + jobs?: Array | undefined; subscriber?: ActivityNotificationSubscriberResponseDto | undefined; template?: ActivityNotificationTemplateResponseDto | undefined; - jobs?: Array | undefined; + transactionId: string; }; /** @internal */ -export namespace Channels$ { - export const inboundSchema = z.nativeEnum(Channels); +export namespace ActivityNotificationResponseDtoChannels$ { + export const inboundSchema = z.nativeEnum(ActivityNotificationResponseDtoChannels); export const outboundSchema = inboundSchema; } @@ -54,34 +56,34 @@ export namespace ActivityNotificationResponseDto$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), _environmentId: z.string(), + _id: z.string().optional(), _organizationId: z.string(), - transactionId: z.string(), + channels: ActivityNotificationResponseDtoChannels$.inboundSchema.optional(), createdAt: z.string().optional(), - channels: Channels$.inboundSchema.optional(), + jobs: z.array(ActivityNotificationJobResponseDto$.inboundSchema).optional(), subscriber: ActivityNotificationSubscriberResponseDto$.inboundSchema.optional(), template: ActivityNotificationTemplateResponseDto$.inboundSchema.optional(), - jobs: z.array(ActivityNotificationJobResponseDto$.inboundSchema).optional(), + transactionId: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", _organizationId: "organizationId", }); }); export type Outbound = { - _id?: string | undefined; _environmentId: string; + _id?: string | undefined; _organizationId: string; - transactionId: string; - createdAt?: string | undefined; channels?: string | undefined; + createdAt?: string | undefined; + jobs?: Array | undefined; subscriber?: ActivityNotificationSubscriberResponseDto$.Outbound | undefined; template?: ActivityNotificationTemplateResponseDto$.Outbound | undefined; - jobs?: Array | undefined; + transactionId: string; }; export const outboundSchema: z.ZodType< @@ -90,20 +92,20 @@ export namespace ActivityNotificationResponseDto$ { ActivityNotificationResponseDto > = z .object({ - id: z.string().optional(), environmentId: z.string(), + id: z.string().optional(), organizationId: z.string(), - transactionId: z.string(), + channels: ActivityNotificationResponseDtoChannels$.outboundSchema.optional(), createdAt: z.string().optional(), - channels: Channels$.outboundSchema.optional(), + jobs: z.array(ActivityNotificationJobResponseDto$.outboundSchema).optional(), subscriber: ActivityNotificationSubscriberResponseDto$.outboundSchema.optional(), template: ActivityNotificationTemplateResponseDto$.outboundSchema.optional(), - jobs: z.array(ActivityNotificationJobResponseDto$.outboundSchema).optional(), + transactionId: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", organizationId: "_organizationId", }); }); diff --git a/src/models/components/activitynotificationsubscriberresponsedto.ts b/src/models/components/activitynotificationsubscriberresponsedto.ts index 32e6e6cb..d02667e6 100644 --- a/src/models/components/activitynotificationsubscriberresponsedto.ts +++ b/src/models/components/activitynotificationsubscriberresponsedto.ts @@ -6,10 +6,10 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type ActivityNotificationSubscriberResponseDto = { - firstName?: string | undefined; id: string; - lastName?: string | undefined; email?: string | undefined; + firstName?: string | undefined; + lastName?: string | undefined; phone?: string | undefined; }; @@ -21,10 +21,10 @@ export namespace ActivityNotificationSubscriberResponseDto$ { unknown > = z .object({ - firstName: z.string().optional(), _id: z.string(), - lastName: z.string().optional(), email: z.string().optional(), + firstName: z.string().optional(), + lastName: z.string().optional(), phone: z.string().optional(), }) .transform((v) => { @@ -34,10 +34,10 @@ export namespace ActivityNotificationSubscriberResponseDto$ { }); export type Outbound = { - firstName?: string | undefined; _id: string; - lastName?: string | undefined; email?: string | undefined; + firstName?: string | undefined; + lastName?: string | undefined; phone?: string | undefined; }; @@ -47,10 +47,10 @@ export namespace ActivityNotificationSubscriberResponseDto$ { ActivityNotificationSubscriberResponseDto > = z .object({ - firstName: z.string().optional(), id: z.string(), - lastName: z.string().optional(), email: z.string().optional(), + firstName: z.string().optional(), + lastName: z.string().optional(), phone: z.string().optional(), }) .transform((v) => { diff --git a/src/models/components/activitystatsresponsedto.ts b/src/models/components/activitystatsresponsedto.ts index 169d1ed6..6da75252 100644 --- a/src/models/components/activitystatsresponsedto.ts +++ b/src/models/components/activitystatsresponsedto.ts @@ -5,26 +5,26 @@ import * as z from "zod"; export type ActivityStatsResponseDto = { - weeklySent: number; monthlySent: number; + weeklySent: number; }; /** @internal */ export namespace ActivityStatsResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - weeklySent: z.number(), monthlySent: z.number(), + weeklySent: z.number(), }); export type Outbound = { - weeklySent: number; monthlySent: number; + weeklySent: number; }; export const outboundSchema: z.ZodType = z.object({ - weeklySent: z.number(), monthlySent: z.number(), + weeklySent: z.number(), }); } diff --git a/src/models/components/apikey.ts b/src/models/components/apikey.ts index 86d0c92c..b65897f6 100644 --- a/src/models/components/apikey.ts +++ b/src/models/components/apikey.ts @@ -6,16 +6,16 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type ApiKey = { - key: string; userId: string; + key: string; }; /** @internal */ export namespace ApiKey$ { export const inboundSchema: z.ZodType = z .object({ - key: z.string(), _userId: z.string(), + key: z.string(), }) .transform((v) => { return remap$(v, { @@ -24,14 +24,14 @@ export namespace ApiKey$ { }); export type Outbound = { - key: string; _userId: string; + key: string; }; export const outboundSchema: z.ZodType = z .object({ - key: z.string(), userId: z.string(), + key: z.string(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/changeresponsedto.ts b/src/models/components/changeresponsedto.ts index bbf7d283..f6d379d9 100644 --- a/src/models/components/changeresponsedto.ts +++ b/src/models/components/changeresponsedto.ts @@ -6,7 +6,9 @@ import { remap as remap$ } from "../../lib/primitives"; import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const ChangeResponseDtoType = { +export type Change = {}; + +export const Type = { Feed: "Feed", MessageTemplate: "MessageTemplate", Layout: "Layout", @@ -16,29 +18,21 @@ export const ChangeResponseDtoType = { TranslationGroup: "TranslationGroup", Translation: "Translation", } as const; -export type ChangeResponseDtoType = ClosedEnum; - -export type Change = {}; +export type Type = ClosedEnum; export type ChangeResponseDto = { - id?: string | undefined; creatorId: string; + entityId: string; environmentId: string; + id?: string | undefined; organizationId: string; - entityId: string; - enabled: boolean; - type: ChangeResponseDtoType; + parentId?: string | undefined; change: Change; createdAt: string; - parentId?: string | undefined; + enabled: boolean; + type: Type; }; -/** @internal */ -export namespace ChangeResponseDtoType$ { - export const inboundSchema = z.nativeEnum(ChangeResponseDtoType); - export const outboundSchema = inboundSchema; -} - /** @internal */ export namespace Change$ { export const inboundSchema: z.ZodType = z.object({}); @@ -48,65 +42,71 @@ export namespace Change$ { export const outboundSchema: z.ZodType = z.object({}); } +/** @internal */ +export namespace Type$ { + export const inboundSchema = z.nativeEnum(Type); + export const outboundSchema = inboundSchema; +} + /** @internal */ export namespace ChangeResponseDto$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), _creatorId: z.string(), + _entityId: z.string(), _environmentId: z.string(), + _id: z.string().optional(), _organizationId: z.string(), - _entityId: z.string(), - enabled: z.boolean(), - type: ChangeResponseDtoType$.inboundSchema, + _parentId: z.string().optional(), change: z.lazy(() => Change$.inboundSchema), createdAt: z.string(), - _parentId: z.string().optional(), + enabled: z.boolean(), + type: Type$.inboundSchema, }) .transform((v) => { return remap$(v, { - _id: "id", _creatorId: "creatorId", + _entityId: "entityId", _environmentId: "environmentId", + _id: "id", _organizationId: "organizationId", - _entityId: "entityId", _parentId: "parentId", }); }); export type Outbound = { - _id?: string | undefined; _creatorId: string; + _entityId: string; _environmentId: string; + _id?: string | undefined; _organizationId: string; - _entityId: string; - enabled: boolean; - type: string; + _parentId?: string | undefined; change: Change$.Outbound; createdAt: string; - _parentId?: string | undefined; + enabled: boolean; + type: string; }; export const outboundSchema: z.ZodType = z .object({ - id: z.string().optional(), creatorId: z.string(), + entityId: z.string(), environmentId: z.string(), + id: z.string().optional(), organizationId: z.string(), - entityId: z.string(), - enabled: z.boolean(), - type: ChangeResponseDtoType$.outboundSchema, + parentId: z.string().optional(), change: z.lazy(() => Change$.outboundSchema), createdAt: z.string(), - parentId: z.string().optional(), + enabled: z.boolean(), + type: Type$.outboundSchema, }) .transform((v) => { return remap$(v, { - id: "_id", creatorId: "_creatorId", + entityId: "_entityId", environmentId: "_environmentId", + id: "_id", organizationId: "_organizationId", - entityId: "_entityId", parentId: "_parentId", }); }); diff --git a/src/models/components/changesresponsedto.ts b/src/models/components/changesresponsedto.ts index 2b469ddd..8bf58575 100644 --- a/src/models/components/changesresponsedto.ts +++ b/src/models/components/changesresponsedto.ts @@ -6,32 +6,32 @@ import { ChangeResponseDto, ChangeResponseDto$ } from "./changeresponsedto"; import * as z from "zod"; export type ChangesResponseDto = { - totalCount: number; data: Array; - pageSize: number; page: number; + pageSize: number; + totalCount: number; }; /** @internal */ export namespace ChangesResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - totalCount: z.number(), data: z.array(ChangeResponseDto$.inboundSchema), - pageSize: z.number(), page: z.number(), + pageSize: z.number(), + totalCount: z.number(), }); export type Outbound = { - totalCount: number; data: Array; - pageSize: number; page: number; + pageSize: number; + totalCount: number; }; export const outboundSchema: z.ZodType = z.object({ - totalCount: z.number(), data: z.array(ChangeResponseDto$.outboundSchema), - pageSize: z.number(), page: z.number(), + pageSize: z.number(), + totalCount: z.number(), }); } diff --git a/src/models/components/channelcredentials.ts b/src/models/components/channelcredentials.ts index f063e306..468f5e73 100644 --- a/src/models/components/channelcredentials.ts +++ b/src/models/components/channelcredentials.ts @@ -6,9 +6,9 @@ import * as z from "zod"; export type ChannelCredentials = { /** - * Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider. + * alert_uid for grafana on-call webhook payload */ - webhookUrl: string; + alertUid?: string | undefined; /** * Channel specification for Mattermost chat notifications */ @@ -18,13 +18,9 @@ export type ChannelCredentials = { */ deviceTokens?: Array | undefined; /** - * alert_uid for grafana on-call webhook payload - */ - alertUid?: string | undefined; - /** - * title to be used with grafana on call webhook + * link_to_upstream_details property fo grafana on call webhook */ - title?: string | undefined; + externalUrl?: string | undefined; /** * image_url property fo grafana on call webhook */ @@ -34,43 +30,47 @@ export type ChannelCredentials = { */ state?: string | undefined; /** - * link_to_upstream_details property fo grafana on call webhook + * title to be used with grafana on call webhook */ - externalUrl?: string | undefined; + title?: string | undefined; + /** + * Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider. + */ + webhookUrl: string; }; /** @internal */ export namespace ChannelCredentials$ { export const inboundSchema: z.ZodType = z.object({ - webhookUrl: z.string(), + alertUid: z.string().optional(), channel: z.string().optional(), deviceTokens: z.array(z.string()).optional(), - alertUid: z.string().optional(), - title: z.string().optional(), + externalUrl: z.string().optional(), imageUrl: z.string().optional(), state: z.string().optional(), - externalUrl: z.string().optional(), + title: z.string().optional(), + webhookUrl: z.string(), }); export type Outbound = { - webhookUrl: string; + alertUid?: string | undefined; channel?: string | undefined; deviceTokens?: Array | undefined; - alertUid?: string | undefined; - title?: string | undefined; + externalUrl?: string | undefined; imageUrl?: string | undefined; state?: string | undefined; - externalUrl?: string | undefined; + title?: string | undefined; + webhookUrl: string; }; export const outboundSchema: z.ZodType = z.object({ - webhookUrl: z.string(), + alertUid: z.string().optional(), channel: z.string().optional(), deviceTokens: z.array(z.string()).optional(), - alertUid: z.string().optional(), - title: z.string().optional(), + externalUrl: z.string().optional(), imageUrl: z.string().optional(), state: z.string().optional(), - externalUrl: z.string().optional(), + title: z.string().optional(), + webhookUrl: z.string(), }); } diff --git a/src/models/components/channelcredentialsdto.ts b/src/models/components/channelcredentialsdto.ts index e46d4a3c..c3ca7102 100644 --- a/src/models/components/channelcredentialsdto.ts +++ b/src/models/components/channelcredentialsdto.ts @@ -5,25 +5,25 @@ import * as z from "zod"; export type ChannelCredentialsDto = { - webhookUrl?: string | undefined; deviceTokens?: Array | undefined; + webhookUrl?: string | undefined; }; /** @internal */ export namespace ChannelCredentialsDto$ { export const inboundSchema: z.ZodType = z.object({ - webhookUrl: z.string().optional(), deviceTokens: z.array(z.string()).optional(), + webhookUrl: z.string().optional(), }); export type Outbound = { - webhookUrl?: string | undefined; deviceTokens?: Array | undefined; + webhookUrl?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ - webhookUrl: z.string().optional(), deviceTokens: z.array(z.string()).optional(), + webhookUrl: z.string().optional(), }); } diff --git a/src/models/components/channelpreference.ts b/src/models/components/channelpreference.ts index b5c60597..5f2dd23a 100644 --- a/src/models/components/channelpreference.ts +++ b/src/models/components/channelpreference.ts @@ -21,14 +21,14 @@ export const ChannelPreferenceType = { export type ChannelPreferenceType = ClosedEnum; export type ChannelPreference = { - /** - * The type of channel that is enabled or not - */ - type: ChannelPreferenceType; /** * If channel is enabled or not */ enabled: boolean; + /** + * The type of channel that is enabled or not + */ + type: ChannelPreferenceType; }; /** @internal */ @@ -40,17 +40,17 @@ export namespace ChannelPreferenceType$ { /** @internal */ export namespace ChannelPreference$ { export const inboundSchema: z.ZodType = z.object({ - type: ChannelPreferenceType$.inboundSchema, enabled: z.boolean(), + type: ChannelPreferenceType$.inboundSchema, }); export type Outbound = { - type: string; enabled: boolean; + type: string; }; export const outboundSchema: z.ZodType = z.object({ - type: ChannelPreferenceType$.outboundSchema, enabled: z.boolean(), + type: ChannelPreferenceType$.outboundSchema, }); } diff --git a/src/models/components/channelsettings.ts b/src/models/components/channelsettings.ts index 239f0e11..f7517ec7 100644 --- a/src/models/components/channelsettings.ts +++ b/src/models/components/channelsettings.ts @@ -36,21 +36,21 @@ export type ChannelSettingsProviderId = ClosedEnum = z .object({ - providerId: ChannelSettingsProviderId$.inboundSchema, - integrationIdentifier: z.string().optional(), - credentials: ChannelCredentials$.inboundSchema, _integrationId: z.string(), + credentials: ChannelCredentials$.inboundSchema, + integrationIdentifier: z.string().optional(), + providerId: ChannelSettingsProviderId$.inboundSchema, }) .transform((v) => { return remap$(v, { @@ -75,18 +75,18 @@ export namespace ChannelSettings$ { }); export type Outbound = { - providerId: string; - integrationIdentifier?: string | undefined; - credentials: ChannelCredentials$.Outbound; _integrationId: string; + credentials: ChannelCredentials$.Outbound; + integrationIdentifier?: string | undefined; + providerId: string; }; export const outboundSchema: z.ZodType = z .object({ - providerId: ChannelSettingsProviderId$.outboundSchema, - integrationIdentifier: z.string().optional(), - credentials: ChannelCredentials$.outboundSchema, integrationId: z.string(), + credentials: ChannelCredentials$.outboundSchema, + integrationIdentifier: z.string().optional(), + providerId: ChannelSettingsProviderId$.outboundSchema, }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/createintegrationrequestdto.ts b/src/models/components/createintegrationrequestdto.ts index e2ffb0fe..30b3f430 100644 --- a/src/models/components/createintegrationrequestdto.ts +++ b/src/models/components/createintegrationrequestdto.ts @@ -8,35 +8,33 @@ import { CredentialsDto, CredentialsDto$ } from "./credentialsdto"; import { StepFilter, StepFilter$ } from "./stepfilter"; import * as z from "zod"; -export const CreateIntegrationRequestDtoChannel = { +export const Channel = { InApp: "in_app", Email: "email", Sms: "sms", Chat: "chat", Push: "push", } as const; -export type CreateIntegrationRequestDtoChannel = ClosedEnum< - typeof CreateIntegrationRequestDtoChannel ->; +export type Channel = ClosedEnum; export type CreateIntegrationRequestDto = { - name?: string | undefined; - identifier?: string | undefined; environmentId?: string | undefined; - providerId: string; - channel: CreateIntegrationRequestDtoChannel; - credentials?: CredentialsDto | undefined; /** * If the integration is active the validation on the credentials field will run */ active?: boolean | undefined; + channel: Channel; check?: boolean | undefined; conditions?: Array | undefined; + credentials?: CredentialsDto | undefined; + identifier?: string | undefined; + name?: string | undefined; + providerId: string; }; /** @internal */ -export namespace CreateIntegrationRequestDtoChannel$ { - export const inboundSchema = z.nativeEnum(CreateIntegrationRequestDtoChannel); +export namespace Channel$ { + export const inboundSchema = z.nativeEnum(Channel); export const outboundSchema = inboundSchema; } @@ -44,15 +42,15 @@ export namespace CreateIntegrationRequestDtoChannel$ { export namespace CreateIntegrationRequestDto$ { export const inboundSchema: z.ZodType = z .object({ - name: z.string().optional(), - identifier: z.string().optional(), _environmentId: z.string().optional(), - providerId: z.string(), - channel: CreateIntegrationRequestDtoChannel$.inboundSchema, - credentials: CredentialsDto$.inboundSchema.optional(), active: z.boolean().optional(), + channel: Channel$.inboundSchema, check: z.boolean().optional(), conditions: z.array(StepFilter$.inboundSchema).optional(), + credentials: CredentialsDto$.inboundSchema.optional(), + identifier: z.string().optional(), + name: z.string().optional(), + providerId: z.string(), }) .transform((v) => { return remap$(v, { @@ -61,28 +59,28 @@ export namespace CreateIntegrationRequestDto$ { }); export type Outbound = { - name?: string | undefined; - identifier?: string | undefined; _environmentId?: string | undefined; - providerId: string; - channel: string; - credentials?: CredentialsDto$.Outbound | undefined; active?: boolean | undefined; + channel: string; check?: boolean | undefined; conditions?: Array | undefined; + credentials?: CredentialsDto$.Outbound | undefined; + identifier?: string | undefined; + name?: string | undefined; + providerId: string; }; export const outboundSchema: z.ZodType = z .object({ - name: z.string().optional(), - identifier: z.string().optional(), environmentId: z.string().optional(), - providerId: z.string(), - channel: CreateIntegrationRequestDtoChannel$.outboundSchema, - credentials: CredentialsDto$.outboundSchema.optional(), active: z.boolean().optional(), + channel: Channel$.outboundSchema, check: z.boolean().optional(), conditions: z.array(StepFilter$.outboundSchema).optional(), + credentials: CredentialsDto$.outboundSchema.optional(), + identifier: z.string().optional(), + name: z.string().optional(), + providerId: z.string(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/createorganizationdto.ts b/src/models/components/createorganizationdto.ts index eec1f201..3d47c42f 100644 --- a/src/models/components/createorganizationdto.ts +++ b/src/models/components/createorganizationdto.ts @@ -20,10 +20,10 @@ export type JobTitle = ClosedEnum; export type ProductUseCases = {}; export type CreateOrganizationDto = { - name: string; - logo?: string | undefined; - jobTitle?: JobTitle | undefined; domain?: string | undefined; + jobTitle?: JobTitle | undefined; + logo?: string | undefined; + name: string; productUseCases?: ProductUseCases | undefined; }; @@ -45,27 +45,27 @@ export namespace ProductUseCases$ { /** @internal */ export namespace CreateOrganizationDto$ { export const inboundSchema: z.ZodType = z.object({ - name: z.string(), - logo: z.string().optional(), - jobTitle: JobTitle$.inboundSchema.optional(), domain: z.string().optional(), + jobTitle: JobTitle$.inboundSchema.optional(), + logo: z.string().optional(), + name: z.string(), productUseCases: z.lazy(() => ProductUseCases$.inboundSchema).optional(), }); export type Outbound = { - name: string; - logo?: string | undefined; - jobTitle?: string | undefined; domain?: string | undefined; + jobTitle?: string | undefined; + logo?: string | undefined; + name: string; productUseCases?: ProductUseCases$.Outbound | undefined; }; export const outboundSchema: z.ZodType = z.object({ - name: z.string(), - logo: z.string().optional(), - jobTitle: JobTitle$.outboundSchema.optional(), domain: z.string().optional(), + jobTitle: JobTitle$.outboundSchema.optional(), + logo: z.string().optional(), + name: z.string(), productUseCases: z.lazy(() => ProductUseCases$.outboundSchema).optional(), }); } diff --git a/src/models/components/createsubscriberrequestdto.ts b/src/models/components/createsubscriberrequestdto.ts index e81cc451..c2fa5430 100644 --- a/src/models/components/createsubscriberrequestdto.ts +++ b/src/models/components/createsubscriberrequestdto.ts @@ -5,74 +5,72 @@ import { SubscriberChannelDto, SubscriberChannelDto$ } from "./subscriberchanneldto"; import * as z from "zod"; -export type CreateSubscriberRequestDtoData = {}; +export type Data = {}; export type CreateSubscriberRequestDto = { /** - * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems + * An http url to the profile image of your subscriber */ - subscriberId: string; + avatar?: string | undefined; + channels?: Array | undefined; + data?: Data | undefined; email?: string | undefined; firstName?: string | undefined; lastName?: string | undefined; + locale?: string | undefined; phone?: string | undefined; /** - * An http url to the profile image of your subscriber + * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems */ - avatar?: string | undefined; - locale?: string | undefined; - data?: CreateSubscriberRequestDtoData | undefined; - channels?: Array | undefined; + subscriberId: string; }; /** @internal */ -export namespace CreateSubscriberRequestDtoData$ { - export const inboundSchema: z.ZodType = - z.object({}); +export namespace Data$ { + export const inboundSchema: z.ZodType = z.object({}); export type Outbound = {}; - export const outboundSchema: z.ZodType = - z.object({}); + export const outboundSchema: z.ZodType = z.object({}); } /** @internal */ export namespace CreateSubscriberRequestDto$ { export const inboundSchema: z.ZodType = z.object({ - subscriberId: z.string(), + avatar: z.string().optional(), + channels: z.array(SubscriberChannelDto$.inboundSchema).optional(), + data: z.lazy(() => Data$.inboundSchema).optional(), email: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), - phone: z.string().optional(), - avatar: z.string().optional(), locale: z.string().optional(), - data: z.lazy(() => CreateSubscriberRequestDtoData$.inboundSchema).optional(), - channels: z.array(SubscriberChannelDto$.inboundSchema).optional(), + phone: z.string().optional(), + subscriberId: z.string(), }); export type Outbound = { - subscriberId: string; + avatar?: string | undefined; + channels?: Array | undefined; + data?: Data$.Outbound | undefined; email?: string | undefined; firstName?: string | undefined; lastName?: string | undefined; - phone?: string | undefined; - avatar?: string | undefined; locale?: string | undefined; - data?: CreateSubscriberRequestDtoData$.Outbound | undefined; - channels?: Array | undefined; + phone?: string | undefined; + subscriberId: string; }; export const outboundSchema: z.ZodType = z.object({ - subscriberId: z.string(), + avatar: z.string().optional(), + channels: z.array(SubscriberChannelDto$.outboundSchema).optional(), + data: z.lazy(() => Data$.outboundSchema).optional(), email: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), - phone: z.string().optional(), - avatar: z.string().optional(), locale: z.string().optional(), - data: z.lazy(() => CreateSubscriberRequestDtoData$.outboundSchema).optional(), - channels: z.array(SubscriberChannelDto$.outboundSchema).optional(), + phone: z.string().optional(), + subscriberId: z.string(), }); } diff --git a/src/models/components/createtenantrequestdto.ts b/src/models/components/createtenantrequestdto.ts index d63d433e..b9b40ea4 100644 --- a/src/models/components/createtenantrequestdto.ts +++ b/src/models/components/createtenantrequestdto.ts @@ -7,9 +7,9 @@ import * as z from "zod"; export type CreateTenantRequestDtoData = {}; export type CreateTenantRequestDto = { + data?: CreateTenantRequestDtoData | undefined; identifier: string; name: string; - data?: CreateTenantRequestDtoData | undefined; }; /** @internal */ @@ -27,22 +27,22 @@ export namespace CreateTenantRequestDtoData$ { export namespace CreateTenantRequestDto$ { export const inboundSchema: z.ZodType = z.object( { + data: z.lazy(() => CreateTenantRequestDtoData$.inboundSchema).optional(), identifier: z.string(), name: z.string(), - data: z.lazy(() => CreateTenantRequestDtoData$.inboundSchema).optional(), } ); export type Outbound = { + data?: CreateTenantRequestDtoData$.Outbound | undefined; identifier: string; name: string; - data?: CreateTenantRequestDtoData$.Outbound | undefined; }; export const outboundSchema: z.ZodType = z.object({ + data: z.lazy(() => CreateTenantRequestDtoData$.outboundSchema).optional(), identifier: z.string(), name: z.string(), - data: z.lazy(() => CreateTenantRequestDtoData$.outboundSchema).optional(), }); } diff --git a/src/models/components/createtenantresponsedto.ts b/src/models/components/createtenantresponsedto.ts index 3f44d611..0e9fd9ec 100644 --- a/src/models/components/createtenantresponsedto.ts +++ b/src/models/components/createtenantresponsedto.ts @@ -8,12 +8,12 @@ import * as z from "zod"; export type CreateTenantResponseDtoData = {}; export type CreateTenantResponseDto = { + environmentId: string; id: string; + createdAt: string; + data?: CreateTenantResponseDtoData | undefined; identifier: string; name?: string | undefined; - data?: CreateTenantResponseDtoData | undefined; - environmentId: string; - createdAt: string; updatedAt: string; }; @@ -32,45 +32,45 @@ export namespace CreateTenantResponseDtoData$ { export namespace CreateTenantResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _environmentId: z.string(), _id: z.string(), + createdAt: z.string(), + data: z.lazy(() => CreateTenantResponseDtoData$.inboundSchema).optional(), identifier: z.string(), name: z.string().optional(), - data: z.lazy(() => CreateTenantResponseDtoData$.inboundSchema).optional(), - _environmentId: z.string(), - createdAt: z.string(), updatedAt: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", }); }); export type Outbound = { + _environmentId: string; _id: string; + createdAt: string; + data?: CreateTenantResponseDtoData$.Outbound | undefined; identifier: string; name?: string | undefined; - data?: CreateTenantResponseDtoData$.Outbound | undefined; - _environmentId: string; - createdAt: string; updatedAt: string; }; export const outboundSchema: z.ZodType = z .object({ + environmentId: z.string(), id: z.string(), + createdAt: z.string(), + data: z.lazy(() => CreateTenantResponseDtoData$.outboundSchema).optional(), identifier: z.string(), name: z.string().optional(), - data: z.lazy(() => CreateTenantResponseDtoData$.outboundSchema).optional(), - environmentId: z.string(), - createdAt: z.string(), updatedAt: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", }); }); } diff --git a/src/models/components/createworkflowrequestdto.ts b/src/models/components/createworkflowrequestdto.ts index 973fa1f4..4b612716 100644 --- a/src/models/components/createworkflowrequestdto.ts +++ b/src/models/components/createworkflowrequestdto.ts @@ -6,28 +6,39 @@ import { NotificationStep, NotificationStep$ } from "./notificationstep"; import { PreferenceChannels, PreferenceChannels$ } from "./preferencechannels"; import * as z from "zod"; -export type CreateWorkflowRequestDtoNotificationGroup = {}; - export type CreateWorkflowRequestDtoData = {}; +export type CreateWorkflowRequestDtoNotificationGroup = {}; + export type CreateWorkflowRequestDto = { - name: string; - notificationGroupId: string; - notificationGroup?: CreateWorkflowRequestDtoNotificationGroup | undefined; - tags?: Array | undefined; - description?: string | undefined; - steps: Array; active?: boolean | undefined; + blueprintId?: string | undefined; + critical?: boolean | undefined; + data?: CreateWorkflowRequestDtoData | undefined; + description?: string | undefined; /** * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ draft?: boolean | undefined; - critical?: boolean | undefined; + name: string; + notificationGroup?: CreateWorkflowRequestDtoNotificationGroup | undefined; + notificationGroupId: string; preferenceSettings?: PreferenceChannels | undefined; - blueprintId?: string | undefined; - data?: CreateWorkflowRequestDtoData | undefined; + steps: Array; + tags?: Array | undefined; }; +/** @internal */ +export namespace CreateWorkflowRequestDtoData$ { + export const inboundSchema: z.ZodType = + z.object({}); + + export type Outbound = {}; + + export const outboundSchema: z.ZodType = + z.object({}); +} + /** @internal */ export namespace CreateWorkflowRequestDtoNotificationGroup$ { export const inboundSchema: z.ZodType< @@ -45,67 +56,56 @@ export namespace CreateWorkflowRequestDtoNotificationGroup$ { > = z.object({}); } -/** @internal */ -export namespace CreateWorkflowRequestDtoData$ { - export const inboundSchema: z.ZodType = - z.object({}); - - export type Outbound = {}; - - export const outboundSchema: z.ZodType = - z.object({}); -} - /** @internal */ export namespace CreateWorkflowRequestDto$ { export const inboundSchema: z.ZodType = z.object({ + active: z.boolean().optional(), + blueprintId: z.string().optional(), + critical: z.boolean().optional(), + data: z.lazy(() => CreateWorkflowRequestDtoData$.inboundSchema).optional(), + description: z.string().optional(), + draft: z.boolean().optional(), name: z.string(), - notificationGroupId: z.string(), notificationGroup: z .lazy(() => CreateWorkflowRequestDtoNotificationGroup$.inboundSchema) .optional(), - tags: z.array(z.string()).optional(), - description: z.string().optional(), - steps: z.array(NotificationStep$.inboundSchema), - active: z.boolean().optional(), - draft: z.boolean().optional(), - critical: z.boolean().optional(), + notificationGroupId: z.string(), preferenceSettings: PreferenceChannels$.inboundSchema.optional(), - blueprintId: z.string().optional(), - data: z.lazy(() => CreateWorkflowRequestDtoData$.inboundSchema).optional(), + steps: z.array(NotificationStep$.inboundSchema), + tags: z.array(z.string()).optional(), }); export type Outbound = { - name: string; - notificationGroupId: string; - notificationGroup?: CreateWorkflowRequestDtoNotificationGroup$.Outbound | undefined; - tags?: Array | undefined; - description?: string | undefined; - steps: Array; active?: boolean | undefined; - draft?: boolean | undefined; - critical?: boolean | undefined; - preferenceSettings?: PreferenceChannels$.Outbound | undefined; blueprintId?: string | undefined; + critical?: boolean | undefined; data?: CreateWorkflowRequestDtoData$.Outbound | undefined; + description?: string | undefined; + draft?: boolean | undefined; + name: string; + notificationGroup?: CreateWorkflowRequestDtoNotificationGroup$.Outbound | undefined; + notificationGroupId: string; + preferenceSettings?: PreferenceChannels$.Outbound | undefined; + steps: Array; + tags?: Array | undefined; }; export const outboundSchema: z.ZodType = z.object({ + active: z.boolean().optional(), + blueprintId: z.string().optional(), + critical: z.boolean().optional(), + data: z.lazy(() => CreateWorkflowRequestDtoData$.outboundSchema).optional(), + description: z.string().optional(), + draft: z.boolean().optional(), name: z.string(), - notificationGroupId: z.string(), notificationGroup: z .lazy(() => CreateWorkflowRequestDtoNotificationGroup$.outboundSchema) .optional(), - tags: z.array(z.string()).optional(), - description: z.string().optional(), - steps: z.array(NotificationStep$.outboundSchema), - active: z.boolean().optional(), - draft: z.boolean().optional(), - critical: z.boolean().optional(), + notificationGroupId: z.string(), preferenceSettings: PreferenceChannels$.outboundSchema.optional(), - blueprintId: z.string().optional(), - data: z.lazy(() => CreateWorkflowRequestDtoData$.outboundSchema).optional(), + steps: z.array(NotificationStep$.outboundSchema), + tags: z.array(z.string()).optional(), }); } diff --git a/src/models/components/credentialsdto.ts b/src/models/components/credentialsdto.ts index 4c9f87af..96cf7739 100644 --- a/src/models/components/credentialsdto.ts +++ b/src/models/components/credentialsdto.ts @@ -7,47 +7,47 @@ import * as z from "zod"; export type TlsOptions = {}; export type CredentialsDto = { + accountSid?: string | undefined; + alertUid?: string | undefined; apiKey?: string | undefined; - user?: string | undefined; - secretKey?: string | undefined; + apiKeyRequestHeader?: string | undefined; + apiToken?: string | undefined; + applicationId?: string | undefined; + authenticateByToken?: boolean | undefined; + authenticationTokenKey?: string | undefined; + baseUrl?: string | undefined; + channelId?: string | undefined; + clientId?: string | undefined; + datePath?: string | undefined; domain?: string | undefined; - password?: string | undefined; + externalLink?: string | undefined; + from?: string | undefined; + hmac?: boolean | undefined; host?: string | undefined; - port?: string | undefined; - secure?: boolean | undefined; - region?: string | undefined; - accountSid?: string | undefined; + idPath?: string | undefined; + ignoreTls?: boolean | undefined; + imageUrl?: string | undefined; + instanceId?: string | undefined; + ipPoolName?: string | undefined; messageProfileId?: string | undefined; - token?: string | undefined; - from?: string | undefined; - senderName?: string | undefined; + password?: string | undefined; + phoneNumberIdentification?: string | undefined; + port?: string | undefined; projectName?: string | undefined; - applicationId?: string | undefined; - clientId?: string | undefined; - requireTls?: boolean | undefined; - ignoreTls?: boolean | undefined; - tlsOptions?: TlsOptions | undefined; - baseUrl?: string | undefined; - webhookUrl?: string | undefined; redirectUrl?: string | undefined; - hmac?: boolean | undefined; - serviceAccount?: string | undefined; - ipPoolName?: string | undefined; - apiKeyRequestHeader?: string | undefined; + region?: string | undefined; + requireTls?: boolean | undefined; + secretKey?: string | undefined; secretKeyRequestHeader?: string | undefined; - idPath?: string | undefined; - datePath?: string | undefined; - apiToken?: string | undefined; - authenticateByToken?: boolean | undefined; - authenticationTokenKey?: string | undefined; - instanceId?: string | undefined; - alertUid?: string | undefined; - title?: string | undefined; - imageUrl?: string | undefined; + secure?: boolean | undefined; + senderName?: string | undefined; + serviceAccount?: string | undefined; state?: string | undefined; - externalLink?: string | undefined; - channelId?: string | undefined; - phoneNumberIdentification?: string | undefined; + title?: string | undefined; + tlsOptions?: TlsOptions | undefined; + token?: string | undefined; + user?: string | undefined; + webhookUrl?: string | undefined; }; /** @internal */ @@ -62,134 +62,134 @@ export namespace TlsOptions$ { /** @internal */ export namespace CredentialsDto$ { export const inboundSchema: z.ZodType = z.object({ + accountSid: z.string().optional(), + alertUid: z.string().optional(), apiKey: z.string().optional(), - user: z.string().optional(), - secretKey: z.string().optional(), + apiKeyRequestHeader: z.string().optional(), + apiToken: z.string().optional(), + applicationId: z.string().optional(), + authenticateByToken: z.boolean().optional(), + authenticationTokenKey: z.string().optional(), + baseUrl: z.string().optional(), + channelId: z.string().optional(), + clientId: z.string().optional(), + datePath: z.string().optional(), domain: z.string().optional(), - password: z.string().optional(), + externalLink: z.string().optional(), + from: z.string().optional(), + hmac: z.boolean().optional(), host: z.string().optional(), - port: z.string().optional(), - secure: z.boolean().optional(), - region: z.string().optional(), - accountSid: z.string().optional(), + idPath: z.string().optional(), + ignoreTls: z.boolean().optional(), + imageUrl: z.string().optional(), + instanceId: z.string().optional(), + ipPoolName: z.string().optional(), messageProfileId: z.string().optional(), - token: z.string().optional(), - from: z.string().optional(), - senderName: z.string().optional(), + password: z.string().optional(), + phoneNumberIdentification: z.string().optional(), + port: z.string().optional(), projectName: z.string().optional(), - applicationId: z.string().optional(), - clientId: z.string().optional(), - requireTls: z.boolean().optional(), - ignoreTls: z.boolean().optional(), - tlsOptions: z.lazy(() => TlsOptions$.inboundSchema).optional(), - baseUrl: z.string().optional(), - webhookUrl: z.string().optional(), redirectUrl: z.string().optional(), - hmac: z.boolean().optional(), - serviceAccount: z.string().optional(), - ipPoolName: z.string().optional(), - apiKeyRequestHeader: z.string().optional(), + region: z.string().optional(), + requireTls: z.boolean().optional(), + secretKey: z.string().optional(), secretKeyRequestHeader: z.string().optional(), - idPath: z.string().optional(), - datePath: z.string().optional(), - apiToken: z.string().optional(), - authenticateByToken: z.boolean().optional(), - authenticationTokenKey: z.string().optional(), - instanceId: z.string().optional(), - alertUid: z.string().optional(), - title: z.string().optional(), - imageUrl: z.string().optional(), + secure: z.boolean().optional(), + senderName: z.string().optional(), + serviceAccount: z.string().optional(), state: z.string().optional(), - externalLink: z.string().optional(), - channelId: z.string().optional(), - phoneNumberIdentification: z.string().optional(), + title: z.string().optional(), + tlsOptions: z.lazy(() => TlsOptions$.inboundSchema).optional(), + token: z.string().optional(), + user: z.string().optional(), + webhookUrl: z.string().optional(), }); export type Outbound = { + accountSid?: string | undefined; + alertUid?: string | undefined; apiKey?: string | undefined; - user?: string | undefined; - secretKey?: string | undefined; + apiKeyRequestHeader?: string | undefined; + apiToken?: string | undefined; + applicationId?: string | undefined; + authenticateByToken?: boolean | undefined; + authenticationTokenKey?: string | undefined; + baseUrl?: string | undefined; + channelId?: string | undefined; + clientId?: string | undefined; + datePath?: string | undefined; domain?: string | undefined; - password?: string | undefined; + externalLink?: string | undefined; + from?: string | undefined; + hmac?: boolean | undefined; host?: string | undefined; - port?: string | undefined; - secure?: boolean | undefined; - region?: string | undefined; - accountSid?: string | undefined; + idPath?: string | undefined; + ignoreTls?: boolean | undefined; + imageUrl?: string | undefined; + instanceId?: string | undefined; + ipPoolName?: string | undefined; messageProfileId?: string | undefined; - token?: string | undefined; - from?: string | undefined; - senderName?: string | undefined; + password?: string | undefined; + phoneNumberIdentification?: string | undefined; + port?: string | undefined; projectName?: string | undefined; - applicationId?: string | undefined; - clientId?: string | undefined; - requireTls?: boolean | undefined; - ignoreTls?: boolean | undefined; - tlsOptions?: TlsOptions$.Outbound | undefined; - baseUrl?: string | undefined; - webhookUrl?: string | undefined; redirectUrl?: string | undefined; - hmac?: boolean | undefined; - serviceAccount?: string | undefined; - ipPoolName?: string | undefined; - apiKeyRequestHeader?: string | undefined; + region?: string | undefined; + requireTls?: boolean | undefined; + secretKey?: string | undefined; secretKeyRequestHeader?: string | undefined; - idPath?: string | undefined; - datePath?: string | undefined; - apiToken?: string | undefined; - authenticateByToken?: boolean | undefined; - authenticationTokenKey?: string | undefined; - instanceId?: string | undefined; - alertUid?: string | undefined; - title?: string | undefined; - imageUrl?: string | undefined; + secure?: boolean | undefined; + senderName?: string | undefined; + serviceAccount?: string | undefined; state?: string | undefined; - externalLink?: string | undefined; - channelId?: string | undefined; - phoneNumberIdentification?: string | undefined; + title?: string | undefined; + tlsOptions?: TlsOptions$.Outbound | undefined; + token?: string | undefined; + user?: string | undefined; + webhookUrl?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ + accountSid: z.string().optional(), + alertUid: z.string().optional(), apiKey: z.string().optional(), - user: z.string().optional(), - secretKey: z.string().optional(), + apiKeyRequestHeader: z.string().optional(), + apiToken: z.string().optional(), + applicationId: z.string().optional(), + authenticateByToken: z.boolean().optional(), + authenticationTokenKey: z.string().optional(), + baseUrl: z.string().optional(), + channelId: z.string().optional(), + clientId: z.string().optional(), + datePath: z.string().optional(), domain: z.string().optional(), - password: z.string().optional(), + externalLink: z.string().optional(), + from: z.string().optional(), + hmac: z.boolean().optional(), host: z.string().optional(), - port: z.string().optional(), - secure: z.boolean().optional(), - region: z.string().optional(), - accountSid: z.string().optional(), + idPath: z.string().optional(), + ignoreTls: z.boolean().optional(), + imageUrl: z.string().optional(), + instanceId: z.string().optional(), + ipPoolName: z.string().optional(), messageProfileId: z.string().optional(), - token: z.string().optional(), - from: z.string().optional(), - senderName: z.string().optional(), + password: z.string().optional(), + phoneNumberIdentification: z.string().optional(), + port: z.string().optional(), projectName: z.string().optional(), - applicationId: z.string().optional(), - clientId: z.string().optional(), - requireTls: z.boolean().optional(), - ignoreTls: z.boolean().optional(), - tlsOptions: z.lazy(() => TlsOptions$.outboundSchema).optional(), - baseUrl: z.string().optional(), - webhookUrl: z.string().optional(), redirectUrl: z.string().optional(), - hmac: z.boolean().optional(), - serviceAccount: z.string().optional(), - ipPoolName: z.string().optional(), - apiKeyRequestHeader: z.string().optional(), + region: z.string().optional(), + requireTls: z.boolean().optional(), + secretKey: z.string().optional(), secretKeyRequestHeader: z.string().optional(), - idPath: z.string().optional(), - datePath: z.string().optional(), - apiToken: z.string().optional(), - authenticateByToken: z.boolean().optional(), - authenticationTokenKey: z.string().optional(), - instanceId: z.string().optional(), - alertUid: z.string().optional(), - title: z.string().optional(), - imageUrl: z.string().optional(), + secure: z.boolean().optional(), + senderName: z.string().optional(), + serviceAccount: z.string().optional(), state: z.string().optional(), - externalLink: z.string().optional(), - channelId: z.string().optional(), - phoneNumberIdentification: z.string().optional(), + title: z.string().optional(), + tlsOptions: z.lazy(() => TlsOptions$.outboundSchema).optional(), + token: z.string().optional(), + user: z.string().optional(), + webhookUrl: z.string().optional(), }); } diff --git a/src/models/components/delayregularmetadata.ts b/src/models/components/delayregularmetadata.ts index 9925bdf2..2b355d9d 100644 --- a/src/models/components/delayregularmetadata.ts +++ b/src/models/components/delayregularmetadata.ts @@ -5,7 +5,12 @@ import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const DelayRegularMetadataUnit = { +export const DelayRegularMetadataType = { + Regular: "regular", +} as const; +export type DelayRegularMetadataType = ClosedEnum; + +export const Unit = { Seconds: "seconds", Minutes: "minutes", Hours: "hours", @@ -13,28 +18,23 @@ export const DelayRegularMetadataUnit = { Weeks: "weeks", Months: "months", } as const; -export type DelayRegularMetadataUnit = ClosedEnum; - -export const DelayRegularMetadataType = { - Regular: "regular", -} as const; -export type DelayRegularMetadataType = ClosedEnum; +export type Unit = ClosedEnum; export type DelayRegularMetadata = { amount?: number | undefined; - unit?: DelayRegularMetadataUnit | undefined; type: DelayRegularMetadataType; + unit?: Unit | undefined; }; /** @internal */ -export namespace DelayRegularMetadataUnit$ { - export const inboundSchema = z.nativeEnum(DelayRegularMetadataUnit); +export namespace DelayRegularMetadataType$ { + export const inboundSchema = z.nativeEnum(DelayRegularMetadataType); export const outboundSchema = inboundSchema; } /** @internal */ -export namespace DelayRegularMetadataType$ { - export const inboundSchema = z.nativeEnum(DelayRegularMetadataType); +export namespace Unit$ { + export const inboundSchema = z.nativeEnum(Unit); export const outboundSchema = inboundSchema; } @@ -42,21 +42,21 @@ export namespace DelayRegularMetadataType$ { export namespace DelayRegularMetadata$ { export const inboundSchema: z.ZodType = z.object({ amount: z.number().optional(), - unit: DelayRegularMetadataUnit$.inboundSchema.optional(), type: DelayRegularMetadataType$.inboundSchema, + unit: Unit$.inboundSchema.optional(), }); export type Outbound = { amount?: number | undefined; - unit?: string | undefined; type: string; + unit?: string | undefined; }; export const outboundSchema: z.ZodType = z.object( { amount: z.number().optional(), - unit: DelayRegularMetadataUnit$.outboundSchema.optional(), type: DelayRegularMetadataType$.outboundSchema, + unit: Unit$.outboundSchema.optional(), } ); } diff --git a/src/models/components/delayscheduledmetadata.ts b/src/models/components/delayscheduledmetadata.ts index 4273beb6..a31beb38 100644 --- a/src/models/components/delayscheduledmetadata.ts +++ b/src/models/components/delayscheduledmetadata.ts @@ -11,8 +11,8 @@ export const DelayScheduledMetadataType = { export type DelayScheduledMetadataType = ClosedEnum; export type DelayScheduledMetadata = { - type: DelayScheduledMetadataType; delayPath: string; + type: DelayScheduledMetadataType; }; /** @internal */ @@ -25,19 +25,19 @@ export namespace DelayScheduledMetadataType$ { export namespace DelayScheduledMetadata$ { export const inboundSchema: z.ZodType = z.object( { - type: DelayScheduledMetadataType$.inboundSchema, delayPath: z.string(), + type: DelayScheduledMetadataType$.inboundSchema, } ); export type Outbound = { - type: string; delayPath: string; + type: string; }; export const outboundSchema: z.ZodType = z.object({ - type: DelayScheduledMetadataType$.outboundSchema, delayPath: z.string(), + type: DelayScheduledMetadataType$.outboundSchema, }); } diff --git a/src/models/components/digestregularmetadata.ts b/src/models/components/digestregularmetadata.ts index 729d6b0f..dcd78f50 100644 --- a/src/models/components/digestregularmetadata.ts +++ b/src/models/components/digestregularmetadata.ts @@ -5,7 +5,7 @@ import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const Unit = { +export const BackoffUnit = { Seconds: "seconds", Minutes: "minutes", Hours: "hours", @@ -13,7 +13,7 @@ export const Unit = { Weeks: "weeks", Months: "months", } as const; -export type Unit = ClosedEnum; +export type BackoffUnit = ClosedEnum; export const DigestRegularMetadataType = { Regular: "regular", @@ -21,7 +21,7 @@ export const DigestRegularMetadataType = { } as const; export type DigestRegularMetadataType = ClosedEnum; -export const BackoffUnit = { +export const DigestRegularMetadataUnit = { Seconds: "seconds", Minutes: "minutes", Hours: "hours", @@ -29,22 +29,22 @@ export const BackoffUnit = { Weeks: "weeks", Months: "months", } as const; -export type BackoffUnit = ClosedEnum; +export type DigestRegularMetadataUnit = ClosedEnum; export type DigestRegularMetadata = { amount?: number | undefined; - unit?: Unit | undefined; - digestKey?: string | undefined; - type: DigestRegularMetadataType; backoff?: boolean | undefined; backoffAmount?: number | undefined; backoffUnit?: BackoffUnit | undefined; + digestKey?: string | undefined; + type: DigestRegularMetadataType; + unit?: DigestRegularMetadataUnit | undefined; updateMode?: boolean | undefined; }; /** @internal */ -export namespace Unit$ { - export const inboundSchema = z.nativeEnum(Unit); +export namespace BackoffUnit$ { + export const inboundSchema = z.nativeEnum(BackoffUnit); export const outboundSchema = inboundSchema; } @@ -55,8 +55,8 @@ export namespace DigestRegularMetadataType$ { } /** @internal */ -export namespace BackoffUnit$ { - export const inboundSchema = z.nativeEnum(BackoffUnit); +export namespace DigestRegularMetadataUnit$ { + export const inboundSchema = z.nativeEnum(DigestRegularMetadataUnit); export const outboundSchema = inboundSchema; } @@ -64,35 +64,35 @@ export namespace BackoffUnit$ { export namespace DigestRegularMetadata$ { export const inboundSchema: z.ZodType = z.object({ amount: z.number().optional(), - unit: Unit$.inboundSchema.optional(), - digestKey: z.string().optional(), - type: DigestRegularMetadataType$.inboundSchema, backoff: z.boolean().optional(), backoffAmount: z.number().optional(), backoffUnit: BackoffUnit$.inboundSchema.optional(), + digestKey: z.string().optional(), + type: DigestRegularMetadataType$.inboundSchema, + unit: DigestRegularMetadataUnit$.inboundSchema.optional(), updateMode: z.boolean().optional(), }); export type Outbound = { amount?: number | undefined; - unit?: string | undefined; - digestKey?: string | undefined; - type: string; backoff?: boolean | undefined; backoffAmount?: number | undefined; backoffUnit?: string | undefined; + digestKey?: string | undefined; + type: string; + unit?: string | undefined; updateMode?: boolean | undefined; }; export const outboundSchema: z.ZodType = z.object({ amount: z.number().optional(), - unit: Unit$.outboundSchema.optional(), - digestKey: z.string().optional(), - type: DigestRegularMetadataType$.outboundSchema, backoff: z.boolean().optional(), backoffAmount: z.number().optional(), backoffUnit: BackoffUnit$.outboundSchema.optional(), + digestKey: z.string().optional(), + type: DigestRegularMetadataType$.outboundSchema, + unit: DigestRegularMetadataUnit$.outboundSchema.optional(), updateMode: z.boolean().optional(), }); } diff --git a/src/models/components/digesttimedmetadata.ts b/src/models/components/digesttimedmetadata.ts index 9129d960..436414fa 100644 --- a/src/models/components/digesttimedmetadata.ts +++ b/src/models/components/digesttimedmetadata.ts @@ -6,6 +6,11 @@ import { ClosedEnum } from "../../types"; import { TimedConfig, TimedConfig$ } from "./timedconfig"; import * as z from "zod"; +export const DigestTimedMetadataType = { + Timed: "timed", +} as const; +export type DigestTimedMetadataType = ClosedEnum; + export const DigestTimedMetadataUnit = { Seconds: "seconds", Minutes: "minutes", @@ -16,28 +21,23 @@ export const DigestTimedMetadataUnit = { } as const; export type DigestTimedMetadataUnit = ClosedEnum; -export const DigestTimedMetadataType = { - Timed: "timed", -} as const; -export type DigestTimedMetadataType = ClosedEnum; - export type DigestTimedMetadata = { amount?: number | undefined; - unit?: DigestTimedMetadataUnit | undefined; digestKey?: string | undefined; - type: DigestTimedMetadataType; timed?: TimedConfig | undefined; + type: DigestTimedMetadataType; + unit?: DigestTimedMetadataUnit | undefined; }; /** @internal */ -export namespace DigestTimedMetadataUnit$ { - export const inboundSchema = z.nativeEnum(DigestTimedMetadataUnit); +export namespace DigestTimedMetadataType$ { + export const inboundSchema = z.nativeEnum(DigestTimedMetadataType); export const outboundSchema = inboundSchema; } /** @internal */ -export namespace DigestTimedMetadataType$ { - export const inboundSchema = z.nativeEnum(DigestTimedMetadataType); +export namespace DigestTimedMetadataUnit$ { + export const inboundSchema = z.nativeEnum(DigestTimedMetadataUnit); export const outboundSchema = inboundSchema; } @@ -45,25 +45,25 @@ export namespace DigestTimedMetadataType$ { export namespace DigestTimedMetadata$ { export const inboundSchema: z.ZodType = z.object({ amount: z.number().optional(), - unit: DigestTimedMetadataUnit$.inboundSchema.optional(), digestKey: z.string().optional(), - type: DigestTimedMetadataType$.inboundSchema, timed: TimedConfig$.inboundSchema.optional(), + type: DigestTimedMetadataType$.inboundSchema, + unit: DigestTimedMetadataUnit$.inboundSchema.optional(), }); export type Outbound = { amount?: number | undefined; - unit?: string | undefined; digestKey?: string | undefined; - type: string; timed?: TimedConfig$.Outbound | undefined; + type: string; + unit?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ amount: z.number().optional(), - unit: DigestTimedMetadataUnit$.outboundSchema.optional(), digestKey: z.string().optional(), - type: DigestTimedMetadataType$.outboundSchema, timed: TimedConfig$.outboundSchema.optional(), + type: DigestTimedMetadataType$.outboundSchema, + unit: DigestTimedMetadataUnit$.outboundSchema.optional(), }); } diff --git a/src/models/components/emailblock.ts b/src/models/components/emailblock.ts index 40984434..5fd0b642 100644 --- a/src/models/components/emailblock.ts +++ b/src/models/components/emailblock.ts @@ -13,10 +13,10 @@ export const EmailBlockType = { export type EmailBlockType = ClosedEnum; export type EmailBlock = { - type: EmailBlockType; content: string; - url?: string | undefined; styles?: EmailBlockStyles | undefined; + type: EmailBlockType; + url?: string | undefined; }; /** @internal */ @@ -28,23 +28,23 @@ export namespace EmailBlockType$ { /** @internal */ export namespace EmailBlock$ { export const inboundSchema: z.ZodType = z.object({ - type: EmailBlockType$.inboundSchema, content: z.string(), - url: z.string().optional(), styles: EmailBlockStyles$.inboundSchema.optional(), + type: EmailBlockType$.inboundSchema, + url: z.string().optional(), }); export type Outbound = { - type: string; content: string; - url?: string | undefined; styles?: EmailBlockStyles$.Outbound | undefined; + type: string; + url?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ - type: EmailBlockType$.outboundSchema, content: z.string(), - url: z.string().optional(), styles: EmailBlockStyles$.outboundSchema.optional(), + type: EmailBlockType$.outboundSchema, + url: z.string().optional(), }); } diff --git a/src/models/components/environmentresponsedto.ts b/src/models/components/environmentresponsedto.ts index e62f73e9..c4e9fb2f 100644 --- a/src/models/components/environmentresponsedto.ts +++ b/src/models/components/environmentresponsedto.ts @@ -9,11 +9,11 @@ export type ApiKeys = {}; export type EnvironmentResponseDto = { id?: string | undefined; - name: string; organizationId: string; - identifier: string; - apiKeys?: Array | undefined; parentId: string; + apiKeys?: Array | undefined; + identifier: string; + name: string; }; /** @internal */ @@ -30,11 +30,11 @@ export namespace EnvironmentResponseDto$ { export const inboundSchema: z.ZodType = z .object({ _id: z.string().optional(), - name: z.string(), _organizationId: z.string(), - identifier: z.string(), - apiKeys: z.array(z.lazy(() => ApiKeys$.inboundSchema)).optional(), _parentId: z.string(), + apiKeys: z.array(z.lazy(() => ApiKeys$.inboundSchema)).optional(), + identifier: z.string(), + name: z.string(), }) .transform((v) => { return remap$(v, { @@ -46,21 +46,21 @@ export namespace EnvironmentResponseDto$ { export type Outbound = { _id?: string | undefined; - name: string; _organizationId: string; - identifier: string; - apiKeys?: Array | undefined; _parentId: string; + apiKeys?: Array | undefined; + identifier: string; + name: string; }; export const outboundSchema: z.ZodType = z .object({ id: z.string().optional(), - name: z.string(), organizationId: z.string(), - identifier: z.string(), - apiKeys: z.array(z.lazy(() => ApiKeys$.outboundSchema)).optional(), parentId: z.string(), + apiKeys: z.array(z.lazy(() => ApiKeys$.outboundSchema)).optional(), + identifier: z.string(), + name: z.string(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/executiondetailsresponsedto.ts b/src/models/components/executiondetailsresponsedto.ts index fd6e10d6..51b22b98 100644 --- a/src/models/components/executiondetailsresponsedto.ts +++ b/src/models/components/executiondetailsresponsedto.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives"; import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const Channel = { +export const ExecutionDetailsResponseDtoChannel = { InApp: "in_app", Email: "email", Sms: "sms", @@ -17,17 +17,21 @@ export const Channel = { Delay: "delay", Custom: "custom", } as const; -export type Channel = ClosedEnum; +export type ExecutionDetailsResponseDtoChannel = ClosedEnum< + typeof ExecutionDetailsResponseDtoChannel +>; -export const Source = { +export const ExecutionDetailsResponseDtoSource = { Credentials: "Credentials", Internal: "Internal", Payload: "Payload", Webhook: "Webhook", } as const; -export type Source = ClosedEnum; +export type ExecutionDetailsResponseDtoSource = ClosedEnum< + typeof ExecutionDetailsResponseDtoSource +>; -export const Status = { +export const ExecutionDetailsResponseDtoStatus = { Success: "Success", Warning: "Warning", Failed: "Failed", @@ -35,43 +39,45 @@ export const Status = { Queued: "Queued", ReadConfirmation: "ReadConfirmation", } as const; -export type Status = ClosedEnum; +export type ExecutionDetailsResponseDtoStatus = ClosedEnum< + typeof ExecutionDetailsResponseDtoStatus +>; export type ExecutionDetailsResponseDto = { + environmentId: string; id?: string | undefined; - organizationId: string; jobId: string; - environmentId: string; + messageId?: string | undefined; notificationId: string; notificationTemplateId: string; + organizationId: string; subscriberId: string; - messageId?: string | undefined; - providerId?: string | undefined; - transactionId: string; - channel: Channel; + channel: ExecutionDetailsResponseDtoChannel; + createdAt?: string | undefined; detail: string; - source: Source; - status: Status; - isTest: boolean; isRetry: boolean; - createdAt?: string | undefined; + isTest: boolean; + providerId?: string | undefined; + source: ExecutionDetailsResponseDtoSource; + status: ExecutionDetailsResponseDtoStatus; + transactionId: string; }; /** @internal */ -export namespace Channel$ { - export const inboundSchema = z.nativeEnum(Channel); +export namespace ExecutionDetailsResponseDtoChannel$ { + export const inboundSchema = z.nativeEnum(ExecutionDetailsResponseDtoChannel); export const outboundSchema = inboundSchema; } /** @internal */ -export namespace Source$ { - export const inboundSchema = z.nativeEnum(Source); +export namespace ExecutionDetailsResponseDtoSource$ { + export const inboundSchema = z.nativeEnum(ExecutionDetailsResponseDtoSource); export const outboundSchema = inboundSchema; } /** @internal */ -export namespace Status$ { - export const inboundSchema = z.nativeEnum(Status); +export namespace ExecutionDetailsResponseDtoStatus$ { + export const inboundSchema = z.nativeEnum(ExecutionDetailsResponseDtoStatus); export const outboundSchema = inboundSchema; } @@ -79,87 +85,87 @@ export namespace Status$ { export namespace ExecutionDetailsResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _environmentId: z.string(), _id: z.string().optional(), - _organizationId: z.string(), _jobId: z.string(), - _environmentId: z.string(), + _messageId: z.string().optional(), _notificationId: z.string(), _notificationTemplateId: z.string(), + _organizationId: z.string(), _subscriberId: z.string(), - _messageId: z.string().optional(), - providerId: z.string().optional(), - transactionId: z.string(), - channel: Channel$.inboundSchema, + channel: ExecutionDetailsResponseDtoChannel$.inboundSchema, + createdAt: z.string().optional(), detail: z.string(), - source: Source$.inboundSchema, - status: Status$.inboundSchema, - isTest: z.boolean(), isRetry: z.boolean(), - createdAt: z.string().optional(), + isTest: z.boolean(), + providerId: z.string().optional(), + source: ExecutionDetailsResponseDtoSource$.inboundSchema, + status: ExecutionDetailsResponseDtoStatus$.inboundSchema, + transactionId: z.string(), }) .transform((v) => { return remap$(v, { + _environmentId: "environmentId", _id: "id", - _organizationId: "organizationId", _jobId: "jobId", - _environmentId: "environmentId", + _messageId: "messageId", _notificationId: "notificationId", _notificationTemplateId: "notificationTemplateId", + _organizationId: "organizationId", _subscriberId: "subscriberId", - _messageId: "messageId", }); }); export type Outbound = { + _environmentId: string; _id?: string | undefined; - _organizationId: string; _jobId: string; - _environmentId: string; + _messageId?: string | undefined; _notificationId: string; _notificationTemplateId: string; + _organizationId: string; _subscriberId: string; - _messageId?: string | undefined; - providerId?: string | undefined; - transactionId: string; channel: string; + createdAt?: string | undefined; detail: string; + isRetry: boolean; + isTest: boolean; + providerId?: string | undefined; source: string; status: string; - isTest: boolean; - isRetry: boolean; - createdAt?: string | undefined; + transactionId: string; }; export const outboundSchema: z.ZodType = z .object({ + environmentId: z.string(), id: z.string().optional(), - organizationId: z.string(), jobId: z.string(), - environmentId: z.string(), + messageId: z.string().optional(), notificationId: z.string(), notificationTemplateId: z.string(), + organizationId: z.string(), subscriberId: z.string(), - messageId: z.string().optional(), - providerId: z.string().optional(), - transactionId: z.string(), - channel: Channel$.outboundSchema, + channel: ExecutionDetailsResponseDtoChannel$.outboundSchema, + createdAt: z.string().optional(), detail: z.string(), - source: Source$.outboundSchema, - status: Status$.outboundSchema, - isTest: z.boolean(), isRetry: z.boolean(), - createdAt: z.string().optional(), + isTest: z.boolean(), + providerId: z.string().optional(), + source: ExecutionDetailsResponseDtoSource$.outboundSchema, + status: ExecutionDetailsResponseDtoStatus$.outboundSchema, + transactionId: z.string(), }) .transform((v) => { return remap$(v, { + environmentId: "_environmentId", id: "_id", - organizationId: "_organizationId", jobId: "_jobId", - environmentId: "_environmentId", + messageId: "_messageId", notificationId: "_notificationId", notificationTemplateId: "_notificationTemplateId", + organizationId: "_organizationId", subscriberId: "_subscriberId", - messageId: "_messageId", }); }); } diff --git a/src/models/components/feedresponsedto.ts b/src/models/components/feedresponsedto.ts index b7ab80ff..64ae8721 100644 --- a/src/models/components/feedresponsedto.ts +++ b/src/models/components/feedresponsedto.ts @@ -6,51 +6,51 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type FeedResponseDto = { - id?: string | undefined; - name: string; - identifier: string; environmentId: string; + id?: string | undefined; organizationId: string; + identifier: string; + name: string; }; /** @internal */ export namespace FeedResponseDto$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), - name: z.string(), - identifier: z.string(), _environmentId: z.string(), + _id: z.string().optional(), _organizationId: z.string(), + identifier: z.string(), + name: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", _organizationId: "organizationId", }); }); export type Outbound = { - _id?: string | undefined; - name: string; - identifier: string; _environmentId: string; + _id?: string | undefined; _organizationId: string; + identifier: string; + name: string; }; export const outboundSchema: z.ZodType = z .object({ - id: z.string().optional(), - name: z.string(), - identifier: z.string(), environmentId: z.string(), + id: z.string().optional(), organizationId: z.string(), + identifier: z.string(), + name: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", organizationId: "_organizationId", }); }); diff --git a/src/models/components/fieldfilterpart.ts b/src/models/components/fieldfilterpart.ts index a9f991e3..53e8cc67 100644 --- a/src/models/components/fieldfilterpart.ts +++ b/src/models/components/fieldfilterpart.ts @@ -5,6 +5,12 @@ import { ClosedEnum } from "../../types"; import * as z from "zod"; +export const On = { + Subscriber: "subscriber", + Payload: "payload", +} as const; +export type On = ClosedEnum; + export const Operator = { Larger: "LARGER", Smaller: "SMALLER", @@ -23,28 +29,22 @@ export const Operator = { } as const; export type Operator = ClosedEnum; -export const On = { - Subscriber: "subscriber", - Payload: "payload", -} as const; -export type On = ClosedEnum; - export type FieldFilterPart = { field: string; - value: string; - operator: Operator; on: On; + operator: Operator; + value: string; }; /** @internal */ -export namespace Operator$ { - export const inboundSchema = z.nativeEnum(Operator); +export namespace On$ { + export const inboundSchema = z.nativeEnum(On); export const outboundSchema = inboundSchema; } /** @internal */ -export namespace On$ { - export const inboundSchema = z.nativeEnum(On); +export namespace Operator$ { + export const inboundSchema = z.nativeEnum(Operator); export const outboundSchema = inboundSchema; } @@ -52,22 +52,22 @@ export namespace On$ { export namespace FieldFilterPart$ { export const inboundSchema: z.ZodType = z.object({ field: z.string(), - value: z.string(), - operator: Operator$.inboundSchema, on: On$.inboundSchema, + operator: Operator$.inboundSchema, + value: z.string(), }); export type Outbound = { field: string; - value: string; - operator: string; on: string; + operator: string; + value: string; }; export const outboundSchema: z.ZodType = z.object({ field: z.string(), - value: z.string(), - operator: Operator$.outboundSchema, on: On$.outboundSchema, + operator: Operator$.outboundSchema, + value: z.string(), }); } diff --git a/src/models/components/getlayoutresponsedto.ts b/src/models/components/getlayoutresponsedto.ts index 877a34cd..558d251e 100644 --- a/src/models/components/getlayoutresponsedto.ts +++ b/src/models/components/getlayoutresponsedto.ts @@ -18,22 +18,22 @@ export type GetLayoutResponseDtoChannel = ClosedEnum | undefined; + createdAt?: string | undefined; + description?: string | undefined; + identifier: string; isDefault: boolean; isDeleted: boolean; - createdAt?: string | undefined; + name: string; updatedAt?: string | undefined; - parentId?: string | undefined; + variables?: Array | undefined; }; /** @internal */ @@ -55,77 +55,77 @@ export namespace Variables$ { export namespace GetLayoutResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _creatorId: z.string(), + _environmentId: z.string(), _id: z.string().optional(), _organizationId: z.string(), - _environmentId: z.string(), - _creatorId: z.string(), - name: z.string(), - identifier: z.string(), - description: z.string().optional(), + _parentId: z.string().optional(), channel: GetLayoutResponseDtoChannel$.inboundSchema, content: z.string(), contentType: z.string(), - variables: z.array(z.lazy(() => Variables$.inboundSchema)).optional(), + createdAt: z.string().optional(), + description: z.string().optional(), + identifier: z.string(), isDefault: z.boolean(), isDeleted: z.boolean(), - createdAt: z.string().optional(), + name: z.string(), updatedAt: z.string().optional(), - _parentId: z.string().optional(), + variables: z.array(z.lazy(() => Variables$.inboundSchema)).optional(), }) .transform((v) => { return remap$(v, { + _creatorId: "creatorId", + _environmentId: "environmentId", _id: "id", _organizationId: "organizationId", - _environmentId: "environmentId", - _creatorId: "creatorId", _parentId: "parentId", }); }); export type Outbound = { + _creatorId: string; + _environmentId: string; _id?: string | undefined; _organizationId: string; - _environmentId: string; - _creatorId: string; - name: string; - identifier: string; - description?: string | undefined; + _parentId?: string | undefined; channel: string; content: string; contentType: string; - variables?: Array | undefined; + createdAt?: string | undefined; + description?: string | undefined; + identifier: string; isDefault: boolean; isDeleted: boolean; - createdAt?: string | undefined; + name: string; updatedAt?: string | undefined; - _parentId?: string | undefined; + variables?: Array | undefined; }; export const outboundSchema: z.ZodType = z .object({ + creatorId: z.string(), + environmentId: z.string(), id: z.string().optional(), organizationId: z.string(), - environmentId: z.string(), - creatorId: z.string(), - name: z.string(), - identifier: z.string(), - description: z.string().optional(), + parentId: z.string().optional(), channel: GetLayoutResponseDtoChannel$.outboundSchema, content: z.string(), contentType: z.string(), - variables: z.array(z.lazy(() => Variables$.outboundSchema)).optional(), + createdAt: z.string().optional(), + description: z.string().optional(), + identifier: z.string(), isDefault: z.boolean(), isDeleted: z.boolean(), - createdAt: z.string().optional(), + name: z.string(), updatedAt: z.string().optional(), - parentId: z.string().optional(), + variables: z.array(z.lazy(() => Variables$.outboundSchema)).optional(), }) .transform((v) => { return remap$(v, { + creatorId: "_creatorId", + environmentId: "_environmentId", id: "_id", organizationId: "_organizationId", - environmentId: "_environmentId", - creatorId: "_creatorId", parentId: "_parentId", }); }); diff --git a/src/models/components/getsubscriberpreferencesresponsedto.ts b/src/models/components/getsubscriberpreferencesresponsedto.ts index 41f0687b..fd0faa25 100644 --- a/src/models/components/getsubscriberpreferencesresponsedto.ts +++ b/src/models/components/getsubscriberpreferencesresponsedto.ts @@ -7,14 +7,14 @@ import { TemplateResponse, TemplateResponse$ } from "./templateresponse"; import * as z from "zod"; export type GetSubscriberPreferencesResponseDto = { - /** - * The workflow information and if it is critical or not - */ - template?: TemplateResponse | undefined; /** * The preferences of the subscriber regarding the related workflow */ preference: Preference; + /** + * The workflow information and if it is critical or not + */ + template?: TemplateResponse | undefined; }; /** @internal */ @@ -24,13 +24,13 @@ export namespace GetSubscriberPreferencesResponseDto$ { z.ZodTypeDef, unknown > = z.object({ - template: TemplateResponse$.inboundSchema.optional(), preference: Preference$.inboundSchema, + template: TemplateResponse$.inboundSchema.optional(), }); export type Outbound = { - template?: TemplateResponse$.Outbound | undefined; preference: Preference$.Outbound; + template?: TemplateResponse$.Outbound | undefined; }; export const outboundSchema: z.ZodType< @@ -38,7 +38,7 @@ export namespace GetSubscriberPreferencesResponseDto$ { z.ZodTypeDef, GetSubscriberPreferencesResponseDto > = z.object({ - template: TemplateResponse$.outboundSchema.optional(), preference: Preference$.outboundSchema, + template: TemplateResponse$.outboundSchema.optional(), }); } diff --git a/src/models/components/gettenantresponsedto.ts b/src/models/components/gettenantresponsedto.ts index 26925b57..10ad2684 100644 --- a/src/models/components/gettenantresponsedto.ts +++ b/src/models/components/gettenantresponsedto.ts @@ -8,12 +8,12 @@ import * as z from "zod"; export type GetTenantResponseDtoData = {}; export type GetTenantResponseDto = { + environmentId: string; id: string; + createdAt: string; + data?: GetTenantResponseDtoData | undefined; identifier: string; name?: string | undefined; - data?: GetTenantResponseDtoData | undefined; - environmentId: string; - createdAt: string; updatedAt: string; }; @@ -32,45 +32,45 @@ export namespace GetTenantResponseDtoData$ { export namespace GetTenantResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _environmentId: z.string(), _id: z.string(), + createdAt: z.string(), + data: z.lazy(() => GetTenantResponseDtoData$.inboundSchema).optional(), identifier: z.string(), name: z.string().optional(), - data: z.lazy(() => GetTenantResponseDtoData$.inboundSchema).optional(), - _environmentId: z.string(), - createdAt: z.string(), updatedAt: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", }); }); export type Outbound = { + _environmentId: string; _id: string; + createdAt: string; + data?: GetTenantResponseDtoData$.Outbound | undefined; identifier: string; name?: string | undefined; - data?: GetTenantResponseDtoData$.Outbound | undefined; - _environmentId: string; - createdAt: string; updatedAt: string; }; export const outboundSchema: z.ZodType = z .object({ + environmentId: z.string(), id: z.string(), + createdAt: z.string(), + data: z.lazy(() => GetTenantResponseDtoData$.outboundSchema).optional(), identifier: z.string(), name: z.string().optional(), - data: z.lazy(() => GetTenantResponseDtoData$.outboundSchema).optional(), - environmentId: z.string(), - createdAt: z.string(), updatedAt: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", }); }); } diff --git a/src/models/components/gettopicresponsedto.ts b/src/models/components/gettopicresponsedto.ts index 4cd05d00..dbbb2be3 100644 --- a/src/models/components/gettopicresponsedto.ts +++ b/src/models/components/gettopicresponsedto.ts @@ -6,9 +6,9 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type GetTopicResponseDto = { + environmentId: string; id?: string | undefined; organizationId: string; - environmentId: string; key: string; name: string; subscribers: Array; @@ -18,25 +18,25 @@ export type GetTopicResponseDto = { export namespace GetTopicResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _environmentId: z.string(), _id: z.string().optional(), _organizationId: z.string(), - _environmentId: z.string(), key: z.string(), name: z.string(), subscribers: z.array(z.string()), }) .transform((v) => { return remap$(v, { + _environmentId: "environmentId", _id: "id", _organizationId: "organizationId", - _environmentId: "environmentId", }); }); export type Outbound = { + _environmentId: string; _id?: string | undefined; _organizationId: string; - _environmentId: string; key: string; name: string; subscribers: Array; @@ -44,18 +44,18 @@ export namespace GetTopicResponseDto$ { export const outboundSchema: z.ZodType = z .object({ + environmentId: z.string(), id: z.string().optional(), organizationId: z.string(), - environmentId: z.string(), key: z.string(), name: z.string(), subscribers: z.array(z.string()), }) .transform((v) => { return remap$(v, { + environmentId: "_environmentId", id: "_id", organizationId: "_organizationId", - environmentId: "_environmentId", }); }); } diff --git a/src/models/components/integrationresponsedto.ts b/src/models/components/integrationresponsedto.ts index b280139a..a0d7dbc6 100644 --- a/src/models/components/integrationresponsedto.ts +++ b/src/models/components/integrationresponsedto.ts @@ -18,20 +18,20 @@ export const IntegrationResponseDtoChannel = { export type IntegrationResponseDtoChannel = ClosedEnum; export type IntegrationResponseDto = { - id?: string | undefined; environmentId: string; + id?: string | undefined; organizationId: string; - name: string; - identifier: string; - providerId: string; + active: boolean; channel: IntegrationResponseDtoChannel; + conditions?: Array | undefined; credentials: CredentialsDto; - active: boolean; deleted: boolean; deletedAt: string; deletedBy: string; + identifier: string; + name: string; primary: boolean; - conditions?: Array | undefined; + providerId: string; }; /** @internal */ @@ -44,67 +44,67 @@ export namespace IntegrationResponseDtoChannel$ { export namespace IntegrationResponseDto$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), _environmentId: z.string(), + _id: z.string().optional(), _organizationId: z.string(), - name: z.string(), - identifier: z.string(), - providerId: z.string(), + active: z.boolean(), channel: IntegrationResponseDtoChannel$.inboundSchema, + conditions: z.array(StepFilter$.inboundSchema).optional(), credentials: CredentialsDto$.inboundSchema, - active: z.boolean(), deleted: z.boolean(), deletedAt: z.string(), deletedBy: z.string(), + identifier: z.string(), + name: z.string(), primary: z.boolean(), - conditions: z.array(StepFilter$.inboundSchema).optional(), + providerId: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", _organizationId: "organizationId", }); }); export type Outbound = { - _id?: string | undefined; _environmentId: string; + _id?: string | undefined; _organizationId: string; - name: string; - identifier: string; - providerId: string; + active: boolean; channel: string; + conditions?: Array | undefined; credentials: CredentialsDto$.Outbound; - active: boolean; deleted: boolean; deletedAt: string; deletedBy: string; + identifier: string; + name: string; primary: boolean; - conditions?: Array | undefined; + providerId: string; }; export const outboundSchema: z.ZodType = z .object({ - id: z.string().optional(), environmentId: z.string(), + id: z.string().optional(), organizationId: z.string(), - name: z.string(), - identifier: z.string(), - providerId: z.string(), + active: z.boolean(), channel: IntegrationResponseDtoChannel$.outboundSchema, + conditions: z.array(StepFilter$.outboundSchema).optional(), credentials: CredentialsDto$.outboundSchema, - active: z.boolean(), deleted: z.boolean(), deletedAt: z.string(), deletedBy: z.string(), + identifier: z.string(), + name: z.string(), primary: z.boolean(), - conditions: z.array(StepFilter$.outboundSchema).optional(), + providerId: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", organizationId: "_organizationId", }); }); diff --git a/src/models/components/ipartnerconfigurationresponsedto.ts b/src/models/components/ipartnerconfigurationresponsedto.ts index 7a1b3479..26509bef 100644 --- a/src/models/components/ipartnerconfigurationresponsedto.ts +++ b/src/models/components/ipartnerconfigurationresponsedto.ts @@ -17,14 +17,14 @@ export const PartnerType = { export type PartnerType = ClosedEnum; export type IPartnerConfigurationResponseDto = { - projectIds?: Array | undefined; accessToken: string; configurationId: string; - teamId?: string | undefined; /** * Partner Type Enum */ partnerType: PartnerType; + projectIds?: Array | undefined; + teamId?: string | undefined; }; /** @internal */ @@ -37,19 +37,19 @@ export namespace PartnerType$ { export namespace IPartnerConfigurationResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - projectIds: z.array(z.string()).optional(), accessToken: z.string(), configurationId: z.string(), - teamId: z.string().optional(), partnerType: PartnerType$.inboundSchema, + projectIds: z.array(z.string()).optional(), + teamId: z.string().optional(), }); export type Outbound = { - projectIds?: Array | undefined; accessToken: string; configurationId: string; - teamId?: string | undefined; partnerType: string; + projectIds?: Array | undefined; + teamId?: string | undefined; }; export const outboundSchema: z.ZodType< @@ -57,10 +57,10 @@ export namespace IPartnerConfigurationResponseDto$ { z.ZodTypeDef, IPartnerConfigurationResponseDto > = z.object({ - projectIds: z.array(z.string()).optional(), accessToken: z.string(), configurationId: z.string(), - teamId: z.string().optional(), partnerType: PartnerType$.outboundSchema, + projectIds: z.array(z.string()).optional(), + teamId: z.string().optional(), }); } diff --git a/src/models/components/markallmessageasrequestdto.ts b/src/models/components/markallmessageasrequestdto.ts index 5f5e86d4..022ec7fa 100644 --- a/src/models/components/markallmessageasrequestdto.ts +++ b/src/models/components/markallmessageasrequestdto.ts @@ -13,7 +13,7 @@ export type FeedIdentifier = string | Array; /** * Mark all subscriber messages as read, unread, seen or unseen */ -export const MarkAllMessageAsRequestDtoMarkAs = { +export const MarkAs = { Read: "read", Seen: "seen", Unread: "unread", @@ -22,7 +22,7 @@ export const MarkAllMessageAsRequestDtoMarkAs = { /** * Mark all subscriber messages as read, unread, seen or unseen */ -export type MarkAllMessageAsRequestDtoMarkAs = ClosedEnum; +export type MarkAs = ClosedEnum; export type MarkAllMessageAsRequestDto = { /** @@ -32,7 +32,7 @@ export type MarkAllMessageAsRequestDto = { /** * Mark all subscriber messages as read, unread, seen or unseen */ - markAs: MarkAllMessageAsRequestDtoMarkAs; + markAs: MarkAs; }; /** @internal */ @@ -50,8 +50,8 @@ export namespace FeedIdentifier$ { } /** @internal */ -export namespace MarkAllMessageAsRequestDtoMarkAs$ { - export const inboundSchema = z.nativeEnum(MarkAllMessageAsRequestDtoMarkAs); +export namespace MarkAs$ { + export const inboundSchema = z.nativeEnum(MarkAs); export const outboundSchema = inboundSchema; } @@ -60,7 +60,7 @@ export namespace MarkAllMessageAsRequestDto$ { export const inboundSchema: z.ZodType = z.object({ feedIdentifier: z.union([z.string(), z.array(z.string())]).optional(), - markAs: MarkAllMessageAsRequestDtoMarkAs$.inboundSchema, + markAs: MarkAs$.inboundSchema, }); export type Outbound = { @@ -71,6 +71,6 @@ export namespace MarkAllMessageAsRequestDto$ { export const outboundSchema: z.ZodType = z.object({ feedIdentifier: z.union([z.string(), z.array(z.string())]).optional(), - markAs: MarkAllMessageAsRequestDtoMarkAs$.outboundSchema, + markAs: MarkAs$.outboundSchema, }); } diff --git a/src/models/components/markmessageactionasseendto.ts b/src/models/components/markmessageactionasseendto.ts index e97e45e4..3c6cac4e 100644 --- a/src/models/components/markmessageactionasseendto.ts +++ b/src/models/components/markmessageactionasseendto.ts @@ -5,6 +5,11 @@ import { ClosedEnum } from "../../types"; import * as z from "zod"; +/** + * Message action payload + */ +export type MarkMessageActionAsSeenDtoPayload = {}; + /** * Message action status */ @@ -17,28 +22,17 @@ export const MarkMessageActionAsSeenDtoStatus = { */ export type MarkMessageActionAsSeenDtoStatus = ClosedEnum; -/** - * Message action payload - */ -export type MarkMessageActionAsSeenDtoPayload = {}; - export type MarkMessageActionAsSeenDto = { - /** - * Message action status - */ - status: MarkMessageActionAsSeenDtoStatus; /** * Message action payload */ payload?: MarkMessageActionAsSeenDtoPayload | undefined; + /** + * Message action status + */ + status: MarkMessageActionAsSeenDtoStatus; }; -/** @internal */ -export namespace MarkMessageActionAsSeenDtoStatus$ { - export const inboundSchema = z.nativeEnum(MarkMessageActionAsSeenDtoStatus); - export const outboundSchema = inboundSchema; -} - /** @internal */ export namespace MarkMessageActionAsSeenDtoPayload$ { export const inboundSchema: z.ZodType< @@ -56,22 +50,28 @@ export namespace MarkMessageActionAsSeenDtoPayload$ { > = z.object({}); } +/** @internal */ +export namespace MarkMessageActionAsSeenDtoStatus$ { + export const inboundSchema = z.nativeEnum(MarkMessageActionAsSeenDtoStatus); + export const outboundSchema = inboundSchema; +} + /** @internal */ export namespace MarkMessageActionAsSeenDto$ { export const inboundSchema: z.ZodType = z.object({ - status: MarkMessageActionAsSeenDtoStatus$.inboundSchema, payload: z.lazy(() => MarkMessageActionAsSeenDtoPayload$.inboundSchema).optional(), + status: MarkMessageActionAsSeenDtoStatus$.inboundSchema, }); export type Outbound = { - status: string; payload?: MarkMessageActionAsSeenDtoPayload$.Outbound | undefined; + status: string; }; export const outboundSchema: z.ZodType = z.object({ - status: MarkMessageActionAsSeenDtoStatus$.outboundSchema, payload: z.lazy(() => MarkMessageActionAsSeenDtoPayload$.outboundSchema).optional(), + status: MarkMessageActionAsSeenDtoStatus$.outboundSchema, }); } diff --git a/src/models/components/memberinvitedto.ts b/src/models/components/memberinvitedto.ts index aff6a249..612721ce 100644 --- a/src/models/components/memberinvitedto.ts +++ b/src/models/components/memberinvitedto.ts @@ -6,29 +6,29 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type MemberInviteDTO = { + inviterId: string; + answerDate?: Date | undefined; email: string; - token: string; invitationDate: Date; - answerDate?: Date | undefined; - inviterId: string; + token: string; }; /** @internal */ export namespace MemberInviteDTO$ { export const inboundSchema: z.ZodType = z .object({ - email: z.string(), - token: z.string(), - invitationDate: z - .string() - .datetime({ offset: true }) - .transform((v) => new Date(v)), + _inviterId: z.string(), answerDate: z .string() .datetime({ offset: true }) .transform((v) => new Date(v)) .optional(), - _inviterId: z.string(), + email: z.string(), + invitationDate: z + .string() + .datetime({ offset: true }) + .transform((v) => new Date(v)), + token: z.string(), }) .transform((v) => { return remap$(v, { @@ -37,23 +37,23 @@ export namespace MemberInviteDTO$ { }); export type Outbound = { + _inviterId: string; + answerDate?: string | undefined; email: string; - token: string; invitationDate: string; - answerDate?: string | undefined; - _inviterId: string; + token: string; }; export const outboundSchema: z.ZodType = z .object({ - email: z.string(), - token: z.string(), - invitationDate: z.date().transform((v) => v.toISOString()), + inviterId: z.string(), answerDate: z .date() .transform((v) => v.toISOString()) .optional(), - inviterId: z.string(), + email: z.string(), + invitationDate: z.date().transform((v) => v.toISOString()), + token: z.string(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/memberresponsedto.ts b/src/models/components/memberresponsedto.ts index 4616fd72..863cbe96 100644 --- a/src/models/components/memberresponsedto.ts +++ b/src/models/components/memberresponsedto.ts @@ -8,12 +8,6 @@ import { MemberInviteDTO, MemberInviteDTO$ } from "./memberinvitedto"; import { MemberUserDto, MemberUserDto$ } from "./memberuserdto"; import * as z from "zod"; -export const Roles = { - Admin: "admin", - Member: "member", -} as const; -export type Roles = ClosedEnum; - export const MemberStatus = { New: "new", Active: "active", @@ -21,25 +15,31 @@ export const MemberStatus = { } as const; export type MemberStatus = ClosedEnum; +export const Roles = { + Admin: "admin", + Member: "member", +} as const; +export type Roles = ClosedEnum; + export type MemberResponseDto = { id: string; + organizationId: string; userId: string; - user?: MemberUserDto | undefined; - roles?: Roles | undefined; invite?: MemberInviteDTO | undefined; memberStatus?: MemberStatus | undefined; - organizationId: string; + roles?: Roles | undefined; + user?: MemberUserDto | undefined; }; /** @internal */ -export namespace Roles$ { - export const inboundSchema = z.nativeEnum(Roles); +export namespace MemberStatus$ { + export const inboundSchema = z.nativeEnum(MemberStatus); export const outboundSchema = inboundSchema; } /** @internal */ -export namespace MemberStatus$ { - export const inboundSchema = z.nativeEnum(MemberStatus); +export namespace Roles$ { + export const inboundSchema = z.nativeEnum(Roles); export const outboundSchema = inboundSchema; } @@ -48,46 +48,46 @@ export namespace MemberResponseDto$ { export const inboundSchema: z.ZodType = z .object({ _id: z.string(), + _organizationId: z.string(), _userId: z.string(), - user: MemberUserDto$.inboundSchema.optional(), - roles: Roles$.inboundSchema.optional(), invite: MemberInviteDTO$.inboundSchema.optional(), memberStatus: MemberStatus$.inboundSchema.optional(), - _organizationId: z.string(), + roles: Roles$.inboundSchema.optional(), + user: MemberUserDto$.inboundSchema.optional(), }) .transform((v) => { return remap$(v, { _id: "id", - _userId: "userId", _organizationId: "organizationId", + _userId: "userId", }); }); export type Outbound = { _id: string; + _organizationId: string; _userId: string; - user?: MemberUserDto$.Outbound | undefined; - roles?: string | undefined; invite?: MemberInviteDTO$.Outbound | undefined; memberStatus?: string | undefined; - _organizationId: string; + roles?: string | undefined; + user?: MemberUserDto$.Outbound | undefined; }; export const outboundSchema: z.ZodType = z .object({ id: z.string(), + organizationId: z.string(), userId: z.string(), - user: MemberUserDto$.outboundSchema.optional(), - roles: Roles$.outboundSchema.optional(), invite: MemberInviteDTO$.outboundSchema.optional(), memberStatus: MemberStatus$.outboundSchema.optional(), - organizationId: z.string(), + roles: Roles$.outboundSchema.optional(), + user: MemberUserDto$.outboundSchema.optional(), }) .transform((v) => { return remap$(v, { id: "_id", - userId: "_userId", organizationId: "_organizationId", + userId: "_userId", }); }); } diff --git a/src/models/components/memberuserdto.ts b/src/models/components/memberuserdto.ts index 5a8c981d..2c9cb64c 100644 --- a/src/models/components/memberuserdto.ts +++ b/src/models/components/memberuserdto.ts @@ -7,9 +7,9 @@ import * as z from "zod"; export type MemberUserDto = { id: string; + email: string; firstName: string; lastName: string; - email: string; }; /** @internal */ @@ -17,9 +17,9 @@ export namespace MemberUserDto$ { export const inboundSchema: z.ZodType = z .object({ _id: z.string(), + email: z.string(), firstName: z.string(), lastName: z.string(), - email: z.string(), }) .transform((v) => { return remap$(v, { @@ -29,17 +29,17 @@ export namespace MemberUserDto$ { export type Outbound = { _id: string; + email: string; firstName: string; lastName: string; - email: string; }; export const outboundSchema: z.ZodType = z .object({ id: z.string(), + email: z.string(), firstName: z.string(), lastName: z.string(), - email: z.string(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/messageaction.ts b/src/models/components/messageaction.ts index 7621814a..86472355 100644 --- a/src/models/components/messageaction.ts +++ b/src/models/components/messageaction.ts @@ -14,9 +14,9 @@ export const MessageActionStatus = { export type MessageActionStatus = ClosedEnum; export type MessageAction = { - status?: MessageActionStatus | undefined; buttons?: Array | undefined; result?: MessageActionResult | undefined; + status?: MessageActionStatus | undefined; }; /** @internal */ @@ -28,20 +28,20 @@ export namespace MessageActionStatus$ { /** @internal */ export namespace MessageAction$ { export const inboundSchema: z.ZodType = z.object({ - status: MessageActionStatus$.inboundSchema.optional(), buttons: z.array(MessageButton$.inboundSchema).optional(), result: MessageActionResult$.inboundSchema.optional(), + status: MessageActionStatus$.inboundSchema.optional(), }); export type Outbound = { - status?: string | undefined; buttons?: Array | undefined; result?: MessageActionResult$.Outbound | undefined; + status?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ - status: MessageActionStatus$.outboundSchema.optional(), buttons: z.array(MessageButton$.outboundSchema).optional(), result: MessageActionResult$.outboundSchema.optional(), + status: MessageActionStatus$.outboundSchema.optional(), }); } diff --git a/src/models/components/messagebutton.ts b/src/models/components/messagebutton.ts index e14b3135..54b32e94 100644 --- a/src/models/components/messagebutton.ts +++ b/src/models/components/messagebutton.ts @@ -13,9 +13,9 @@ export const MessageButtonType = { export type MessageButtonType = ClosedEnum; export type MessageButton = { - type: MessageButtonType; content: string; resultContent?: string | undefined; + type: MessageButtonType; }; /** @internal */ @@ -27,20 +27,20 @@ export namespace MessageButtonType$ { /** @internal */ export namespace MessageButton$ { export const inboundSchema: z.ZodType = z.object({ - type: MessageButtonType$.inboundSchema, content: z.string(), resultContent: z.string().optional(), + type: MessageButtonType$.inboundSchema, }); export type Outbound = { - type: string; content: string; resultContent?: string | undefined; + type: string; }; export const outboundSchema: z.ZodType = z.object({ - type: MessageButtonType$.outboundSchema, content: z.string(), resultContent: z.string().optional(), + type: MessageButtonType$.outboundSchema, }); } diff --git a/src/models/components/messagecta.ts b/src/models/components/messagecta.ts index bd1df393..4a1c7727 100644 --- a/src/models/components/messagecta.ts +++ b/src/models/components/messagecta.ts @@ -13,9 +13,9 @@ export const MessageCTAType = { export type MessageCTAType = ClosedEnum; export type MessageCTA = { - type?: MessageCTAType | undefined; - data: MessageCTAData; action?: MessageAction | undefined; + data: MessageCTAData; + type?: MessageCTAType | undefined; }; /** @internal */ @@ -27,20 +27,20 @@ export namespace MessageCTAType$ { /** @internal */ export namespace MessageCTA$ { export const inboundSchema: z.ZodType = z.object({ - type: MessageCTAType$.inboundSchema.optional(), - data: MessageCTAData$.inboundSchema, action: MessageAction$.inboundSchema.optional(), + data: MessageCTAData$.inboundSchema, + type: MessageCTAType$.inboundSchema.optional(), }); export type Outbound = { - type?: string | undefined; - data: MessageCTAData$.Outbound; action?: MessageAction$.Outbound | undefined; + data: MessageCTAData$.Outbound; + type?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ - type: MessageCTAType$.outboundSchema.optional(), - data: MessageCTAData$.outboundSchema, action: MessageAction$.outboundSchema.optional(), + data: MessageCTAData$.outboundSchema, + type: MessageCTAType$.outboundSchema.optional(), }); } diff --git a/src/models/components/messagemarkasrequestdto.ts b/src/models/components/messagemarkasrequestdto.ts index 5dd95199..853a6369 100644 --- a/src/models/components/messagemarkasrequestdto.ts +++ b/src/models/components/messagemarkasrequestdto.ts @@ -5,21 +5,27 @@ import { ClosedEnum } from "../../types"; import * as z from "zod"; -export type MessageId = string | Array; - -export const MarkAs = { +export const MessageMarkAsRequestDtoMarkAs = { Read: "read", Seen: "seen", Unread: "unread", Unseen: "unseen", } as const; -export type MarkAs = ClosedEnum; +export type MessageMarkAsRequestDtoMarkAs = ClosedEnum; + +export type MessageId = string | Array; export type MessageMarkAsRequestDto = { + markAs: MessageMarkAsRequestDtoMarkAs; messageId: string | Array; - markAs: MarkAs; }; +/** @internal */ +export namespace MessageMarkAsRequestDtoMarkAs$ { + export const inboundSchema = z.nativeEnum(MessageMarkAsRequestDtoMarkAs); + export const outboundSchema = inboundSchema; +} + /** @internal */ export namespace MessageId$ { export const inboundSchema: z.ZodType = z.union([ @@ -34,28 +40,22 @@ export namespace MessageId$ { ]); } -/** @internal */ -export namespace MarkAs$ { - export const inboundSchema = z.nativeEnum(MarkAs); - export const outboundSchema = inboundSchema; -} - /** @internal */ export namespace MessageMarkAsRequestDto$ { export const inboundSchema: z.ZodType = z.object({ + markAs: MessageMarkAsRequestDtoMarkAs$.inboundSchema, messageId: z.union([z.string(), z.array(z.string())]), - markAs: MarkAs$.inboundSchema, }); export type Outbound = { - messageId: string | Array; markAs: string; + messageId: string | Array; }; export const outboundSchema: z.ZodType = z.object({ + markAs: MessageMarkAsRequestDtoMarkAs$.outboundSchema, messageId: z.union([z.string(), z.array(z.string())]), - markAs: MarkAs$.outboundSchema, }); } diff --git a/src/models/components/messageresponsedto.ts b/src/models/components/messageresponsedto.ts index bf799358..eae66583 100644 --- a/src/models/components/messageresponsedto.ts +++ b/src/models/components/messageresponsedto.ts @@ -10,8 +10,6 @@ import { SubscriberResponseDto, SubscriberResponseDto$ } from "./subscriberrespo import { WorkflowResponse, WorkflowResponse$ } from "./workflowresponse"; import * as z from "zod"; -export type Content = EmailBlock | string; - export const MessageResponseDtoChannel = { InApp: "in_app", Email: "email", @@ -21,64 +19,72 @@ export const MessageResponseDtoChannel = { } as const; export type MessageResponseDtoChannel = ClosedEnum; -export const MessageResponseDtoStatus = { - Sent: "sent", - Error: "error", - Warning: "warning", -} as const; -export type MessageResponseDtoStatus = ClosedEnum; +export type Content = EmailBlock | string; /** - * The payload that was used to send the notification trigger + * Provider specific overrides used when triggering the notification */ -export type MessageResponseDtoPayload = {}; +export type Overrides = {}; /** - * Provider specific overrides used when triggering the notification + * The payload that was used to send the notification trigger */ -export type MessageResponseDtoOverrides = {}; +export type MessageResponseDtoPayload = {}; + +export const MessageResponseDtoStatus = { + Sent: "sent", + Error: "error", + Warning: "warning", +} as const; +export type MessageResponseDtoStatus = ClosedEnum; export type MessageResponseDto = { - id?: string | undefined; - templateId: string; environmentId: string; + feedId?: string | null | undefined; + id?: string | undefined; messageTemplateId: string; - organizationId: string; notificationId: string; + organizationId: string; subscriberId: string; - subscriber?: SubscriberResponseDto | undefined; - template?: WorkflowResponse | undefined; - templateIdentifier?: string | undefined; - createdAt: string; - lastSeenDate?: string | undefined; - lastReadDate?: string | undefined; - content: EmailBlock | string; - transactionId: string; - subject?: string | undefined; + templateId: string; channel: MessageResponseDtoChannel; - read: boolean; - seen: boolean; - email?: string | undefined; - phone?: string | undefined; - directWebhookUrl?: string | undefined; - providerId?: string | undefined; - deviceTokens?: Array | undefined; - title?: string | undefined; + content: EmailBlock | string; + createdAt: string; cta: MessageCTA; - feedId?: string | null | undefined; - status: MessageResponseDtoStatus; + deviceTokens?: Array | undefined; + directWebhookUrl?: string | undefined; + email?: string | undefined; errorId: string; errorText: string; + lastReadDate?: string | undefined; + lastSeenDate?: string | undefined; /** - * The payload that was used to send the notification trigger + * Provider specific overrides used when triggering the notification */ - payload: MessageResponseDtoPayload; + overrides: Overrides; /** - * Provider specific overrides used when triggering the notification + * The payload that was used to send the notification trigger */ - overrides: MessageResponseDtoOverrides; + payload: MessageResponseDtoPayload; + phone?: string | undefined; + providerId?: string | undefined; + read: boolean; + seen: boolean; + status: MessageResponseDtoStatus; + subject?: string | undefined; + subscriber?: SubscriberResponseDto | undefined; + template?: WorkflowResponse | undefined; + templateIdentifier?: string | undefined; + title?: string | undefined; + transactionId: string; }; +/** @internal */ +export namespace MessageResponseDtoChannel$ { + export const inboundSchema = z.nativeEnum(MessageResponseDtoChannel); + export const outboundSchema = inboundSchema; +} + /** @internal */ export namespace Content$ { export const inboundSchema: z.ZodType = z.union([ @@ -94,15 +100,12 @@ export namespace Content$ { } /** @internal */ -export namespace MessageResponseDtoChannel$ { - export const inboundSchema = z.nativeEnum(MessageResponseDtoChannel); - export const outboundSchema = inboundSchema; -} +export namespace Overrides$ { + export const inboundSchema: z.ZodType = z.object({}); -/** @internal */ -export namespace MessageResponseDtoStatus$ { - export const inboundSchema = z.nativeEnum(MessageResponseDtoStatus); - export const outboundSchema = inboundSchema; + export type Outbound = {}; + + export const outboundSchema: z.ZodType = z.object({}); } /** @internal */ @@ -117,146 +120,141 @@ export namespace MessageResponseDtoPayload$ { } /** @internal */ -export namespace MessageResponseDtoOverrides$ { - export const inboundSchema: z.ZodType = - z.object({}); - - export type Outbound = {}; - - export const outboundSchema: z.ZodType = - z.object({}); +export namespace MessageResponseDtoStatus$ { + export const inboundSchema = z.nativeEnum(MessageResponseDtoStatus); + export const outboundSchema = inboundSchema; } /** @internal */ export namespace MessageResponseDto$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), - _templateId: z.string(), _environmentId: z.string(), + _feedId: z.nullable(z.string()).optional(), + _id: z.string().optional(), _messageTemplateId: z.string(), - _organizationId: z.string(), _notificationId: z.string(), + _organizationId: z.string(), _subscriberId: z.string(), - subscriber: SubscriberResponseDto$.inboundSchema.optional(), - template: WorkflowResponse$.inboundSchema.optional(), - templateIdentifier: z.string().optional(), - createdAt: z.string(), - lastSeenDate: z.string().optional(), - lastReadDate: z.string().optional(), - content: z.union([EmailBlock$.inboundSchema, z.string()]), - transactionId: z.string(), - subject: z.string().optional(), + _templateId: z.string(), channel: MessageResponseDtoChannel$.inboundSchema, - read: z.boolean(), - seen: z.boolean(), - email: z.string().optional(), - phone: z.string().optional(), - directWebhookUrl: z.string().optional(), - providerId: z.string().optional(), - deviceTokens: z.array(z.string()).optional(), - title: z.string().optional(), + content: z.union([EmailBlock$.inboundSchema, z.string()]), + createdAt: z.string(), cta: MessageCTA$.inboundSchema, - _feedId: z.nullable(z.string()).optional(), - status: MessageResponseDtoStatus$.inboundSchema, + deviceTokens: z.array(z.string()).optional(), + directWebhookUrl: z.string().optional(), + email: z.string().optional(), errorId: z.string(), errorText: z.string(), + lastReadDate: z.string().optional(), + lastSeenDate: z.string().optional(), + overrides: z.lazy(() => Overrides$.inboundSchema), payload: z.lazy(() => MessageResponseDtoPayload$.inboundSchema), - overrides: z.lazy(() => MessageResponseDtoOverrides$.inboundSchema), + phone: z.string().optional(), + providerId: z.string().optional(), + read: z.boolean(), + seen: z.boolean(), + status: MessageResponseDtoStatus$.inboundSchema, + subject: z.string().optional(), + subscriber: SubscriberResponseDto$.inboundSchema.optional(), + template: WorkflowResponse$.inboundSchema.optional(), + templateIdentifier: z.string().optional(), + title: z.string().optional(), + transactionId: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", - _templateId: "templateId", _environmentId: "environmentId", + _feedId: "feedId", + _id: "id", _messageTemplateId: "messageTemplateId", - _organizationId: "organizationId", _notificationId: "notificationId", + _organizationId: "organizationId", _subscriberId: "subscriberId", - _feedId: "feedId", + _templateId: "templateId", }); }); export type Outbound = { - _id?: string | undefined; - _templateId: string; _environmentId: string; + _feedId?: string | null | undefined; + _id?: string | undefined; _messageTemplateId: string; - _organizationId: string; _notificationId: string; + _organizationId: string; _subscriberId: string; - subscriber?: SubscriberResponseDto$.Outbound | undefined; - template?: WorkflowResponse$.Outbound | undefined; - templateIdentifier?: string | undefined; - createdAt: string; - lastSeenDate?: string | undefined; - lastReadDate?: string | undefined; - content: EmailBlock$.Outbound | string; - transactionId: string; - subject?: string | undefined; + _templateId: string; channel: string; - read: boolean; - seen: boolean; - email?: string | undefined; - phone?: string | undefined; - directWebhookUrl?: string | undefined; - providerId?: string | undefined; - deviceTokens?: Array | undefined; - title?: string | undefined; + content: EmailBlock$.Outbound | string; + createdAt: string; cta: MessageCTA$.Outbound; - _feedId?: string | null | undefined; - status: string; + deviceTokens?: Array | undefined; + directWebhookUrl?: string | undefined; + email?: string | undefined; errorId: string; errorText: string; + lastReadDate?: string | undefined; + lastSeenDate?: string | undefined; + overrides: Overrides$.Outbound; payload: MessageResponseDtoPayload$.Outbound; - overrides: MessageResponseDtoOverrides$.Outbound; + phone?: string | undefined; + providerId?: string | undefined; + read: boolean; + seen: boolean; + status: string; + subject?: string | undefined; + subscriber?: SubscriberResponseDto$.Outbound | undefined; + template?: WorkflowResponse$.Outbound | undefined; + templateIdentifier?: string | undefined; + title?: string | undefined; + transactionId: string; }; export const outboundSchema: z.ZodType = z .object({ - id: z.string().optional(), - templateId: z.string(), environmentId: z.string(), + feedId: z.nullable(z.string()).optional(), + id: z.string().optional(), messageTemplateId: z.string(), - organizationId: z.string(), notificationId: z.string(), + organizationId: z.string(), subscriberId: z.string(), - subscriber: SubscriberResponseDto$.outboundSchema.optional(), - template: WorkflowResponse$.outboundSchema.optional(), - templateIdentifier: z.string().optional(), - createdAt: z.string(), - lastSeenDate: z.string().optional(), - lastReadDate: z.string().optional(), - content: z.union([EmailBlock$.outboundSchema, z.string()]), - transactionId: z.string(), - subject: z.string().optional(), + templateId: z.string(), channel: MessageResponseDtoChannel$.outboundSchema, - read: z.boolean(), - seen: z.boolean(), - email: z.string().optional(), - phone: z.string().optional(), - directWebhookUrl: z.string().optional(), - providerId: z.string().optional(), - deviceTokens: z.array(z.string()).optional(), - title: z.string().optional(), + content: z.union([EmailBlock$.outboundSchema, z.string()]), + createdAt: z.string(), cta: MessageCTA$.outboundSchema, - feedId: z.nullable(z.string()).optional(), - status: MessageResponseDtoStatus$.outboundSchema, + deviceTokens: z.array(z.string()).optional(), + directWebhookUrl: z.string().optional(), + email: z.string().optional(), errorId: z.string(), errorText: z.string(), + lastReadDate: z.string().optional(), + lastSeenDate: z.string().optional(), + overrides: z.lazy(() => Overrides$.outboundSchema), payload: z.lazy(() => MessageResponseDtoPayload$.outboundSchema), - overrides: z.lazy(() => MessageResponseDtoOverrides$.outboundSchema), + phone: z.string().optional(), + providerId: z.string().optional(), + read: z.boolean(), + seen: z.boolean(), + status: MessageResponseDtoStatus$.outboundSchema, + subject: z.string().optional(), + subscriber: SubscriberResponseDto$.outboundSchema.optional(), + template: WorkflowResponse$.outboundSchema.optional(), + templateIdentifier: z.string().optional(), + title: z.string().optional(), + transactionId: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", - templateId: "_templateId", environmentId: "_environmentId", + feedId: "_feedId", + id: "_id", messageTemplateId: "_messageTemplateId", - organizationId: "_organizationId", notificationId: "_notificationId", + organizationId: "_organizationId", subscriberId: "_subscriberId", - feedId: "_feedId", + templateId: "_templateId", }); }); } diff --git a/src/models/components/notificationgroup.ts b/src/models/components/notificationgroup.ts index c83f7be6..da9163a6 100644 --- a/src/models/components/notificationgroup.ts +++ b/src/models/components/notificationgroup.ts @@ -6,52 +6,52 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type NotificationGroup = { - id?: string | undefined; - name: string; environmentId: string; + id?: string | undefined; organizationId: string; parentId?: string | undefined; + name: string; }; /** @internal */ export namespace NotificationGroup$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), - name: z.string(), _environmentId: z.string(), + _id: z.string().optional(), _organizationId: z.string(), _parentId: z.string().optional(), + name: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", _organizationId: "organizationId", _parentId: "parentId", }); }); export type Outbound = { - _id?: string | undefined; - name: string; _environmentId: string; + _id?: string | undefined; _organizationId: string; _parentId?: string | undefined; + name: string; }; export const outboundSchema: z.ZodType = z .object({ - id: z.string().optional(), - name: z.string(), environmentId: z.string(), + id: z.string().optional(), organizationId: z.string(), parentId: z.string().optional(), + name: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", organizationId: "_organizationId", parentId: "_parentId", }); diff --git a/src/models/components/notificationgroupresponsedto.ts b/src/models/components/notificationgroupresponsedto.ts index adb860e1..a700b26a 100644 --- a/src/models/components/notificationgroupresponsedto.ts +++ b/src/models/components/notificationgroupresponsedto.ts @@ -6,52 +6,52 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type NotificationGroupResponseDto = { - id?: string | undefined; - name: string; environmentId: string; + id?: string | undefined; organizationId: string; parentId?: string | undefined; + name: string; }; /** @internal */ export namespace NotificationGroupResponseDto$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), - name: z.string(), _environmentId: z.string(), + _id: z.string().optional(), _organizationId: z.string(), _parentId: z.string().optional(), + name: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", _organizationId: "organizationId", _parentId: "parentId", }); }); export type Outbound = { - _id?: string | undefined; - name: string; _environmentId: string; + _id?: string | undefined; _organizationId: string; _parentId?: string | undefined; + name: string; }; export const outboundSchema: z.ZodType = z .object({ - id: z.string().optional(), - name: z.string(), environmentId: z.string(), + id: z.string().optional(), organizationId: z.string(), parentId: z.string().optional(), + name: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", organizationId: "_organizationId", parentId: "_parentId", }); diff --git a/src/models/components/notificationstep.ts b/src/models/components/notificationstep.ts index ef403a5a..d774bf8f 100644 --- a/src/models/components/notificationstep.ts +++ b/src/models/components/notificationstep.ts @@ -24,21 +24,21 @@ export type ReplyCallback = {}; export type NotificationStep = { id?: string | undefined; - uuid?: string | undefined; - name?: string | undefined; + parentId?: ParentId | undefined; templateId?: string | undefined; active?: boolean | undefined; - shouldStopOnFail?: boolean | undefined; - template?: MessageTemplate | undefined; filters?: Array | undefined; - parentId?: ParentId | undefined; metadata?: | DelayScheduledMetadata | DelayRegularMetadata | DigestTimedMetadata | DigestRegularMetadata | undefined; + name?: string | undefined; replyCallback?: ReplyCallback | undefined; + shouldStopOnFail?: boolean | undefined; + template?: MessageTemplate | undefined; + uuid?: string | undefined; variants?: NotificationStepVariant | undefined; }; @@ -87,14 +87,10 @@ export namespace NotificationStep$ { export const inboundSchema: z.ZodType = z .object({ _id: z.string().optional(), - uuid: z.string().optional(), - name: z.string().optional(), + _parentId: z.lazy(() => ParentId$.inboundSchema).optional(), _templateId: z.string().optional(), active: z.boolean().optional(), - shouldStopOnFail: z.boolean().optional(), - template: MessageTemplate$.inboundSchema.optional(), filters: z.array(StepFilter$.inboundSchema).optional(), - _parentId: z.lazy(() => ParentId$.inboundSchema).optional(), metadata: z .union([ DelayScheduledMetadata$.inboundSchema, @@ -103,48 +99,48 @@ export namespace NotificationStep$ { DigestRegularMetadata$.inboundSchema, ]) .optional(), + name: z.string().optional(), replyCallback: z.lazy(() => ReplyCallback$.inboundSchema).optional(), + shouldStopOnFail: z.boolean().optional(), + template: MessageTemplate$.inboundSchema.optional(), + uuid: z.string().optional(), variants: NotificationStepVariant$.inboundSchema.optional(), }) .transform((v) => { return remap$(v, { _id: "id", - _templateId: "templateId", _parentId: "parentId", + _templateId: "templateId", }); }); export type Outbound = { _id?: string | undefined; - uuid?: string | undefined; - name?: string | undefined; + _parentId?: ParentId$.Outbound | undefined; _templateId?: string | undefined; active?: boolean | undefined; - shouldStopOnFail?: boolean | undefined; - template?: MessageTemplate$.Outbound | undefined; filters?: Array | undefined; - _parentId?: ParentId$.Outbound | undefined; metadata?: | DelayScheduledMetadata$.Outbound | DelayRegularMetadata$.Outbound | DigestTimedMetadata$.Outbound | DigestRegularMetadata$.Outbound | undefined; + name?: string | undefined; replyCallback?: ReplyCallback$.Outbound | undefined; + shouldStopOnFail?: boolean | undefined; + template?: MessageTemplate$.Outbound | undefined; + uuid?: string | undefined; variants?: NotificationStepVariant$.Outbound | undefined; }; export const outboundSchema: z.ZodType = z .object({ id: z.string().optional(), - uuid: z.string().optional(), - name: z.string().optional(), + parentId: z.lazy(() => ParentId$.outboundSchema).optional(), templateId: z.string().optional(), active: z.boolean().optional(), - shouldStopOnFail: z.boolean().optional(), - template: MessageTemplate$.outboundSchema.optional(), filters: z.array(StepFilter$.outboundSchema).optional(), - parentId: z.lazy(() => ParentId$.outboundSchema).optional(), metadata: z .union([ DelayScheduledMetadata$.outboundSchema, @@ -153,14 +149,18 @@ export namespace NotificationStep$ { DigestRegularMetadata$.outboundSchema, ]) .optional(), + name: z.string().optional(), replyCallback: z.lazy(() => ReplyCallback$.outboundSchema).optional(), + shouldStopOnFail: z.boolean().optional(), + template: MessageTemplate$.outboundSchema.optional(), + uuid: z.string().optional(), variants: NotificationStepVariant$.outboundSchema.optional(), }) .transform((v) => { return remap$(v, { id: "_id", - templateId: "_templateId", parentId: "_parentId", + templateId: "_templateId", }); }); } diff --git a/src/models/components/notificationstepvariant.ts b/src/models/components/notificationstepvariant.ts index af98b087..337d6869 100644 --- a/src/models/components/notificationstepvariant.ts +++ b/src/models/components/notificationstepvariant.ts @@ -23,21 +23,21 @@ export type NotificationStepVariantReplyCallback = {}; export type NotificationStepVariant = { id?: string | undefined; - uuid?: string | undefined; - name?: string | undefined; + parentId?: NotificationStepVariantParentId | undefined; templateId?: string | undefined; active?: boolean | undefined; - shouldStopOnFail?: boolean | undefined; - template?: MessageTemplate | undefined; filters?: Array | undefined; - parentId?: NotificationStepVariantParentId | undefined; metadata?: | DelayScheduledMetadata | DelayRegularMetadata | DigestTimedMetadata | DigestRegularMetadata | undefined; + name?: string | undefined; replyCallback?: NotificationStepVariantReplyCallback | undefined; + shouldStopOnFail?: boolean | undefined; + template?: MessageTemplate | undefined; + uuid?: string | undefined; }; /** @internal */ @@ -103,14 +103,10 @@ export namespace NotificationStepVariant$ { export const inboundSchema: z.ZodType = z .object({ _id: z.string().optional(), - uuid: z.string().optional(), - name: z.string().optional(), + _parentId: z.lazy(() => NotificationStepVariantParentId$.inboundSchema).optional(), _templateId: z.string().optional(), active: z.boolean().optional(), - shouldStopOnFail: z.boolean().optional(), - template: MessageTemplate$.inboundSchema.optional(), filters: z.array(StepFilter$.inboundSchema).optional(), - _parentId: z.lazy(() => NotificationStepVariantParentId$.inboundSchema).optional(), metadata: z .union([ DelayScheduledMetadata$.inboundSchema, @@ -119,48 +115,48 @@ export namespace NotificationStepVariant$ { DigestRegularMetadata$.inboundSchema, ]) .optional(), + name: z.string().optional(), replyCallback: z .lazy(() => NotificationStepVariantReplyCallback$.inboundSchema) .optional(), + shouldStopOnFail: z.boolean().optional(), + template: MessageTemplate$.inboundSchema.optional(), + uuid: z.string().optional(), }) .transform((v) => { return remap$(v, { _id: "id", - _templateId: "templateId", _parentId: "parentId", + _templateId: "templateId", }); }); export type Outbound = { _id?: string | undefined; - uuid?: string | undefined; - name?: string | undefined; + _parentId?: NotificationStepVariantParentId$.Outbound | undefined; _templateId?: string | undefined; active?: boolean | undefined; - shouldStopOnFail?: boolean | undefined; - template?: MessageTemplate$.Outbound | undefined; filters?: Array | undefined; - _parentId?: NotificationStepVariantParentId$.Outbound | undefined; metadata?: | DelayScheduledMetadata$.Outbound | DelayRegularMetadata$.Outbound | DigestTimedMetadata$.Outbound | DigestRegularMetadata$.Outbound | undefined; + name?: string | undefined; replyCallback?: NotificationStepVariantReplyCallback$.Outbound | undefined; + shouldStopOnFail?: boolean | undefined; + template?: MessageTemplate$.Outbound | undefined; + uuid?: string | undefined; }; export const outboundSchema: z.ZodType = z .object({ id: z.string().optional(), - uuid: z.string().optional(), - name: z.string().optional(), + parentId: z.lazy(() => NotificationStepVariantParentId$.outboundSchema).optional(), templateId: z.string().optional(), active: z.boolean().optional(), - shouldStopOnFail: z.boolean().optional(), - template: MessageTemplate$.outboundSchema.optional(), filters: z.array(StepFilter$.outboundSchema).optional(), - parentId: z.lazy(() => NotificationStepVariantParentId$.outboundSchema).optional(), metadata: z .union([ DelayScheduledMetadata$.outboundSchema, @@ -169,15 +165,19 @@ export namespace NotificationStepVariant$ { DigestRegularMetadata$.outboundSchema, ]) .optional(), + name: z.string().optional(), replyCallback: z .lazy(() => NotificationStepVariantReplyCallback$.outboundSchema) .optional(), + shouldStopOnFail: z.boolean().optional(), + template: MessageTemplate$.outboundSchema.optional(), + uuid: z.string().optional(), }) .transform((v) => { return remap$(v, { id: "_id", - templateId: "_templateId", parentId: "_parentId", + templateId: "_templateId", }); }); } diff --git a/src/models/components/notificationtrigger.ts b/src/models/components/notificationtrigger.ts index dedb7d98..c47b1a73 100644 --- a/src/models/components/notificationtrigger.ts +++ b/src/models/components/notificationtrigger.ts @@ -15,10 +15,10 @@ export const NotificationTriggerType = { export type NotificationTriggerType = ClosedEnum; export type NotificationTrigger = { - type: NotificationTriggerType; identifier: string; - variables: Array; subscriberVariables?: Array | undefined; + type: NotificationTriggerType; + variables: Array; }; /** @internal */ @@ -30,23 +30,23 @@ export namespace NotificationTriggerType$ { /** @internal */ export namespace NotificationTrigger$ { export const inboundSchema: z.ZodType = z.object({ - type: NotificationTriggerType$.inboundSchema, identifier: z.string(), - variables: z.array(NotificationTriggerVariable$.inboundSchema), subscriberVariables: z.array(NotificationTriggerVariable$.inboundSchema).optional(), + type: NotificationTriggerType$.inboundSchema, + variables: z.array(NotificationTriggerVariable$.inboundSchema), }); export type Outbound = { - type: string; identifier: string; - variables: Array; subscriberVariables?: Array | undefined; + type: string; + variables: Array; }; export const outboundSchema: z.ZodType = z.object({ - type: NotificationTriggerType$.outboundSchema, identifier: z.string(), - variables: z.array(NotificationTriggerVariable$.outboundSchema), subscriberVariables: z.array(NotificationTriggerVariable$.outboundSchema).optional(), + type: NotificationTriggerType$.outboundSchema, + variables: z.array(NotificationTriggerVariable$.outboundSchema), }); } diff --git a/src/models/components/organizationbrandingresponsedto.ts b/src/models/components/organizationbrandingresponsedto.ts index 19dcf6e1..8851ed03 100644 --- a/src/models/components/organizationbrandingresponsedto.ts +++ b/src/models/components/organizationbrandingresponsedto.ts @@ -12,12 +12,12 @@ export const Direction = { export type Direction = ClosedEnum; export type OrganizationBrandingResponseDto = { - direction?: Direction | undefined; - logo: string; color: string; - fontColor: string; contentBackground: string; + direction?: Direction | undefined; + fontColor: string; fontFamily?: string | undefined; + logo: string; }; /** @internal */ @@ -30,21 +30,21 @@ export namespace Direction$ { export namespace OrganizationBrandingResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - direction: Direction$.inboundSchema.optional(), - logo: z.string(), color: z.string(), - fontColor: z.string(), contentBackground: z.string(), + direction: Direction$.inboundSchema.optional(), + fontColor: z.string(), fontFamily: z.string().optional(), + logo: z.string(), }); export type Outbound = { - direction?: string | undefined; - logo: string; color: string; - fontColor: string; contentBackground: string; + direction?: string | undefined; + fontColor: string; fontFamily?: string | undefined; + logo: string; }; export const outboundSchema: z.ZodType< @@ -52,11 +52,11 @@ export namespace OrganizationBrandingResponseDto$ { z.ZodTypeDef, OrganizationBrandingResponseDto > = z.object({ - direction: Direction$.outboundSchema.optional(), - logo: z.string(), color: z.string(), - fontColor: z.string(), contentBackground: z.string(), + direction: Direction$.outboundSchema.optional(), + fontColor: z.string(), fontFamily: z.string().optional(), + logo: z.string(), }); } diff --git a/src/models/components/organizationresponsedto.ts b/src/models/components/organizationresponsedto.ts index a50afc16..6aa2d562 100644 --- a/src/models/components/organizationresponsedto.ts +++ b/src/models/components/organizationresponsedto.ts @@ -13,9 +13,9 @@ import { import * as z from "zod"; export type OrganizationResponseDto = { - name: string; - logo?: string | undefined; branding: OrganizationBrandingResponseDto; + logo?: string | undefined; + name: string; partnerConfigurations?: Array | undefined; }; @@ -23,26 +23,26 @@ export type OrganizationResponseDto = { export namespace OrganizationResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - name: z.string(), - logo: z.string().optional(), branding: OrganizationBrandingResponseDto$.inboundSchema, + logo: z.string().optional(), + name: z.string(), partnerConfigurations: z .array(IPartnerConfigurationResponseDto$.inboundSchema) .optional(), }); export type Outbound = { - name: string; - logo?: string | undefined; branding: OrganizationBrandingResponseDto$.Outbound; + logo?: string | undefined; + name: string; partnerConfigurations?: Array | undefined; }; export const outboundSchema: z.ZodType = z.object({ - name: z.string(), - logo: z.string().optional(), branding: OrganizationBrandingResponseDto$.outboundSchema, + logo: z.string().optional(), + name: z.string(), partnerConfigurations: z .array(IPartnerConfigurationResponseDto$.outboundSchema) .optional(), diff --git a/src/models/components/preference.ts b/src/models/components/preference.ts index 9ac974bf..f419d702 100644 --- a/src/models/components/preference.ts +++ b/src/models/components/preference.ts @@ -6,30 +6,30 @@ import { PreferenceChannels, PreferenceChannels$ } from "./preferencechannels"; import * as z from "zod"; export type Preference = { - /** - * Sets if the workflow is fully enabled for all channels or not for the subscriber. - */ - enabled: boolean; /** * Subscriber preferences for the different channels regarding this workflow */ channels: PreferenceChannels; + /** + * Sets if the workflow is fully enabled for all channels or not for the subscriber. + */ + enabled: boolean; }; /** @internal */ export namespace Preference$ { export const inboundSchema: z.ZodType = z.object({ - enabled: z.boolean(), channels: PreferenceChannels$.inboundSchema, + enabled: z.boolean(), }); export type Outbound = { - enabled: boolean; channels: PreferenceChannels$.Outbound; + enabled: boolean; }; export const outboundSchema: z.ZodType = z.object({ - enabled: z.boolean(), channels: PreferenceChannels$.outboundSchema, + enabled: z.boolean(), }); } diff --git a/src/models/components/preferencechannels.ts b/src/models/components/preferencechannels.ts index de7ceea4..abe9c12a 100644 --- a/src/models/components/preferencechannels.ts +++ b/src/models/components/preferencechannels.ts @@ -6,22 +6,22 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type PreferenceChannels = { + chat?: boolean | undefined; email?: boolean | undefined; - sms?: boolean | undefined; inApp?: boolean | undefined; - chat?: boolean | undefined; push?: boolean | undefined; + sms?: boolean | undefined; }; /** @internal */ export namespace PreferenceChannels$ { export const inboundSchema: z.ZodType = z .object({ + chat: z.boolean().optional(), email: z.boolean().optional(), - sms: z.boolean().optional(), in_app: z.boolean().optional(), - chat: z.boolean().optional(), push: z.boolean().optional(), + sms: z.boolean().optional(), }) .transform((v) => { return remap$(v, { @@ -30,20 +30,20 @@ export namespace PreferenceChannels$ { }); export type Outbound = { + chat?: boolean | undefined; email?: boolean | undefined; - sms?: boolean | undefined; in_app?: boolean | undefined; - chat?: boolean | undefined; push?: boolean | undefined; + sms?: boolean | undefined; }; export const outboundSchema: z.ZodType = z .object({ + chat: z.boolean().optional(), email: z.boolean().optional(), - sms: z.boolean().optional(), inApp: z.boolean().optional(), - chat: z.boolean().optional(), push: z.boolean().optional(), + sms: z.boolean().optional(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/renametopicresponsedto.ts b/src/models/components/renametopicresponsedto.ts index d7109b59..5d064c7b 100644 --- a/src/models/components/renametopicresponsedto.ts +++ b/src/models/components/renametopicresponsedto.ts @@ -6,9 +6,9 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type RenameTopicResponseDto = { + environmentId: string; id?: string | undefined; organizationId: string; - environmentId: string; key: string; name: string; subscribers: Array; @@ -18,25 +18,25 @@ export type RenameTopicResponseDto = { export namespace RenameTopicResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _environmentId: z.string(), _id: z.string().optional(), _organizationId: z.string(), - _environmentId: z.string(), key: z.string(), name: z.string(), subscribers: z.array(z.string()), }) .transform((v) => { return remap$(v, { + _environmentId: "environmentId", _id: "id", _organizationId: "organizationId", - _environmentId: "environmentId", }); }); export type Outbound = { + _environmentId: string; _id?: string | undefined; _organizationId: string; - _environmentId: string; key: string; name: string; subscribers: Array; @@ -44,18 +44,18 @@ export namespace RenameTopicResponseDto$ { export const outboundSchema: z.ZodType = z .object({ + environmentId: z.string(), id: z.string().optional(), organizationId: z.string(), - environmentId: z.string(), key: z.string(), name: z.string(), subscribers: z.array(z.string()), }) .transform((v) => { return remap$(v, { + environmentId: "_environmentId", id: "_id", organizationId: "_organizationId", - environmentId: "_environmentId", }); }); } diff --git a/src/models/components/stepfilter.ts b/src/models/components/stepfilter.ts index 538ddfda..cd2ac687 100644 --- a/src/models/components/stepfilter.ts +++ b/src/models/components/stepfilter.ts @@ -6,7 +6,7 @@ import { ClosedEnum } from "../../types"; import { FieldFilterPart, FieldFilterPart$ } from "./fieldfilterpart"; import * as z from "zod"; -export const Type = { +export const StepFilterType = { Boolean: "BOOLEAN", Text: "TEXT", Date: "DATE", @@ -16,7 +16,7 @@ export const Type = { MultiList: "MULTI_LIST", Group: "GROUP", } as const; -export type Type = ClosedEnum; +export type StepFilterType = ClosedEnum; export const Value = { And: "AND", @@ -25,15 +25,15 @@ export const Value = { export type Value = ClosedEnum; export type StepFilter = { + children: Array; isNegated: boolean; - type: Type; + type: StepFilterType; value: Value; - children: Array; }; /** @internal */ -export namespace Type$ { - export const inboundSchema = z.nativeEnum(Type); +export namespace StepFilterType$ { + export const inboundSchema = z.nativeEnum(StepFilterType); export const outboundSchema = inboundSchema; } @@ -46,23 +46,23 @@ export namespace Value$ { /** @internal */ export namespace StepFilter$ { export const inboundSchema: z.ZodType = z.object({ + children: z.array(FieldFilterPart$.inboundSchema), isNegated: z.boolean(), - type: Type$.inboundSchema, + type: StepFilterType$.inboundSchema, value: Value$.inboundSchema, - children: z.array(FieldFilterPart$.inboundSchema), }); export type Outbound = { + children: Array; isNegated: boolean; type: string; value: string; - children: Array; }; export const outboundSchema: z.ZodType = z.object({ + children: z.array(FieldFilterPart$.outboundSchema), isNegated: z.boolean(), - type: Type$.outboundSchema, + type: StepFilterType$.outboundSchema, value: Value$.outboundSchema, - children: z.array(FieldFilterPart$.outboundSchema), }); } diff --git a/src/models/components/subscriberchanneldto.ts b/src/models/components/subscriberchanneldto.ts index e7d5b56e..28f0bbce 100644 --- a/src/models/components/subscriberchanneldto.ts +++ b/src/models/components/subscriberchanneldto.ts @@ -5,42 +5,44 @@ import { ChannelCredentialsDto, ChannelCredentialsDto$ } from "./channelcredentialsdto"; import * as z from "zod"; -export type ProviderId = {}; +export type SubscriberChannelDtoProviderId = {}; export type SubscriberChannelDto = { - integrationIdentifier?: string | undefined; - providerId: ProviderId; credentials: ChannelCredentialsDto; + integrationIdentifier?: string | undefined; + providerId: SubscriberChannelDtoProviderId; }; /** @internal */ -export namespace ProviderId$ { - export const inboundSchema: z.ZodType = z.object({}); +export namespace SubscriberChannelDtoProviderId$ { + export const inboundSchema: z.ZodType = + z.object({}); export type Outbound = {}; - export const outboundSchema: z.ZodType = z.object({}); + export const outboundSchema: z.ZodType = + z.object({}); } /** @internal */ export namespace SubscriberChannelDto$ { export const inboundSchema: z.ZodType = z.object({ - integrationIdentifier: z.string().optional(), - providerId: z.lazy(() => ProviderId$.inboundSchema), credentials: ChannelCredentialsDto$.inboundSchema, + integrationIdentifier: z.string().optional(), + providerId: z.lazy(() => SubscriberChannelDtoProviderId$.inboundSchema), }); export type Outbound = { - integrationIdentifier?: string | undefined; - providerId: ProviderId$.Outbound; credentials: ChannelCredentialsDto$.Outbound; + integrationIdentifier?: string | undefined; + providerId: SubscriberChannelDtoProviderId$.Outbound; }; export const outboundSchema: z.ZodType = z.object( { - integrationIdentifier: z.string().optional(), - providerId: z.lazy(() => ProviderId$.outboundSchema), credentials: ChannelCredentialsDto$.outboundSchema, + integrationIdentifier: z.string().optional(), + providerId: z.lazy(() => SubscriberChannelDtoProviderId$.outboundSchema), } ); } diff --git a/src/models/components/subscriberpayloaddto.ts b/src/models/components/subscriberpayloaddto.ts index dd737cf0..bb814d55 100644 --- a/src/models/components/subscriberpayloaddto.ts +++ b/src/models/components/subscriberpayloaddto.ts @@ -9,20 +9,20 @@ export type SubscriberPayloadDtoData = {}; export type SubscriberPayloadDto = { /** - * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems + * An http url to the profile image of your subscriber */ - subscriberId: string; + avatar?: string | undefined; + channels?: Array | undefined; + data?: SubscriberPayloadDtoData | undefined; email?: string | undefined; firstName?: string | undefined; lastName?: string | undefined; + locale?: string | undefined; phone?: string | undefined; /** - * An http url to the profile image of your subscriber + * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems */ - avatar?: string | undefined; - locale?: string | undefined; - data?: SubscriberPayloadDtoData | undefined; - channels?: Array | undefined; + subscriberId: string; }; /** @internal */ @@ -39,40 +39,40 @@ export namespace SubscriberPayloadDtoData$ { /** @internal */ export namespace SubscriberPayloadDto$ { export const inboundSchema: z.ZodType = z.object({ - subscriberId: z.string(), + avatar: z.string().optional(), + channels: z.array(SubscriberChannelDto$.inboundSchema).optional(), + data: z.lazy(() => SubscriberPayloadDtoData$.inboundSchema).optional(), email: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), - phone: z.string().optional(), - avatar: z.string().optional(), locale: z.string().optional(), - data: z.lazy(() => SubscriberPayloadDtoData$.inboundSchema).optional(), - channels: z.array(SubscriberChannelDto$.inboundSchema).optional(), + phone: z.string().optional(), + subscriberId: z.string(), }); export type Outbound = { - subscriberId: string; + avatar?: string | undefined; + channels?: Array | undefined; + data?: SubscriberPayloadDtoData$.Outbound | undefined; email?: string | undefined; firstName?: string | undefined; lastName?: string | undefined; - phone?: string | undefined; - avatar?: string | undefined; locale?: string | undefined; - data?: SubscriberPayloadDtoData$.Outbound | undefined; - channels?: Array | undefined; + phone?: string | undefined; + subscriberId: string; }; export const outboundSchema: z.ZodType = z.object( { - subscriberId: z.string(), + avatar: z.string().optional(), + channels: z.array(SubscriberChannelDto$.outboundSchema).optional(), + data: z.lazy(() => SubscriberPayloadDtoData$.outboundSchema).optional(), email: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), - phone: z.string().optional(), - avatar: z.string().optional(), locale: z.string().optional(), - data: z.lazy(() => SubscriberPayloadDtoData$.outboundSchema).optional(), - channels: z.array(SubscriberChannelDto$.outboundSchema).optional(), + phone: z.string().optional(), + subscriberId: z.string(), } ); } diff --git a/src/models/components/subscriberresponsedto.ts b/src/models/components/subscriberresponsedto.ts index a331ee3e..97ab5432 100644 --- a/src/models/components/subscriberresponsedto.ts +++ b/src/models/components/subscriberresponsedto.ts @@ -7,111 +7,111 @@ import { ChannelSettings, ChannelSettings$ } from "./channelsettings"; import * as z from "zod"; export type SubscriberResponseDto = { + v?: number | undefined; + environmentId: string; /** * The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See `subscriberId` for that */ id?: string | undefined; - firstName?: string | undefined; - lastName?: string | undefined; - email?: string | undefined; - phone?: string | undefined; + organizationId: string; avatar?: string | undefined; - locale?: string | undefined; - /** - * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems - */ - subscriberId: string; /** * Channels settings for subscriber */ channels?: Array | undefined; + createdAt: string; + deleted: boolean; + email?: string | undefined; + firstName?: string | undefined; isOnline?: boolean | undefined; + lastName?: string | undefined; lastOnlineAt?: string | undefined; - organizationId: string; - environmentId: string; - deleted: boolean; - createdAt: string; + locale?: string | undefined; + phone?: string | undefined; + /** + * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems + */ + subscriberId: string; updatedAt: string; - v?: number | undefined; }; /** @internal */ export namespace SubscriberResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + __v: z.number().optional(), + _environmentId: z.string(), _id: z.string().optional(), - firstName: z.string().optional(), - lastName: z.string().optional(), - email: z.string().optional(), - phone: z.string().optional(), + _organizationId: z.string(), avatar: z.string().optional(), - locale: z.string().optional(), - subscriberId: z.string(), channels: z.array(ChannelSettings$.inboundSchema).optional(), + createdAt: z.string(), + deleted: z.boolean(), + email: z.string().optional(), + firstName: z.string().optional(), isOnline: z.boolean().optional(), + lastName: z.string().optional(), lastOnlineAt: z.string().optional(), - _organizationId: z.string(), - _environmentId: z.string(), - deleted: z.boolean(), - createdAt: z.string(), + locale: z.string().optional(), + phone: z.string().optional(), + subscriberId: z.string(), updatedAt: z.string(), - __v: z.number().optional(), }) .transform((v) => { return remap$(v, { + __v: "v", + _environmentId: "environmentId", _id: "id", _organizationId: "organizationId", - _environmentId: "environmentId", - __v: "v", }); }); export type Outbound = { + __v?: number | undefined; + _environmentId: string; _id?: string | undefined; - firstName?: string | undefined; - lastName?: string | undefined; - email?: string | undefined; - phone?: string | undefined; + _organizationId: string; avatar?: string | undefined; - locale?: string | undefined; - subscriberId: string; channels?: Array | undefined; + createdAt: string; + deleted: boolean; + email?: string | undefined; + firstName?: string | undefined; isOnline?: boolean | undefined; + lastName?: string | undefined; lastOnlineAt?: string | undefined; - _organizationId: string; - _environmentId: string; - deleted: boolean; - createdAt: string; + locale?: string | undefined; + phone?: string | undefined; + subscriberId: string; updatedAt: string; - __v?: number | undefined; }; export const outboundSchema: z.ZodType = z .object({ + v: z.number().optional(), + environmentId: z.string(), id: z.string().optional(), - firstName: z.string().optional(), - lastName: z.string().optional(), - email: z.string().optional(), - phone: z.string().optional(), + organizationId: z.string(), avatar: z.string().optional(), - locale: z.string().optional(), - subscriberId: z.string(), channels: z.array(ChannelSettings$.outboundSchema).optional(), + createdAt: z.string(), + deleted: z.boolean(), + email: z.string().optional(), + firstName: z.string().optional(), isOnline: z.boolean().optional(), + lastName: z.string().optional(), lastOnlineAt: z.string().optional(), - organizationId: z.string(), - environmentId: z.string(), - deleted: z.boolean(), - createdAt: z.string(), + locale: z.string().optional(), + phone: z.string().optional(), + subscriberId: z.string(), updatedAt: z.string(), - v: z.number().optional(), }) .transform((v) => { return remap$(v, { + v: "__v", + environmentId: "_environmentId", id: "_id", organizationId: "_organizationId", - environmentId: "_environmentId", - v: "__v", }); }); } diff --git a/src/models/components/templateresponse.ts b/src/models/components/templateresponse.ts index ba726a10..40ae1e30 100644 --- a/src/models/components/templateresponse.ts +++ b/src/models/components/templateresponse.ts @@ -10,14 +10,14 @@ export type TemplateResponse = { * Unique identifier of the workflow */ id: string; - /** - * Name of the workflow - */ - name: string; /** * Critical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen */ critical: boolean; + /** + * Name of the workflow + */ + name: string; /** * Triggers are the events that will trigger the workflow. */ @@ -29,8 +29,8 @@ export namespace TemplateResponse$ { export const inboundSchema: z.ZodType = z .object({ _id: z.string(), - name: z.string(), critical: z.boolean(), + name: z.string(), triggers: z.array(z.string()), }) .transform((v) => { @@ -41,16 +41,16 @@ export namespace TemplateResponse$ { export type Outbound = { _id: string; - name: string; critical: boolean; + name: string; triggers: Array; }; export const outboundSchema: z.ZodType = z .object({ id: z.string(), - name: z.string(), critical: z.boolean(), + name: z.string(), triggers: z.array(z.string()), }) .transform((v) => { diff --git a/src/models/components/tenantpayloaddto.ts b/src/models/components/tenantpayloaddto.ts index ba45969f..b15bcf56 100644 --- a/src/models/components/tenantpayloaddto.ts +++ b/src/models/components/tenantpayloaddto.ts @@ -7,9 +7,9 @@ import * as z from "zod"; export type TenantPayloadDtoData = {}; export type TenantPayloadDto = { + data?: TenantPayloadDtoData | undefined; identifier?: string | undefined; name?: string | undefined; - data?: TenantPayloadDtoData | undefined; }; /** @internal */ @@ -28,20 +28,20 @@ export namespace TenantPayloadDtoData$ { /** @internal */ export namespace TenantPayloadDto$ { export const inboundSchema: z.ZodType = z.object({ + data: z.lazy(() => TenantPayloadDtoData$.inboundSchema).optional(), identifier: z.string().optional(), name: z.string().optional(), - data: z.lazy(() => TenantPayloadDtoData$.inboundSchema).optional(), }); export type Outbound = { + data?: TenantPayloadDtoData$.Outbound | undefined; identifier?: string | undefined; name?: string | undefined; - data?: TenantPayloadDtoData$.Outbound | undefined; }; export const outboundSchema: z.ZodType = z.object({ + data: z.lazy(() => TenantPayloadDtoData$.outboundSchema).optional(), identifier: z.string().optional(), name: z.string().optional(), - data: z.lazy(() => TenantPayloadDtoData$.outboundSchema).optional(), }); } diff --git a/src/models/components/timedconfig.ts b/src/models/components/timedconfig.ts index 2755f44b..55df116e 100644 --- a/src/models/components/timedconfig.ts +++ b/src/models/components/timedconfig.ts @@ -5,16 +5,11 @@ import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const WeekDays = { - Monday: "monday", - Tuesday: "tuesday", - Wednesday: "wednesday", - Thursday: "thursday", - Friday: "friday", - Saturday: "saturday", - Sunday: "sunday", +export const MonthlyType = { + Each: "each", + On: "on", } as const; -export type WeekDays = ClosedEnum; +export type MonthlyType = ClosedEnum; export const Ordinal = { One: "1", @@ -40,24 +35,29 @@ export const OrdinalValue = { } as const; export type OrdinalValue = ClosedEnum; -export const MonthlyType = { - Each: "each", - On: "on", +export const WeekDays = { + Monday: "monday", + Tuesday: "tuesday", + Wednesday: "wednesday", + Thursday: "thursday", + Friday: "friday", + Saturday: "saturday", + Sunday: "sunday", } as const; -export type MonthlyType = ClosedEnum; +export type WeekDays = ClosedEnum; export type TimedConfig = { atTime?: string | undefined; - weekDays?: Array | undefined; monthDays?: Array | undefined; + monthlyType?: MonthlyType | undefined; ordinal?: Ordinal | undefined; ordinalValue?: OrdinalValue | undefined; - monthlyType?: MonthlyType | undefined; + weekDays?: Array | undefined; }; /** @internal */ -export namespace WeekDays$ { - export const inboundSchema = z.nativeEnum(WeekDays); +export namespace MonthlyType$ { + export const inboundSchema = z.nativeEnum(MonthlyType); export const outboundSchema = inboundSchema; } @@ -74,8 +74,8 @@ export namespace OrdinalValue$ { } /** @internal */ -export namespace MonthlyType$ { - export const inboundSchema = z.nativeEnum(MonthlyType); +export namespace WeekDays$ { + export const inboundSchema = z.nativeEnum(WeekDays); export const outboundSchema = inboundSchema; } @@ -83,28 +83,28 @@ export namespace MonthlyType$ { export namespace TimedConfig$ { export const inboundSchema: z.ZodType = z.object({ atTime: z.string().optional(), - weekDays: z.array(WeekDays$.inboundSchema).optional(), monthDays: z.array(z.string()).optional(), + monthlyType: MonthlyType$.inboundSchema.optional(), ordinal: Ordinal$.inboundSchema.optional(), ordinalValue: OrdinalValue$.inboundSchema.optional(), - monthlyType: MonthlyType$.inboundSchema.optional(), + weekDays: z.array(WeekDays$.inboundSchema).optional(), }); export type Outbound = { atTime?: string | undefined; - weekDays?: Array | undefined; monthDays?: Array | undefined; + monthlyType?: string | undefined; ordinal?: string | undefined; ordinalValue?: string | undefined; - monthlyType?: string | undefined; + weekDays?: Array | undefined; }; export const outboundSchema: z.ZodType = z.object({ atTime: z.string().optional(), - weekDays: z.array(WeekDays$.outboundSchema).optional(), monthDays: z.array(z.string()).optional(), + monthlyType: MonthlyType$.outboundSchema.optional(), ordinal: Ordinal$.outboundSchema.optional(), ordinalValue: OrdinalValue$.outboundSchema.optional(), - monthlyType: MonthlyType$.outboundSchema.optional(), + weekDays: z.array(WeekDays$.outboundSchema).optional(), }); } diff --git a/src/models/components/topicdto.ts b/src/models/components/topicdto.ts index bf1e95d8..d7163072 100644 --- a/src/models/components/topicdto.ts +++ b/src/models/components/topicdto.ts @@ -6,9 +6,9 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type TopicDto = { + environmentId: string; id?: string | undefined; organizationId: string; - environmentId: string; key: string; name: string; subscribers: Array; @@ -18,25 +18,25 @@ export type TopicDto = { export namespace TopicDto$ { export const inboundSchema: z.ZodType = z .object({ + _environmentId: z.string(), _id: z.string().optional(), _organizationId: z.string(), - _environmentId: z.string(), key: z.string(), name: z.string(), subscribers: z.array(z.string()), }) .transform((v) => { return remap$(v, { + _environmentId: "environmentId", _id: "id", _organizationId: "organizationId", - _environmentId: "environmentId", }); }); export type Outbound = { + _environmentId: string; _id?: string | undefined; _organizationId: string; - _environmentId: string; key: string; name: string; subscribers: Array; @@ -44,18 +44,18 @@ export namespace TopicDto$ { export const outboundSchema: z.ZodType = z .object({ + environmentId: z.string(), id: z.string().optional(), organizationId: z.string(), - environmentId: z.string(), key: z.string(), name: z.string(), subscribers: z.array(z.string()), }) .transform((v) => { return remap$(v, { + environmentId: "_environmentId", id: "_id", organizationId: "_organizationId", - environmentId: "_environmentId", }); }); } diff --git a/src/models/components/topicsubscriberdto.ts b/src/models/components/topicsubscriberdto.ts index 21424613..e13bf021 100644 --- a/src/models/components/topicsubscriberdto.ts +++ b/src/models/components/topicsubscriberdto.ts @@ -6,56 +6,56 @@ import { remap as remap$ } from "../../lib/primitives"; import * as z from "zod"; export type TopicSubscriberDto = { - organizationId: string; environmentId: string; + organizationId: string; subscriberId: string; topicId: string; - topicKey: string; externalSubscriberId: string; + topicKey: string; }; /** @internal */ export namespace TopicSubscriberDto$ { export const inboundSchema: z.ZodType = z .object({ - _organizationId: z.string(), _environmentId: z.string(), + _organizationId: z.string(), _subscriberId: z.string(), _topicId: z.string(), - topicKey: z.string(), externalSubscriberId: z.string(), + topicKey: z.string(), }) .transform((v) => { return remap$(v, { - _organizationId: "organizationId", _environmentId: "environmentId", + _organizationId: "organizationId", _subscriberId: "subscriberId", _topicId: "topicId", }); }); export type Outbound = { - _organizationId: string; _environmentId: string; + _organizationId: string; _subscriberId: string; _topicId: string; - topicKey: string; externalSubscriberId: string; + topicKey: string; }; export const outboundSchema: z.ZodType = z .object({ - organizationId: z.string(), environmentId: z.string(), + organizationId: z.string(), subscriberId: z.string(), topicId: z.string(), - topicKey: z.string(), externalSubscriberId: z.string(), + topicKey: z.string(), }) .transform((v) => { return remap$(v, { - organizationId: "_organizationId", environmentId: "_environmentId", + organizationId: "_organizationId", subscriberId: "_subscriberId", topicId: "_topicId", }); diff --git a/src/models/components/triggereventrequestdto.ts b/src/models/components/triggereventrequestdto.ts index 820a5b86..1ecba9ed 100644 --- a/src/models/components/triggereventrequestdto.ts +++ b/src/models/components/triggereventrequestdto.ts @@ -8,28 +8,26 @@ import { TopicPayloadDto, TopicPayloadDto$ } from "./topicpayloaddto"; import * as z from "zod"; /** - * The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. + * It is used to display the Avatar of the provided actor's subscriber id or actor object. * * @remarks - * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. + * If a new actor object is provided, we will create a new subscriber in our system + * */ -export type Payload = {}; +export type Actor = SubscriberPayloadDto | string; /** * This could be used to override provider specific configurations */ -export type Overrides = {}; - -export type To = TopicPayloadDto | SubscriberPayloadDto | string; +export type TriggerEventRequestDtoOverrides = {}; /** - * It is used to display the Avatar of the provided actor's subscriber id or actor object. + * The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. * * @remarks - * If a new actor object is provided, we will create a new subscriber in our system - * + * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. */ -export type Actor = SubscriberPayloadDto | string; +export type TriggerEventRequestDtoPayload = {}; /** * It is used to specify a tenant context during trigger event. @@ -40,38 +38,32 @@ export type Actor = SubscriberPayloadDto | string; */ export type Tenant = TenantPayloadDto | string; +export type To = TopicPayloadDto | SubscriberPayloadDto | string; + export type TriggerEventRequestDto = { /** - * The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page. - */ - name: string; - /** - * The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. + * It is used to display the Avatar of the provided actor's subscriber id or actor object. * * @remarks - * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. - */ - payload?: Payload | undefined; - /** - * This could be used to override provider specific configurations + * If a new actor object is provided, we will create a new subscriber in our system + * */ - overrides?: Overrides | undefined; + actor?: SubscriberPayloadDto | string | undefined; /** - * The recipients list of people who will receive the notification. + * The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page. */ - to: Array; + name: string; /** - * A unique identifier for this transaction, we will generated a UUID if not provided. + * This could be used to override provider specific configurations */ - transactionId?: string | undefined; + overrides?: TriggerEventRequestDtoOverrides | undefined; /** - * It is used to display the Avatar of the provided actor's subscriber id or actor object. + * The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. * * @remarks - * If a new actor object is provided, we will create a new subscriber in our system - * + * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. */ - actor?: SubscriberPayloadDto | string | undefined; + payload?: TriggerEventRequestDtoPayload | undefined; /** * It is used to specify a tenant context during trigger event. * @@ -80,66 +72,81 @@ export type TriggerEventRequestDto = { * */ tenant?: TenantPayloadDto | string | undefined; + /** + * The recipients list of people who will receive the notification. + */ + to: Array; + /** + * A unique identifier for this transaction, we will generated a UUID if not provided. + */ + transactionId?: string | undefined; }; /** @internal */ -export namespace Payload$ { - export const inboundSchema: z.ZodType = z.object({}); - - export type Outbound = {}; +export namespace Actor$ { + export const inboundSchema: z.ZodType = z.union([ + SubscriberPayloadDto$.inboundSchema, + z.string(), + ]); - export const outboundSchema: z.ZodType = z.object({}); + export type Outbound = SubscriberPayloadDto$.Outbound | string; + export const outboundSchema: z.ZodType = z.union([ + SubscriberPayloadDto$.outboundSchema, + z.string(), + ]); } /** @internal */ -export namespace Overrides$ { - export const inboundSchema: z.ZodType = z.object({}); +export namespace TriggerEventRequestDtoOverrides$ { + export const inboundSchema: z.ZodType = + z.object({}); export type Outbound = {}; - export const outboundSchema: z.ZodType = z.object({}); + export const outboundSchema: z.ZodType< + Outbound, + z.ZodTypeDef, + TriggerEventRequestDtoOverrides + > = z.object({}); } /** @internal */ -export namespace To$ { - export const inboundSchema: z.ZodType = z.union([ - TopicPayloadDto$.inboundSchema, - SubscriberPayloadDto$.inboundSchema, - z.string(), - ]); +export namespace TriggerEventRequestDtoPayload$ { + export const inboundSchema: z.ZodType = + z.object({}); - export type Outbound = TopicPayloadDto$.Outbound | SubscriberPayloadDto$.Outbound | string; - export const outboundSchema: z.ZodType = z.union([ - TopicPayloadDto$.outboundSchema, - SubscriberPayloadDto$.outboundSchema, - z.string(), - ]); + export type Outbound = {}; + + export const outboundSchema: z.ZodType = + z.object({}); } /** @internal */ -export namespace Actor$ { - export const inboundSchema: z.ZodType = z.union([ - SubscriberPayloadDto$.inboundSchema, +export namespace Tenant$ { + export const inboundSchema: z.ZodType = z.union([ + TenantPayloadDto$.inboundSchema, z.string(), ]); - export type Outbound = SubscriberPayloadDto$.Outbound | string; - export const outboundSchema: z.ZodType = z.union([ - SubscriberPayloadDto$.outboundSchema, + export type Outbound = TenantPayloadDto$.Outbound | string; + export const outboundSchema: z.ZodType = z.union([ + TenantPayloadDto$.outboundSchema, z.string(), ]); } /** @internal */ -export namespace Tenant$ { - export const inboundSchema: z.ZodType = z.union([ - TenantPayloadDto$.inboundSchema, +export namespace To$ { + export const inboundSchema: z.ZodType = z.union([ + TopicPayloadDto$.inboundSchema, + SubscriberPayloadDto$.inboundSchema, z.string(), ]); - export type Outbound = TenantPayloadDto$.Outbound | string; - export const outboundSchema: z.ZodType = z.union([ - TenantPayloadDto$.outboundSchema, + export type Outbound = TopicPayloadDto$.Outbound | SubscriberPayloadDto$.Outbound | string; + export const outboundSchema: z.ZodType = z.union([ + TopicPayloadDto$.outboundSchema, + SubscriberPayloadDto$.outboundSchema, z.string(), ]); } @@ -148,9 +155,11 @@ export namespace Tenant$ { export namespace TriggerEventRequestDto$ { export const inboundSchema: z.ZodType = z.object( { + actor: z.union([SubscriberPayloadDto$.inboundSchema, z.string()]).optional(), name: z.string(), - payload: z.lazy(() => Payload$.inboundSchema).optional(), - overrides: z.lazy(() => Overrides$.inboundSchema).optional(), + overrides: z.lazy(() => TriggerEventRequestDtoOverrides$.inboundSchema).optional(), + payload: z.lazy(() => TriggerEventRequestDtoPayload$.inboundSchema).optional(), + tenant: z.union([TenantPayloadDto$.inboundSchema, z.string()]).optional(), to: z.array( z.union([ TopicPayloadDto$.inboundSchema, @@ -159,26 +168,26 @@ export namespace TriggerEventRequestDto$ { ]) ), transactionId: z.string().optional(), - actor: z.union([SubscriberPayloadDto$.inboundSchema, z.string()]).optional(), - tenant: z.union([TenantPayloadDto$.inboundSchema, z.string()]).optional(), } ); export type Outbound = { + actor?: SubscriberPayloadDto$.Outbound | string | undefined; name: string; - payload?: Payload$.Outbound | undefined; - overrides?: Overrides$.Outbound | undefined; + overrides?: TriggerEventRequestDtoOverrides$.Outbound | undefined; + payload?: TriggerEventRequestDtoPayload$.Outbound | undefined; + tenant?: TenantPayloadDto$.Outbound | string | undefined; to: Array; transactionId?: string | undefined; - actor?: SubscriberPayloadDto$.Outbound | string | undefined; - tenant?: TenantPayloadDto$.Outbound | string | undefined; }; export const outboundSchema: z.ZodType = z.object({ + actor: z.union([SubscriberPayloadDto$.outboundSchema, z.string()]).optional(), name: z.string(), - payload: z.lazy(() => Payload$.outboundSchema).optional(), - overrides: z.lazy(() => Overrides$.outboundSchema).optional(), + overrides: z.lazy(() => TriggerEventRequestDtoOverrides$.outboundSchema).optional(), + payload: z.lazy(() => TriggerEventRequestDtoPayload$.outboundSchema).optional(), + tenant: z.union([TenantPayloadDto$.outboundSchema, z.string()]).optional(), to: z.array( z.union([ TopicPayloadDto$.outboundSchema, @@ -187,7 +196,5 @@ export namespace TriggerEventRequestDto$ { ]) ), transactionId: z.string().optional(), - actor: z.union([SubscriberPayloadDto$.outboundSchema, z.string()]).optional(), - tenant: z.union([TenantPayloadDto$.outboundSchema, z.string()]).optional(), }); } diff --git a/src/models/components/triggereventresponsedto.ts b/src/models/components/triggereventresponsedto.ts index e594bf0f..0b672f47 100644 --- a/src/models/components/triggereventresponsedto.ts +++ b/src/models/components/triggereventresponsedto.ts @@ -27,14 +27,14 @@ export type TriggerEventResponseDto = { * If trigger was acknowledged or not */ acknowledged: boolean; - /** - * Status for trigger - */ - status: TriggerEventResponseDtoStatus; /** * In case of an error, this field will contain the error message */ error?: Array | undefined; + /** + * Status for trigger + */ + status: TriggerEventResponseDtoStatus; /** * Transaction id for trigger */ @@ -52,23 +52,23 @@ export namespace TriggerEventResponseDto$ { export const inboundSchema: z.ZodType = z.object({ acknowledged: z.boolean(), - status: TriggerEventResponseDtoStatus$.inboundSchema, error: z.array(z.string()).optional(), + status: TriggerEventResponseDtoStatus$.inboundSchema, transactionId: z.string().optional(), }); export type Outbound = { acknowledged: boolean; - status: string; error?: Array | undefined; + status: string; transactionId?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ acknowledged: z.boolean(), - status: TriggerEventResponseDtoStatus$.outboundSchema, error: z.array(z.string()).optional(), + status: TriggerEventResponseDtoStatus$.outboundSchema, transactionId: z.string().optional(), }); } diff --git a/src/models/components/triggereventtoallrequestdto.ts b/src/models/components/triggereventtoallrequestdto.ts index 64f666ae..4ef23da3 100644 --- a/src/models/components/triggereventtoallrequestdto.ts +++ b/src/models/components/triggereventtoallrequestdto.ts @@ -7,12 +7,13 @@ import { TenantPayloadDto, TenantPayloadDto$ } from "./tenantpayloaddto"; import * as z from "zod"; /** - * The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. + * It is used to display the Avatar of the provided actor's subscriber id or actor object. * * @remarks - * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. + * If a new actor object is provided, we will create a new subscriber in our system + * */ -export type TriggerEventToAllRequestDtoPayload = {}; +export type TriggerEventToAllRequestDtoActor = SubscriberPayloadDto | string; /** * This could be used to override provider specific configurations @@ -20,13 +21,12 @@ export type TriggerEventToAllRequestDtoPayload = {}; export type TriggerEventToAllRequestDtoOverrides = {}; /** - * It is used to display the Avatar of the provided actor's subscriber id or actor object. + * The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. * * @remarks - * If a new actor object is provided, we will create a new subscriber in our system - * + * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. */ -export type TriggerEventToAllRequestDtoActor = SubscriberPayloadDto | string; +export type TriggerEventToAllRequestDtoPayload = {}; /** * It is used to specify a tenant context during trigger event. @@ -39,32 +39,28 @@ export type TriggerEventToAllRequestDtoTenant = TenantPayloadDto | string; export type TriggerEventToAllRequestDto = { /** - * The trigger identifier associated for the template you wish to send. This identifier can be found on the template page. - */ - name: string; - /** - * The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. + * It is used to display the Avatar of the provided actor's subscriber id or actor object. * * @remarks - * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. + * If a new actor object is provided, we will create a new subscriber in our system + * */ - payload: TriggerEventToAllRequestDtoPayload; + actor?: SubscriberPayloadDto | string | undefined; /** - * This could be used to override provider specific configurations + * The trigger identifier associated for the template you wish to send. This identifier can be found on the template page. */ - overrides?: TriggerEventToAllRequestDtoOverrides | undefined; + name: string; /** - * A unique identifier for this transaction, we will generated a UUID if not provided. + * This could be used to override provider specific configurations */ - transactionId?: string | undefined; + overrides?: TriggerEventToAllRequestDtoOverrides | undefined; /** - * It is used to display the Avatar of the provided actor's subscriber id or actor object. + * The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. * * @remarks - * If a new actor object is provided, we will create a new subscriber in our system - * + * This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. */ - actor?: SubscriberPayloadDto | string | undefined; + payload: TriggerEventToAllRequestDtoPayload; /** * It is used to specify a tenant context during trigger event. * @@ -73,23 +69,23 @@ export type TriggerEventToAllRequestDto = { * */ tenant?: TenantPayloadDto | string | undefined; + /** + * A unique identifier for this transaction, we will generated a UUID if not provided. + */ + transactionId?: string | undefined; }; /** @internal */ -export namespace TriggerEventToAllRequestDtoPayload$ { - export const inboundSchema: z.ZodType< - TriggerEventToAllRequestDtoPayload, - z.ZodTypeDef, - unknown - > = z.object({}); - - export type Outbound = {}; +export namespace TriggerEventToAllRequestDtoActor$ { + export const inboundSchema: z.ZodType = + z.union([SubscriberPayloadDto$.inboundSchema, z.string()]); + export type Outbound = SubscriberPayloadDto$.Outbound | string; export const outboundSchema: z.ZodType< Outbound, z.ZodTypeDef, - TriggerEventToAllRequestDtoPayload - > = z.object({}); + TriggerEventToAllRequestDtoActor + > = z.union([SubscriberPayloadDto$.outboundSchema, z.string()]); } /** @internal */ @@ -110,16 +106,20 @@ export namespace TriggerEventToAllRequestDtoOverrides$ { } /** @internal */ -export namespace TriggerEventToAllRequestDtoActor$ { - export const inboundSchema: z.ZodType = - z.union([SubscriberPayloadDto$.inboundSchema, z.string()]); +export namespace TriggerEventToAllRequestDtoPayload$ { + export const inboundSchema: z.ZodType< + TriggerEventToAllRequestDtoPayload, + z.ZodTypeDef, + unknown + > = z.object({}); + + export type Outbound = {}; - export type Outbound = SubscriberPayloadDto$.Outbound | string; export const outboundSchema: z.ZodType< Outbound, z.ZodTypeDef, - TriggerEventToAllRequestDtoActor - > = z.union([SubscriberPayloadDto$.outboundSchema, z.string()]); + TriggerEventToAllRequestDtoPayload + > = z.object({}); } /** @internal */ @@ -142,32 +142,32 @@ export namespace TriggerEventToAllRequestDtoTenant$ { export namespace TriggerEventToAllRequestDto$ { export const inboundSchema: z.ZodType = z.object({ + actor: z.union([SubscriberPayloadDto$.inboundSchema, z.string()]).optional(), name: z.string(), - payload: z.lazy(() => TriggerEventToAllRequestDtoPayload$.inboundSchema), overrides: z.lazy(() => TriggerEventToAllRequestDtoOverrides$.inboundSchema).optional(), - transactionId: z.string().optional(), - actor: z.union([SubscriberPayloadDto$.inboundSchema, z.string()]).optional(), + payload: z.lazy(() => TriggerEventToAllRequestDtoPayload$.inboundSchema), tenant: z.union([TenantPayloadDto$.inboundSchema, z.string()]).optional(), + transactionId: z.string().optional(), }); export type Outbound = { + actor?: SubscriberPayloadDto$.Outbound | string | undefined; name: string; - payload: TriggerEventToAllRequestDtoPayload$.Outbound; overrides?: TriggerEventToAllRequestDtoOverrides$.Outbound | undefined; - transactionId?: string | undefined; - actor?: SubscriberPayloadDto$.Outbound | string | undefined; + payload: TriggerEventToAllRequestDtoPayload$.Outbound; tenant?: TenantPayloadDto$.Outbound | string | undefined; + transactionId?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ + actor: z.union([SubscriberPayloadDto$.outboundSchema, z.string()]).optional(), name: z.string(), - payload: z.lazy(() => TriggerEventToAllRequestDtoPayload$.outboundSchema), overrides: z .lazy(() => TriggerEventToAllRequestDtoOverrides$.outboundSchema) .optional(), - transactionId: z.string().optional(), - actor: z.union([SubscriberPayloadDto$.outboundSchema, z.string()]).optional(), + payload: z.lazy(() => TriggerEventToAllRequestDtoPayload$.outboundSchema), tenant: z.union([TenantPayloadDto$.outboundSchema, z.string()]).optional(), + transactionId: z.string().optional(), }); } diff --git a/src/models/components/updatebrandingdetailsdto.ts b/src/models/components/updatebrandingdetailsdto.ts index e8a6f345..044d5abd 100644 --- a/src/models/components/updatebrandingdetailsdto.ts +++ b/src/models/components/updatebrandingdetailsdto.ts @@ -5,38 +5,38 @@ import * as z from "zod"; export type UpdateBrandingDetailsDto = { - logo: string; color: string; - fontColor: string; contentBackground: string; + fontColor: string; fontFamily?: string | undefined; + logo: string; }; /** @internal */ export namespace UpdateBrandingDetailsDto$ { export const inboundSchema: z.ZodType = z.object({ - logo: z.string(), color: z.string(), - fontColor: z.string(), contentBackground: z.string(), + fontColor: z.string(), fontFamily: z.string().optional(), + logo: z.string(), }); export type Outbound = { - logo: string; color: string; - fontColor: string; contentBackground: string; + fontColor: string; fontFamily?: string | undefined; + logo: string; }; export const outboundSchema: z.ZodType = z.object({ - logo: z.string(), color: z.string(), - fontColor: z.string(), contentBackground: z.string(), + fontColor: z.string(), fontFamily: z.string().optional(), + logo: z.string(), }); } diff --git a/src/models/components/updateintegrationrequestdto.ts b/src/models/components/updateintegrationrequestdto.ts index 8bf53e87..45214f20 100644 --- a/src/models/components/updateintegrationrequestdto.ts +++ b/src/models/components/updateintegrationrequestdto.ts @@ -8,29 +8,29 @@ import { StepFilter, StepFilter$ } from "./stepfilter"; import * as z from "zod"; export type UpdateIntegrationRequestDto = { - name?: string | undefined; - identifier?: string | undefined; environmentId?: string | undefined; /** * If the integration is active the validation on the credentials field will run */ active?: boolean | undefined; - credentials?: CredentialsDto | undefined; check?: boolean | undefined; conditions?: Array | undefined; + credentials?: CredentialsDto | undefined; + identifier?: string | undefined; + name?: string | undefined; }; /** @internal */ export namespace UpdateIntegrationRequestDto$ { export const inboundSchema: z.ZodType = z .object({ - name: z.string().optional(), - identifier: z.string().optional(), _environmentId: z.string().optional(), active: z.boolean().optional(), - credentials: CredentialsDto$.inboundSchema.optional(), check: z.boolean().optional(), conditions: z.array(StepFilter$.inboundSchema).optional(), + credentials: CredentialsDto$.inboundSchema.optional(), + identifier: z.string().optional(), + name: z.string().optional(), }) .transform((v) => { return remap$(v, { @@ -39,24 +39,24 @@ export namespace UpdateIntegrationRequestDto$ { }); export type Outbound = { - name?: string | undefined; - identifier?: string | undefined; _environmentId?: string | undefined; active?: boolean | undefined; - credentials?: CredentialsDto$.Outbound | undefined; check?: boolean | undefined; conditions?: Array | undefined; + credentials?: CredentialsDto$.Outbound | undefined; + identifier?: string | undefined; + name?: string | undefined; }; export const outboundSchema: z.ZodType = z .object({ - name: z.string().optional(), - identifier: z.string().optional(), environmentId: z.string().optional(), active: z.boolean().optional(), - credentials: CredentialsDto$.outboundSchema.optional(), check: z.boolean().optional(), conditions: z.array(StepFilter$.outboundSchema).optional(), + credentials: CredentialsDto$.outboundSchema.optional(), + identifier: z.string().optional(), + name: z.string().optional(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/updatelayoutrequestdto.ts b/src/models/components/updatelayoutrequestdto.ts index 6b2171f4..0e56677f 100644 --- a/src/models/components/updatelayoutrequestdto.ts +++ b/src/models/components/updatelayoutrequestdto.ts @@ -8,29 +8,29 @@ export type UpdateLayoutRequestDtoVariables = {}; export type UpdateLayoutRequestDto = { /** - * User defined custom name and provided by the user that will name the Layout updated. + * User defined content for the layout. */ - name?: string | undefined; + content?: string | undefined; + /** + * User defined description of the layout + */ + description?: string | undefined; /** * User defined custom key that will be a unique identifier for the Layout updated. */ identifier: string; /** - * User defined description of the layout + * Variable that defines if the layout is chosen as default when creating a layout. */ - description?: string | undefined; + isDefault?: boolean | undefined; /** - * User defined content for the layout. + * User defined custom name and provided by the user that will name the Layout updated. */ - content?: string | undefined; + name?: string | undefined; /** * User defined variables to render in the layout placeholders. */ variables?: Array | undefined; - /** - * Variable that defines if the layout is chosen as default when creating a layout. - */ - isDefault?: boolean | undefined; }; /** @internal */ @@ -51,35 +51,35 @@ export namespace UpdateLayoutRequestDtoVariables$ { export namespace UpdateLayoutRequestDto$ { export const inboundSchema: z.ZodType = z.object( { - name: z.string().optional(), - identifier: z.string(), - description: z.string().optional(), content: z.string().optional(), + description: z.string().optional(), + identifier: z.string(), + isDefault: z.boolean().optional(), + name: z.string().optional(), variables: z .array(z.lazy(() => UpdateLayoutRequestDtoVariables$.inboundSchema)) .optional(), - isDefault: z.boolean().optional(), } ); export type Outbound = { - name?: string | undefined; - identifier: string; - description?: string | undefined; content?: string | undefined; - variables?: Array | undefined; + description?: string | undefined; + identifier: string; isDefault?: boolean | undefined; + name?: string | undefined; + variables?: Array | undefined; }; export const outboundSchema: z.ZodType = z.object({ - name: z.string().optional(), - identifier: z.string(), - description: z.string().optional(), content: z.string().optional(), + description: z.string().optional(), + identifier: z.string(), + isDefault: z.boolean().optional(), + name: z.string().optional(), variables: z .array(z.lazy(() => UpdateLayoutRequestDtoVariables$.outboundSchema)) .optional(), - isDefault: z.boolean().optional(), }); } diff --git a/src/models/components/updatelayoutresponsedto.ts b/src/models/components/updatelayoutresponsedto.ts index e0fcc9e6..618129eb 100644 --- a/src/models/components/updatelayoutresponsedto.ts +++ b/src/models/components/updatelayoutresponsedto.ts @@ -18,22 +18,22 @@ export type UpdateLayoutResponseDtoChannel = ClosedEnum | undefined; + createdAt?: string | undefined; + description?: string | undefined; + identifier: string; isDefault: boolean; isDeleted: boolean; - createdAt?: string | undefined; + name: string; updatedAt?: string | undefined; - parentId?: string | undefined; + variables?: Array | undefined; }; /** @internal */ @@ -60,81 +60,81 @@ export namespace UpdateLayoutResponseDtoVariables$ { export namespace UpdateLayoutResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _creatorId: z.string(), + _environmentId: z.string(), _id: z.string().optional(), _organizationId: z.string(), - _environmentId: z.string(), - _creatorId: z.string(), - name: z.string(), - identifier: z.string(), - description: z.string().optional(), + _parentId: z.string().optional(), channel: UpdateLayoutResponseDtoChannel$.inboundSchema, content: z.string(), contentType: z.string(), - variables: z - .array(z.lazy(() => UpdateLayoutResponseDtoVariables$.inboundSchema)) - .optional(), + createdAt: z.string().optional(), + description: z.string().optional(), + identifier: z.string(), isDefault: z.boolean(), isDeleted: z.boolean(), - createdAt: z.string().optional(), + name: z.string(), updatedAt: z.string().optional(), - _parentId: z.string().optional(), + variables: z + .array(z.lazy(() => UpdateLayoutResponseDtoVariables$.inboundSchema)) + .optional(), }) .transform((v) => { return remap$(v, { + _creatorId: "creatorId", + _environmentId: "environmentId", _id: "id", _organizationId: "organizationId", - _environmentId: "environmentId", - _creatorId: "creatorId", _parentId: "parentId", }); }); export type Outbound = { + _creatorId: string; + _environmentId: string; _id?: string | undefined; _organizationId: string; - _environmentId: string; - _creatorId: string; - name: string; - identifier: string; - description?: string | undefined; + _parentId?: string | undefined; channel: string; content: string; contentType: string; - variables?: Array | undefined; + createdAt?: string | undefined; + description?: string | undefined; + identifier: string; isDefault: boolean; isDeleted: boolean; - createdAt?: string | undefined; + name: string; updatedAt?: string | undefined; - _parentId?: string | undefined; + variables?: Array | undefined; }; export const outboundSchema: z.ZodType = z .object({ + creatorId: z.string(), + environmentId: z.string(), id: z.string().optional(), organizationId: z.string(), - environmentId: z.string(), - creatorId: z.string(), - name: z.string(), - identifier: z.string(), - description: z.string().optional(), + parentId: z.string().optional(), channel: UpdateLayoutResponseDtoChannel$.outboundSchema, content: z.string(), contentType: z.string(), - variables: z - .array(z.lazy(() => UpdateLayoutResponseDtoVariables$.outboundSchema)) - .optional(), + createdAt: z.string().optional(), + description: z.string().optional(), + identifier: z.string(), isDefault: z.boolean(), isDeleted: z.boolean(), - createdAt: z.string().optional(), + name: z.string(), updatedAt: z.string().optional(), - parentId: z.string().optional(), + variables: z + .array(z.lazy(() => UpdateLayoutResponseDtoVariables$.outboundSchema)) + .optional(), }) .transform((v) => { return remap$(v, { + creatorId: "_creatorId", + environmentId: "_environmentId", id: "_id", organizationId: "_organizationId", - environmentId: "_environmentId", - creatorId: "_creatorId", parentId: "_parentId", }); }); diff --git a/src/models/components/updatesubscriberchannelrequestdto.ts b/src/models/components/updatesubscriberchannelrequestdto.ts index 8659cc4c..3780104a 100644 --- a/src/models/components/updatesubscriberchannelrequestdto.ts +++ b/src/models/components/updatesubscriberchannelrequestdto.ts @@ -37,17 +37,17 @@ export type UpdateSubscriberChannelRequestDtoProviderId = ClosedEnum< export type UpdateSubscriberChannelRequestDto = { /** - * The provider identifier for the credentials + * Credentials payload for the specified provider */ - providerId: UpdateSubscriberChannelRequestDtoProviderId; + credentials: ChannelCredentials; /** * The integration identifier */ integrationIdentifier?: string | undefined; /** - * Credentials payload for the specified provider + * The provider identifier for the credentials */ - credentials: ChannelCredentials; + providerId: UpdateSubscriberChannelRequestDtoProviderId; }; /** @internal */ @@ -63,15 +63,15 @@ export namespace UpdateSubscriberChannelRequestDto$ { z.ZodTypeDef, unknown > = z.object({ - providerId: UpdateSubscriberChannelRequestDtoProviderId$.inboundSchema, - integrationIdentifier: z.string().optional(), credentials: ChannelCredentials$.inboundSchema, + integrationIdentifier: z.string().optional(), + providerId: UpdateSubscriberChannelRequestDtoProviderId$.inboundSchema, }); export type Outbound = { - providerId: string; - integrationIdentifier?: string | undefined; credentials: ChannelCredentials$.Outbound; + integrationIdentifier?: string | undefined; + providerId: string; }; export const outboundSchema: z.ZodType< @@ -79,8 +79,8 @@ export namespace UpdateSubscriberChannelRequestDto$ { z.ZodTypeDef, UpdateSubscriberChannelRequestDto > = z.object({ - providerId: UpdateSubscriberChannelRequestDtoProviderId$.outboundSchema, - integrationIdentifier: z.string().optional(), credentials: ChannelCredentials$.outboundSchema, + integrationIdentifier: z.string().optional(), + providerId: UpdateSubscriberChannelRequestDtoProviderId$.outboundSchema, }); } diff --git a/src/models/components/updatesubscriberpreferenceresponsedto.ts b/src/models/components/updatesubscriberpreferenceresponsedto.ts index 78b74f4b..447d3562 100644 --- a/src/models/components/updatesubscriberpreferenceresponsedto.ts +++ b/src/models/components/updatesubscriberpreferenceresponsedto.ts @@ -7,14 +7,14 @@ import { TemplateResponse, TemplateResponse$ } from "./templateresponse"; import * as z from "zod"; export type UpdateSubscriberPreferenceResponseDto = { - /** - * The workflow information and if it is critical or not - */ - template: TemplateResponse; /** * The preferences of the subscriber regarding the related workflow */ preference: Preference; + /** + * The workflow information and if it is critical or not + */ + template: TemplateResponse; }; /** @internal */ @@ -24,13 +24,13 @@ export namespace UpdateSubscriberPreferenceResponseDto$ { z.ZodTypeDef, unknown > = z.object({ - template: TemplateResponse$.inboundSchema, preference: Preference$.inboundSchema, + template: TemplateResponse$.inboundSchema, }); export type Outbound = { - template: TemplateResponse$.Outbound; preference: Preference$.Outbound; + template: TemplateResponse$.Outbound; }; export const outboundSchema: z.ZodType< @@ -38,7 +38,7 @@ export namespace UpdateSubscriberPreferenceResponseDto$ { z.ZodTypeDef, UpdateSubscriberPreferenceResponseDto > = z.object({ - template: TemplateResponse$.outboundSchema, preference: Preference$.outboundSchema, + template: TemplateResponse$.outboundSchema, }); } diff --git a/src/models/components/updatesubscriberrequestdto.ts b/src/models/components/updatesubscriberrequestdto.ts index 9099bd33..f8819f8c 100644 --- a/src/models/components/updatesubscriberrequestdto.ts +++ b/src/models/components/updatesubscriberrequestdto.ts @@ -7,13 +7,13 @@ import * as z from "zod"; export type UpdateSubscriberRequestDtoData = {}; export type UpdateSubscriberRequestDto = { + avatar?: string | undefined; + data?: UpdateSubscriberRequestDtoData | undefined; email?: string | undefined; firstName?: string | undefined; lastName?: string | undefined; - phone?: string | undefined; - avatar?: string | undefined; locale?: string | undefined; - data?: UpdateSubscriberRequestDtoData | undefined; + phone?: string | undefined; }; /** @internal */ @@ -31,33 +31,33 @@ export namespace UpdateSubscriberRequestDtoData$ { export namespace UpdateSubscriberRequestDto$ { export const inboundSchema: z.ZodType = z.object({ + avatar: z.string().optional(), + data: z.lazy(() => UpdateSubscriberRequestDtoData$.inboundSchema).optional(), email: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), - phone: z.string().optional(), - avatar: z.string().optional(), locale: z.string().optional(), - data: z.lazy(() => UpdateSubscriberRequestDtoData$.inboundSchema).optional(), + phone: z.string().optional(), }); export type Outbound = { + avatar?: string | undefined; + data?: UpdateSubscriberRequestDtoData$.Outbound | undefined; email?: string | undefined; firstName?: string | undefined; lastName?: string | undefined; - phone?: string | undefined; - avatar?: string | undefined; locale?: string | undefined; - data?: UpdateSubscriberRequestDtoData$.Outbound | undefined; + phone?: string | undefined; }; export const outboundSchema: z.ZodType = z.object({ + avatar: z.string().optional(), + data: z.lazy(() => UpdateSubscriberRequestDtoData$.outboundSchema).optional(), email: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), - phone: z.string().optional(), - avatar: z.string().optional(), locale: z.string().optional(), - data: z.lazy(() => UpdateSubscriberRequestDtoData$.outboundSchema).optional(), + phone: z.string().optional(), }); } diff --git a/src/models/components/updatetenantrequestdto.ts b/src/models/components/updatetenantrequestdto.ts index 14a93312..24fdf1b7 100644 --- a/src/models/components/updatetenantrequestdto.ts +++ b/src/models/components/updatetenantrequestdto.ts @@ -7,9 +7,9 @@ import * as z from "zod"; export type UpdateTenantRequestDtoData = {}; export type UpdateTenantRequestDto = { + data?: UpdateTenantRequestDtoData | undefined; identifier?: string | undefined; name?: string | undefined; - data?: UpdateTenantRequestDtoData | undefined; }; /** @internal */ @@ -27,22 +27,22 @@ export namespace UpdateTenantRequestDtoData$ { export namespace UpdateTenantRequestDto$ { export const inboundSchema: z.ZodType = z.object( { + data: z.lazy(() => UpdateTenantRequestDtoData$.inboundSchema).optional(), identifier: z.string().optional(), name: z.string().optional(), - data: z.lazy(() => UpdateTenantRequestDtoData$.inboundSchema).optional(), } ); export type Outbound = { + data?: UpdateTenantRequestDtoData$.Outbound | undefined; identifier?: string | undefined; name?: string | undefined; - data?: UpdateTenantRequestDtoData$.Outbound | undefined; }; export const outboundSchema: z.ZodType = z.object({ + data: z.lazy(() => UpdateTenantRequestDtoData$.outboundSchema).optional(), identifier: z.string().optional(), name: z.string().optional(), - data: z.lazy(() => UpdateTenantRequestDtoData$.outboundSchema).optional(), }); } diff --git a/src/models/components/updatetenantresponsedto.ts b/src/models/components/updatetenantresponsedto.ts index 6a05ce7f..22ece4a6 100644 --- a/src/models/components/updatetenantresponsedto.ts +++ b/src/models/components/updatetenantresponsedto.ts @@ -8,12 +8,12 @@ import * as z from "zod"; export type UpdateTenantResponseDtoData = {}; export type UpdateTenantResponseDto = { + environmentId: string; id: string; + createdAt: string; + data?: UpdateTenantResponseDtoData | undefined; identifier: string; name?: string | undefined; - data?: UpdateTenantResponseDtoData | undefined; - environmentId: string; - createdAt: string; updatedAt: string; }; @@ -32,45 +32,45 @@ export namespace UpdateTenantResponseDtoData$ { export namespace UpdateTenantResponseDto$ { export const inboundSchema: z.ZodType = z .object({ + _environmentId: z.string(), _id: z.string(), + createdAt: z.string(), + data: z.lazy(() => UpdateTenantResponseDtoData$.inboundSchema).optional(), identifier: z.string(), name: z.string().optional(), - data: z.lazy(() => UpdateTenantResponseDtoData$.inboundSchema).optional(), - _environmentId: z.string(), - createdAt: z.string(), updatedAt: z.string(), }) .transform((v) => { return remap$(v, { - _id: "id", _environmentId: "environmentId", + _id: "id", }); }); export type Outbound = { + _environmentId: string; _id: string; + createdAt: string; + data?: UpdateTenantResponseDtoData$.Outbound | undefined; identifier: string; name?: string | undefined; - data?: UpdateTenantResponseDtoData$.Outbound | undefined; - _environmentId: string; - createdAt: string; updatedAt: string; }; export const outboundSchema: z.ZodType = z .object({ + environmentId: z.string(), id: z.string(), + createdAt: z.string(), + data: z.lazy(() => UpdateTenantResponseDtoData$.outboundSchema).optional(), identifier: z.string(), name: z.string().optional(), - data: z.lazy(() => UpdateTenantResponseDtoData$.outboundSchema).optional(), - environmentId: z.string(), - createdAt: z.string(), updatedAt: z.string(), }) .transform((v) => { return remap$(v, { - id: "_id", environmentId: "_environmentId", + id: "_id", }); }); } diff --git a/src/models/components/updateworkflowrequestdto.ts b/src/models/components/updateworkflowrequestdto.ts index 8c43b852..a3cbc0f0 100644 --- a/src/models/components/updateworkflowrequestdto.ts +++ b/src/models/components/updateworkflowrequestdto.ts @@ -9,15 +9,15 @@ import * as z from "zod"; export type UpdateWorkflowRequestDtoData = {}; export type UpdateWorkflowRequestDto = { - name: string; - tags?: Array | undefined; + critical?: boolean | undefined; + data?: UpdateWorkflowRequestDtoData | undefined; description?: string | undefined; identifier?: string | undefined; - steps?: Array | undefined; + name: string; notificationGroupId: string; - critical?: boolean | undefined; preferenceSettings?: PreferenceChannels | undefined; - data?: UpdateWorkflowRequestDtoData | undefined; + steps?: Array | undefined; + tags?: Array | undefined; }; /** @internal */ @@ -35,39 +35,39 @@ export namespace UpdateWorkflowRequestDtoData$ { export namespace UpdateWorkflowRequestDto$ { export const inboundSchema: z.ZodType = z.object({ - name: z.string(), - tags: z.array(z.string()).optional(), + critical: z.boolean().optional(), + data: z.lazy(() => UpdateWorkflowRequestDtoData$.inboundSchema).optional(), description: z.string().optional(), identifier: z.string().optional(), - steps: z.array(NotificationStep$.inboundSchema).optional(), + name: z.string(), notificationGroupId: z.string(), - critical: z.boolean().optional(), preferenceSettings: PreferenceChannels$.inboundSchema.optional(), - data: z.lazy(() => UpdateWorkflowRequestDtoData$.inboundSchema).optional(), + steps: z.array(NotificationStep$.inboundSchema).optional(), + tags: z.array(z.string()).optional(), }); export type Outbound = { - name: string; - tags?: Array | undefined; + critical?: boolean | undefined; + data?: UpdateWorkflowRequestDtoData$.Outbound | undefined; description?: string | undefined; identifier?: string | undefined; - steps?: Array | undefined; + name: string; notificationGroupId: string; - critical?: boolean | undefined; preferenceSettings?: PreferenceChannels$.Outbound | undefined; - data?: UpdateWorkflowRequestDtoData$.Outbound | undefined; + steps?: Array | undefined; + tags?: Array | undefined; }; export const outboundSchema: z.ZodType = z.object({ - name: z.string(), - tags: z.array(z.string()).optional(), + critical: z.boolean().optional(), + data: z.lazy(() => UpdateWorkflowRequestDtoData$.outboundSchema).optional(), description: z.string().optional(), identifier: z.string().optional(), - steps: z.array(NotificationStep$.outboundSchema).optional(), + name: z.string(), notificationGroupId: z.string(), - critical: z.boolean().optional(), preferenceSettings: PreferenceChannels$.outboundSchema.optional(), - data: z.lazy(() => UpdateWorkflowRequestDtoData$.outboundSchema).optional(), + steps: z.array(NotificationStep$.outboundSchema).optional(), + tags: z.array(z.string()).optional(), }); } diff --git a/src/models/components/variablesresponsedto.ts b/src/models/components/variablesresponsedto.ts index 04e74848..fe354d85 100644 --- a/src/models/components/variablesresponsedto.ts +++ b/src/models/components/variablesresponsedto.ts @@ -4,49 +4,49 @@ import * as z from "zod"; -export type Translations = {}; - export type System = {}; +export type Translations = {}; + export type VariablesResponseDto = { - translations: Translations; system: System; + translations: Translations; }; /** @internal */ -export namespace Translations$ { - export const inboundSchema: z.ZodType = z.object({}); +export namespace System$ { + export const inboundSchema: z.ZodType = z.object({}); export type Outbound = {}; - export const outboundSchema: z.ZodType = z.object({}); + export const outboundSchema: z.ZodType = z.object({}); } /** @internal */ -export namespace System$ { - export const inboundSchema: z.ZodType = z.object({}); +export namespace Translations$ { + export const inboundSchema: z.ZodType = z.object({}); export type Outbound = {}; - export const outboundSchema: z.ZodType = z.object({}); + export const outboundSchema: z.ZodType = z.object({}); } /** @internal */ export namespace VariablesResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - translations: z.lazy(() => Translations$.inboundSchema), system: z.lazy(() => System$.inboundSchema), + translations: z.lazy(() => Translations$.inboundSchema), }); export type Outbound = { - translations: Translations$.Outbound; system: System$.Outbound; + translations: Translations$.Outbound; }; export const outboundSchema: z.ZodType = z.object( { - translations: z.lazy(() => Translations$.outboundSchema), system: z.lazy(() => System$.outboundSchema), + translations: z.lazy(() => Translations$.outboundSchema), } ); } diff --git a/src/models/components/workflowresponse.ts b/src/models/components/workflowresponse.ts index 842b95ed..0591d796 100644 --- a/src/models/components/workflowresponse.ts +++ b/src/models/components/workflowresponse.ts @@ -9,41 +9,45 @@ import { NotificationTrigger, NotificationTrigger$ } from "./notificationtrigger import { PreferenceChannels, PreferenceChannels$ } from "./preferencechannels"; import * as z from "zod"; -export type Data = {}; +export type WorkflowResponseData = {}; export type WorkflowIntegrationStatus = {}; export type WorkflowResponse = { - id?: string | undefined; - name: string; - description: string; - active: boolean; - draft: boolean; - preferenceSettings: PreferenceChannels; - critical: boolean; - tags: Array; - steps: Array; - organizationId: string; creatorId: string; environmentId: string; - triggers: Array; + id?: string | undefined; notificationGroupId: string; + organizationId: string; parentId?: string | undefined; + active: boolean; + critical: boolean; + data?: WorkflowResponseData | undefined; deleted: boolean; deletedAt: string; deletedBy: string; + description: string; + draft: boolean; + name: string; notificationGroup?: NotificationGroup | undefined; - data?: Data | undefined; + preferenceSettings: PreferenceChannels; + steps: Array; + tags: Array; + triggers: Array; workflowIntegrationStatus?: WorkflowIntegrationStatus | undefined; }; /** @internal */ -export namespace Data$ { - export const inboundSchema: z.ZodType = z.object({}); +export namespace WorkflowResponseData$ { + export const inboundSchema: z.ZodType = z.object( + {} + ); export type Outbound = {}; - export const outboundSchema: z.ZodType = z.object({}); + export const outboundSchema: z.ZodType = z.object( + {} + ); } /** @internal */ @@ -61,98 +65,98 @@ export namespace WorkflowIntegrationStatus$ { export namespace WorkflowResponse$ { export const inboundSchema: z.ZodType = z .object({ - _id: z.string().optional(), - name: z.string(), - description: z.string(), - active: z.boolean(), - draft: z.boolean(), - preferenceSettings: PreferenceChannels$.inboundSchema, - critical: z.boolean(), - tags: z.array(z.string()), - steps: z.array(NotificationStep$.inboundSchema), - _organizationId: z.string(), _creatorId: z.string(), _environmentId: z.string(), - triggers: z.array(NotificationTrigger$.inboundSchema), + _id: z.string().optional(), _notificationGroupId: z.string(), + _organizationId: z.string(), _parentId: z.string().optional(), + active: z.boolean(), + critical: z.boolean(), + data: z.lazy(() => WorkflowResponseData$.inboundSchema).optional(), deleted: z.boolean(), deletedAt: z.string(), deletedBy: z.string(), + description: z.string(), + draft: z.boolean(), + name: z.string(), notificationGroup: NotificationGroup$.inboundSchema.optional(), - data: z.lazy(() => Data$.inboundSchema).optional(), + preferenceSettings: PreferenceChannels$.inboundSchema, + steps: z.array(NotificationStep$.inboundSchema), + tags: z.array(z.string()), + triggers: z.array(NotificationTrigger$.inboundSchema), workflowIntegrationStatus: z .lazy(() => WorkflowIntegrationStatus$.inboundSchema) .optional(), }) .transform((v) => { return remap$(v, { - _id: "id", - _organizationId: "organizationId", _creatorId: "creatorId", _environmentId: "environmentId", + _id: "id", _notificationGroupId: "notificationGroupId", + _organizationId: "organizationId", _parentId: "parentId", }); }); export type Outbound = { - _id?: string | undefined; - name: string; - description: string; - active: boolean; - draft: boolean; - preferenceSettings: PreferenceChannels$.Outbound; - critical: boolean; - tags: Array; - steps: Array; - _organizationId: string; _creatorId: string; _environmentId: string; - triggers: Array; + _id?: string | undefined; _notificationGroupId: string; + _organizationId: string; _parentId?: string | undefined; + active: boolean; + critical: boolean; + data?: WorkflowResponseData$.Outbound | undefined; deleted: boolean; deletedAt: string; deletedBy: string; + description: string; + draft: boolean; + name: string; notificationGroup?: NotificationGroup$.Outbound | undefined; - data?: Data$.Outbound | undefined; + preferenceSettings: PreferenceChannels$.Outbound; + steps: Array; + tags: Array; + triggers: Array; workflowIntegrationStatus?: WorkflowIntegrationStatus$.Outbound | undefined; }; export const outboundSchema: z.ZodType = z .object({ - id: z.string().optional(), - name: z.string(), - description: z.string(), - active: z.boolean(), - draft: z.boolean(), - preferenceSettings: PreferenceChannels$.outboundSchema, - critical: z.boolean(), - tags: z.array(z.string()), - steps: z.array(NotificationStep$.outboundSchema), - organizationId: z.string(), creatorId: z.string(), environmentId: z.string(), - triggers: z.array(NotificationTrigger$.outboundSchema), + id: z.string().optional(), notificationGroupId: z.string(), + organizationId: z.string(), parentId: z.string().optional(), + active: z.boolean(), + critical: z.boolean(), + data: z.lazy(() => WorkflowResponseData$.outboundSchema).optional(), deleted: z.boolean(), deletedAt: z.string(), deletedBy: z.string(), + description: z.string(), + draft: z.boolean(), + name: z.string(), notificationGroup: NotificationGroup$.outboundSchema.optional(), - data: z.lazy(() => Data$.outboundSchema).optional(), + preferenceSettings: PreferenceChannels$.outboundSchema, + steps: z.array(NotificationStep$.outboundSchema), + tags: z.array(z.string()), + triggers: z.array(NotificationTrigger$.outboundSchema), workflowIntegrationStatus: z .lazy(() => WorkflowIntegrationStatus$.outboundSchema) .optional(), }) .transform((v) => { return remap$(v, { - id: "_id", - organizationId: "_organizationId", creatorId: "_creatorId", environmentId: "_environmentId", + id: "_id", notificationGroupId: "_notificationGroupId", + organizationId: "_organizationId", parentId: "_parentId", }); }); diff --git a/src/models/components/workflowsresponsedto.ts b/src/models/components/workflowsresponsedto.ts index b89d8e2a..67f213d9 100644 --- a/src/models/components/workflowsresponsedto.ts +++ b/src/models/components/workflowsresponsedto.ts @@ -6,34 +6,34 @@ import { WorkflowResponse, WorkflowResponse$ } from "./workflowresponse"; import * as z from "zod"; export type WorkflowsResponseDto = { - totalCount: number; data: Array; - pageSize: number; page: number; + pageSize: number; + totalCount: number; }; /** @internal */ export namespace WorkflowsResponseDto$ { export const inboundSchema: z.ZodType = z.object({ - totalCount: z.number(), data: z.array(WorkflowResponse$.inboundSchema), - pageSize: z.number(), page: z.number(), + pageSize: z.number(), + totalCount: z.number(), }); export type Outbound = { - totalCount: number; data: Array; - pageSize: number; page: number; + pageSize: number; + totalCount: number; }; export const outboundSchema: z.ZodType = z.object( { - totalCount: z.number(), data: z.array(WorkflowResponse$.outboundSchema), - pageSize: z.number(), page: z.number(), + pageSize: z.number(), + totalCount: z.number(), } ); } diff --git a/src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts b/src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts index 950bceae..41cc4cb6 100644 --- a/src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts +++ b/src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts @@ -8,7 +8,7 @@ import * as z from "zod"; /** * The channel of the message to be deleted */ -export const QueryParamChannel = { +export const Channel = { InApp: "in_app", Email: "email", Sms: "sms", @@ -18,19 +18,19 @@ export const QueryParamChannel = { /** * The channel of the message to be deleted */ -export type QueryParamChannel = ClosedEnum; +export type Channel = ClosedEnum; export type MessagesControllerDeleteMessagesByTransactionIdRequest = { /** * The channel of the message to be deleted */ - channel?: QueryParamChannel | undefined; + channel?: Channel | undefined; transactionId: string; }; /** @internal */ -export namespace QueryParamChannel$ { - export const inboundSchema = z.nativeEnum(QueryParamChannel); +export namespace Channel$ { + export const inboundSchema = z.nativeEnum(Channel); export const outboundSchema = inboundSchema; } @@ -41,7 +41,7 @@ export namespace MessagesControllerDeleteMessagesByTransactionIdRequest$ { z.ZodTypeDef, unknown > = z.object({ - channel: QueryParamChannel$.inboundSchema.optional(), + channel: Channel$.inboundSchema.optional(), transactionId: z.string(), }); @@ -55,7 +55,7 @@ export namespace MessagesControllerDeleteMessagesByTransactionIdRequest$ { z.ZodTypeDef, MessagesControllerDeleteMessagesByTransactionIdRequest > = z.object({ - channel: QueryParamChannel$.outboundSchema.optional(), + channel: Channel$.outboundSchema.optional(), transactionId: z.string(), }); } diff --git a/src/models/operations/messagescontrollergetmessages.ts b/src/models/operations/messagescontrollergetmessages.ts index 15be1a93..9c560bfb 100644 --- a/src/models/operations/messagescontrollergetmessages.ts +++ b/src/models/operations/messagescontrollergetmessages.ts @@ -5,17 +5,17 @@ import { ClosedEnum } from "../../types"; import * as z from "zod"; -export const Channel = { +export const QueryParamChannel = { InApp: "in_app", Email: "email", Sms: "sms", Chat: "chat", Push: "push", } as const; -export type Channel = ClosedEnum; +export type QueryParamChannel = ClosedEnum; export type MessagesControllerGetMessagesRequest = { - channel?: Channel | undefined; + channel?: QueryParamChannel | undefined; subscriberId?: string | undefined; transactionId?: Array | undefined; page?: number | undefined; @@ -23,8 +23,8 @@ export type MessagesControllerGetMessagesRequest = { }; /** @internal */ -export namespace Channel$ { - export const inboundSchema = z.nativeEnum(Channel); +export namespace QueryParamChannel$ { + export const inboundSchema = z.nativeEnum(QueryParamChannel); export const outboundSchema = inboundSchema; } @@ -35,7 +35,7 @@ export namespace MessagesControllerGetMessagesRequest$ { z.ZodTypeDef, unknown > = z.object({ - channel: Channel$.inboundSchema.optional(), + channel: QueryParamChannel$.inboundSchema.optional(), subscriberId: z.string().optional(), transactionId: z.array(z.string()).optional(), page: z.number().default(0), @@ -55,7 +55,7 @@ export namespace MessagesControllerGetMessagesRequest$ { z.ZodTypeDef, MessagesControllerGetMessagesRequest > = z.object({ - channel: Channel$.outboundSchema.optional(), + channel: QueryParamChannel$.outboundSchema.optional(), subscriberId: z.string().optional(), transactionId: z.array(z.string()).optional(), page: z.number().default(0), diff --git a/src/models/operations/subscriberscontrollergetnotificationsfeed.ts b/src/models/operations/subscriberscontrollergetnotificationsfeed.ts index f1415853..ceebb1b6 100644 --- a/src/models/operations/subscriberscontrollergetnotificationsfeed.ts +++ b/src/models/operations/subscriberscontrollergetnotificationsfeed.ts @@ -18,19 +18,19 @@ export type SubscribersControllerGetNotificationsFeedRequest = { }; export type SubscribersControllerGetNotificationsFeedResponseBody = { - /** - * The current page of the paginated response - */ - page: number; + data: Array; /** * Does the list have more items to fetch */ hasMore: boolean; + /** + * The current page of the paginated response + */ + page: number; /** * Number of items on each page */ pageSize: number; - data: Array; }; /** @internal */ @@ -78,17 +78,17 @@ export namespace SubscribersControllerGetNotificationsFeedResponseBody$ { z.ZodTypeDef, unknown > = z.object({ - page: z.number(), + data: z.array(components.FeedResponseDto$.inboundSchema), hasMore: z.boolean(), + page: z.number(), pageSize: z.number(), - data: z.array(components.FeedResponseDto$.inboundSchema), }); export type Outbound = { - page: number; + data: Array; hasMore: boolean; + page: number; pageSize: number; - data: Array; }; export const outboundSchema: z.ZodType< @@ -96,9 +96,9 @@ export namespace SubscribersControllerGetNotificationsFeedResponseBody$ { z.ZodTypeDef, SubscribersControllerGetNotificationsFeedResponseBody > = z.object({ - page: z.number(), + data: z.array(components.FeedResponseDto$.outboundSchema), hasMore: z.boolean(), + page: z.number(), pageSize: z.number(), - data: z.array(components.FeedResponseDto$.outboundSchema), }); } diff --git a/src/models/operations/subscriberscontrollerlistsubscribers.ts b/src/models/operations/subscriberscontrollerlistsubscribers.ts index dd0fbfb1..5ce13f29 100644 --- a/src/models/operations/subscriberscontrollerlistsubscribers.ts +++ b/src/models/operations/subscriberscontrollerlistsubscribers.ts @@ -12,19 +12,19 @@ export type SubscribersControllerListSubscribersRequest = { }; export type SubscribersControllerListSubscribersResponseBody = { - /** - * The current page of the paginated response - */ - page: number; + data: Array; /** * Does the list have more items to fetch */ hasMore: boolean; + /** + * The current page of the paginated response + */ + page: number; /** * Number of items on each page */ pageSize: number; - data: Array; }; export type SubscribersControllerListSubscribersResponse = { @@ -64,17 +64,17 @@ export namespace SubscribersControllerListSubscribersResponseBody$ { z.ZodTypeDef, unknown > = z.object({ - page: z.number(), + data: z.array(components.SubscriberResponseDto$.inboundSchema), hasMore: z.boolean(), + page: z.number(), pageSize: z.number(), - data: z.array(components.SubscriberResponseDto$.inboundSchema), }); export type Outbound = { - page: number; + data: Array; hasMore: boolean; + page: number; pageSize: number; - data: Array; }; export const outboundSchema: z.ZodType< @@ -82,10 +82,10 @@ export namespace SubscribersControllerListSubscribersResponseBody$ { z.ZodTypeDef, SubscribersControllerListSubscribersResponseBody > = z.object({ - page: z.number(), + data: z.array(components.SubscriberResponseDto$.outboundSchema), hasMore: z.boolean(), + page: z.number(), pageSize: z.number(), - data: z.array(components.SubscriberResponseDto$.outboundSchema), }); } diff --git a/src/models/operations/tenantcontrollerlisttenants.ts b/src/models/operations/tenantcontrollerlisttenants.ts index a5e6441c..e313f906 100644 --- a/src/models/operations/tenantcontrollerlisttenants.ts +++ b/src/models/operations/tenantcontrollerlisttenants.ts @@ -12,19 +12,19 @@ export type TenantControllerListTenantsRequest = { }; export type TenantControllerListTenantsResponseBody = { - /** - * The current page of the paginated response - */ - page: number; + data: Array; /** * Does the list have more items to fetch */ hasMore: boolean; + /** + * The current page of the paginated response + */ + page: number; /** * Number of items on each page */ pageSize: number; - data: Array; }; export type TenantControllerListTenantsResponse = { @@ -64,17 +64,17 @@ export namespace TenantControllerListTenantsResponseBody$ { z.ZodTypeDef, unknown > = z.object({ - page: z.number(), + data: z.array(components.GetTenantResponseDto$.inboundSchema), hasMore: z.boolean(), + page: z.number(), pageSize: z.number(), - data: z.array(components.GetTenantResponseDto$.inboundSchema), }); export type Outbound = { - page: number; + data: Array; hasMore: boolean; + page: number; pageSize: number; - data: Array; }; export const outboundSchema: z.ZodType< @@ -82,10 +82,10 @@ export namespace TenantControllerListTenantsResponseBody$ { z.ZodTypeDef, TenantControllerListTenantsResponseBody > = z.object({ - page: z.number(), + data: z.array(components.GetTenantResponseDto$.outboundSchema), hasMore: z.boolean(), + page: z.number(), pageSize: z.number(), - data: z.array(components.GetTenantResponseDto$.outboundSchema), }); } diff --git a/src/sdk/authentication.ts b/src/sdk/authentication.ts index 3468bfc3..27a0cb3c 100644 --- a/src/sdk/authentication.ts +++ b/src/sdk/authentication.ts @@ -43,21 +43,21 @@ export class Authentication extends ClientSDK { } /** - * Handle providers oauth redirect + * Handle chat oauth */ - async chatAccessOauthCallBack( - request: operations.SubscribersControllerChatOauthCallbackRequest, + async chatAccessOauth( + request: operations.SubscribersControllerChatAccessOauthRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { + ): Promise { const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerChatOauthCallbackRequest$.outboundSchema.parse( + operations.SubscribersControllerChatAccessOauthRequest$.outboundSchema.parse( value$ ), "Input validation failed" @@ -75,11 +75,10 @@ export class Authentication extends ClientSDK { }), }; const path$ = this.templateURLComponent( - "/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback" + "/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth" )(pathParams$); const query$ = encodeFormQuery$({ - code: payload$.code, environmentId: payload$.environmentId, hmacHash: payload$.hmacHash, integrationIdentifier: payload$.integrationIdentifier, @@ -94,7 +93,7 @@ export class Authentication extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_chatOauthCallback", + operationID: "SubscribersController_chatAccessOauth", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -134,31 +133,30 @@ export class Authentication extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = - await this.matcher() - .json(200, operations.SubscribersControllerChatOauthCallbackResponseBody$) - .fail([409, 429, "4XX", 503, "5XX"]) - .match(response); + const [result$] = await this.matcher() + .void(200, z.void()) + .fail([409, 429, "4XX", 503, "5XX"]) + .match(response); return result$; } /** - * Handle chat oauth + * Handle providers oauth redirect */ - async chatAccessOauth( - request: operations.SubscribersControllerChatAccessOauthRequest, + async chatAccessOauthCallBack( + request: operations.SubscribersControllerChatOauthCallbackRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { + ): Promise { const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerChatAccessOauthRequest$.outboundSchema.parse( + operations.SubscribersControllerChatOauthCallbackRequest$.outboundSchema.parse( value$ ), "Input validation failed" @@ -176,10 +174,11 @@ export class Authentication extends ClientSDK { }), }; const path$ = this.templateURLComponent( - "/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth" + "/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback" )(pathParams$); const query$ = encodeFormQuery$({ + code: payload$.code, environmentId: payload$.environmentId, hmacHash: payload$.hmacHash, integrationIdentifier: payload$.integrationIdentifier, @@ -194,7 +193,7 @@ export class Authentication extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_chatAccessOauth", + operationID: "SubscribersController_chatOauthCallback", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -234,10 +233,11 @@ export class Authentication extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(200, z.void()) - .fail([409, 429, "4XX", 503, "5XX"]) - .match(response); + const [result$] = + await this.matcher() + .json(200, operations.SubscribersControllerChatOauthCallbackResponseBody$) + .fail([409, 429, "4XX", 503, "5XX"]) + .match(response); return result$; } diff --git a/src/sdk/changes.ts b/src/sdk/changes.ts index 7e1db003..949088ce 100644 --- a/src/sdk/changes.ts +++ b/src/sdk/changes.ts @@ -45,31 +45,35 @@ export class Changes extends ClientSDK { } /** - * Get changes + * Apply change */ - async retrieve( - request: operations.ChangesControllerGetChangesRequest, + async apply( + changeId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise> { + const input$: operations.ChangesControllerApplyDiffRequest = { + changeId: changeId, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.ChangesControllerGetChangesRequest$.outboundSchema.parse(value$), + (value$) => operations.ChangesControllerApplyDiffRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const path$ = this.templateURLComponent("/v1/changes")(); + const pathParams$ = { + changeId: encodeSimple$("changeId", payload$.changeId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/changes/{changeId}/apply")(pathParams$); - const query$ = encodeFormQuery$({ - limit: payload$.limit, - page: payload$.page, - promoted: payload$.promoted, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -80,7 +84,7 @@ export class Changes extends ClientSDK { security$ = {}; } const context = { - operationID: "ChangesController_getChanges", + operationID: "ChangesController_applyDiff", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -91,7 +95,7 @@ export class Changes extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, @@ -120,8 +124,8 @@ export class Changes extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.ChangesResponseDto$) + const [result$] = await this.matcher>() + .json(201, z.array(components.ChangeResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -129,16 +133,26 @@ export class Changes extends ClientSDK { } /** - * Get changes count + * Apply changes */ - async count( + async applyBulk( + request: components.BulkApplyChangeDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { + ): Promise> { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); - const path$ = this.templateURLComponent("/v1/changes/count")(); + const payload$ = schemas$.parse( + input$, + (value$) => components.BulkApplyChangeDto$.outboundSchema.parse(value$), + "Input validation failed" + ); + const body$ = encodeJSON$("body", payload$, { explode: true }); + + const path$ = this.templateURLComponent("/v1/changes/bulk/apply")(); const query$ = ""; @@ -151,7 +165,7 @@ export class Changes extends ClientSDK { security$ = {}; } const context = { - operationID: "ChangesController_getChangesCount", + operationID: "ChangesController_bulkApplyDiff", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -162,10 +176,11 @@ export class Changes extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, + body: body$, }, options ); @@ -190,8 +205,8 @@ export class Changes extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.DataNumberDto$) + const [result$] = await this.matcher>() + .json(201, z.array(components.ChangeResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -199,26 +214,16 @@ export class Changes extends ClientSDK { } /** - * Apply changes + * Get changes count */ - async applyBulk( - request: components.BulkApplyChangeDto, + async count( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$ = request; + ): Promise { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); - const payload$ = schemas$.parse( - input$, - (value$) => components.BulkApplyChangeDto$.outboundSchema.parse(value$), - "Input validation failed" - ); - const body$ = encodeJSON$("body", payload$, { explode: true }); - - const path$ = this.templateURLComponent("/v1/changes/bulk/apply")(); + const path$ = this.templateURLComponent("/v1/changes/count")(); const query$ = ""; @@ -231,7 +236,7 @@ export class Changes extends ClientSDK { security$ = {}; } const context = { - operationID: "ChangesController_bulkApplyDiff", + operationID: "ChangesController_getChangesCount", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -242,11 +247,10 @@ export class Changes extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "GET", path: path$, headers: headers$, query: query$, - body: body$, }, options ); @@ -271,8 +275,8 @@ export class Changes extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(201, z.array(components.ChangeResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(200, components.DataNumberDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -280,35 +284,31 @@ export class Changes extends ClientSDK { } /** - * Apply change + * Get changes */ - async apply( - changeId: string, + async retrieve( + request: operations.ChangesControllerGetChangesRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$: operations.ChangesControllerApplyDiffRequest = { - changeId: changeId, - }; + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.ChangesControllerApplyDiffRequest$.outboundSchema.parse(value$), + (value$) => operations.ChangesControllerGetChangesRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const pathParams$ = { - changeId: encodeSimple$("changeId", payload$.changeId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/changes/{changeId}/apply")(pathParams$); + const path$ = this.templateURLComponent("/v1/changes")(); - const query$ = ""; + const query$ = encodeFormQuery$({ + limit: payload$.limit, + page: payload$.page, + promoted: payload$.promoted, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -319,7 +319,7 @@ export class Changes extends ClientSDK { security$ = {}; } const context = { - operationID: "ChangesController_applyDiff", + operationID: "ChangesController_getChanges", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -330,7 +330,7 @@ export class Changes extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "GET", path: path$, headers: headers$, query: query$, @@ -359,8 +359,8 @@ export class Changes extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(201, z.array(components.ChangeResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(200, components.ChangesResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/credentials.ts b/src/sdk/credentials.ts index 2d2bf70e..528a3c61 100644 --- a/src/sdk/credentials.ts +++ b/src/sdk/credentials.ts @@ -41,17 +41,18 @@ export class Credentials extends ClientSDK { } /** - * Update subscriber credentials + * Modify subscriber credentials * * @remarks * Subscriber credentials associated to the delivery methods such as slack and push tokens. + * This endpoint appends provided credentials and deviceTokens to the existing ones. */ - async update( + async append( subscriberId: string, updateSubscriberChannelRequestDto: components.UpdateSubscriberChannelRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } ): Promise { - const input$: operations.SubscribersControllerUpdateSubscriberChannelRequest = { + const input$: operations.SubscribersControllerModifySubscriberChannelRequest = { subscriberId: subscriberId, updateSubscriberChannelRequestDto: updateSubscriberChannelRequestDto, }; @@ -63,7 +64,7 @@ export class Credentials extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerUpdateSubscriberChannelRequest$.outboundSchema.parse( + operations.SubscribersControllerModifySubscriberChannelRequest$.outboundSchema.parse( value$ ), "Input validation failed" @@ -93,7 +94,7 @@ export class Credentials extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_updateSubscriberChannel", + operationID: "SubscribersController_modifySubscriberChannel", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -104,7 +105,7 @@ export class Credentials extends ClientSDK { context, { security: securitySettings$, - method: "PUT", + method: "PATCH", path: path$, headers: headers$, query: query$, @@ -142,47 +143,47 @@ export class Credentials extends ClientSDK { } /** - * Modify subscriber credentials + * Delete subscriber credentials by providerId * * @remarks - * Subscriber credentials associated to the delivery methods such as slack and push tokens. - * This endpoint appends provided credentials and deviceTokens to the existing ones. + * Delete subscriber credentials such as slack and expo tokens. */ - async append( + async delete( subscriberId: string, - updateSubscriberChannelRequestDto: components.UpdateSubscriberChannelRequestDto, + providerId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.SubscribersControllerModifySubscriberChannelRequest = { + ): Promise { + const input$: operations.SubscribersControllerDeleteSubscriberCredentialsRequest = { subscriberId: subscriberId, - updateSubscriberChannelRequestDto: updateSubscriberChannelRequestDto, + providerId: providerId, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerModifySubscriberChannelRequest$.outboundSchema.parse( + operations.SubscribersControllerDeleteSubscriberCredentialsRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.UpdateSubscriberChannelRequestDto, { - explode: true, - }); + const body$ = null; const pathParams$ = { + providerId: encodeSimple$("providerId", payload$.providerId, { + explode: false, + charEncoding: "percent", + }), subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { explode: false, charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/credentials")( - pathParams$ - ); + const path$ = this.templateURLComponent( + "/v1/subscribers/{subscriberId}/credentials/{providerId}" + )(pathParams$); const query$ = ""; @@ -195,7 +196,7 @@ export class Credentials extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_modifySubscriberChannel", + operationID: "SubscribersController_deleteSubscriberCredentials", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -206,7 +207,7 @@ export class Credentials extends ClientSDK { context, { security: securitySettings$, - method: "PATCH", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -235,8 +236,8 @@ export class Credentials extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.SubscriberResponseDto$) + const [result$] = await this.matcher() + .void(204, z.void()) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -244,47 +245,46 @@ export class Credentials extends ClientSDK { } /** - * Delete subscriber credentials by providerId + * Update subscriber credentials * * @remarks - * Delete subscriber credentials such as slack and expo tokens. + * Subscriber credentials associated to the delivery methods such as slack and push tokens. */ - async delete( + async update( subscriberId: string, - providerId: string, + updateSubscriberChannelRequestDto: components.UpdateSubscriberChannelRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.SubscribersControllerDeleteSubscriberCredentialsRequest = { + ): Promise { + const input$: operations.SubscribersControllerUpdateSubscriberChannelRequest = { subscriberId: subscriberId, - providerId: providerId, + updateSubscriberChannelRequestDto: updateSubscriberChannelRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); + headers$.set("Content-Type", "application/json"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerDeleteSubscriberCredentialsRequest$.outboundSchema.parse( + operations.SubscribersControllerUpdateSubscriberChannelRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$.UpdateSubscriberChannelRequestDto, { + explode: true, + }); const pathParams$ = { - providerId: encodeSimple$("providerId", payload$.providerId, { - explode: false, - charEncoding: "percent", - }), subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { explode: false, charEncoding: "percent", }), }; - const path$ = this.templateURLComponent( - "/v1/subscribers/{subscriberId}/credentials/{providerId}" - )(pathParams$); + const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/credentials")( + pathParams$ + ); const query$ = ""; @@ -297,7 +297,7 @@ export class Credentials extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_deleteSubscriberCredentials", + operationID: "SubscribersController_updateSubscriberChannel", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -308,7 +308,7 @@ export class Credentials extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "PUT", path: path$, headers: headers$, query: query$, @@ -337,8 +337,8 @@ export class Credentials extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(204, z.void()) + const [result$] = await this.matcher() + .json(200, components.SubscriberResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/environments.ts b/src/sdk/environments.ts index 69cf0b58..aa4606f4 100644 --- a/src/sdk/environments.ts +++ b/src/sdk/environments.ts @@ -44,16 +44,16 @@ export class Environments extends ClientSDK { } /** - * Get current environment + * Get environments */ - async retrieve( + async list( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { + ): Promise> { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); - const path$ = this.templateURLComponent("/v1/environments/me")(); + const path$ = this.templateURLComponent("/v1/environments")(); const query$ = ""; @@ -66,7 +66,7 @@ export class Environments extends ClientSDK { security$ = {}; } const context = { - operationID: "EnvironmentsController_getCurrentEnvironment", + operationID: "EnvironmentsController_listMyEnvironments", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -105,8 +105,8 @@ export class Environments extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.EnvironmentResponseDto$) + const [result$] = await this.matcher>() + .json(200, z.array(components.EnvironmentResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -114,16 +114,16 @@ export class Environments extends ClientSDK { } /** - * Get environments + * Get current environment */ - async list( + async retrieve( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { + ): Promise { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); - const path$ = this.templateURLComponent("/v1/environments")(); + const path$ = this.templateURLComponent("/v1/environments/me")(); const query$ = ""; @@ -136,7 +136,7 @@ export class Environments extends ClientSDK { security$ = {}; } const context = { - operationID: "EnvironmentsController_listMyEnvironments", + operationID: "EnvironmentsController_getCurrentEnvironment", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -175,8 +175,8 @@ export class Environments extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(200, z.array(components.EnvironmentResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(200, components.EnvironmentResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/events.ts b/src/sdk/events.ts index 4208ca26..0030ade3 100644 --- a/src/sdk/events.ts +++ b/src/sdk/events.ts @@ -41,33 +41,39 @@ export class Events extends ClientSDK { } /** - * Trigger event + * Cancel triggered event * * @remarks * - * 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. + * Using a previously generated transactionId during the event trigger, + * will cancel any active or pending workflows. This is useful to cancel active digests, delays etc... * */ - async trigger( - request: components.TriggerEventRequestDto, + async cancel( + transactionId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise { + const input$: operations.EventsControllerCancelRequest = { + transactionId: transactionId, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => components.TriggerEventRequestDto$.outboundSchema.parse(value$), + (value$) => operations.EventsControllerCancelRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = null; - const path$ = this.templateURLComponent("/v1/events/trigger")(); + const pathParams$ = { + transactionId: encodeSimple$("transactionId", payload$.transactionId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/events/trigger/{transactionId}")(pathParams$); const query$ = ""; @@ -80,7 +86,7 @@ export class Events extends ClientSDK { security$ = {}; } const context = { - operationID: "EventsController_trigger", + operationID: "EventsController_cancel", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -91,7 +97,7 @@ export class Events extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -120,8 +126,8 @@ export class Events extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.TriggerEventResponseDto$) + const [result$] = await this.matcher() + .json(200, components.DataBooleanDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -129,18 +135,19 @@ export class Events extends ClientSDK { } /** - * Bulk trigger event + * Trigger event * * @remarks * - * Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. - * The bulk API is limited to 100 events per request. + * 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. * */ - async triggerBulk( - request: components.BulkTriggerEventDto, + async trigger( + request: components.TriggerEventRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { + ): Promise { const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); @@ -149,12 +156,12 @@ export class Events extends ClientSDK { const payload$ = schemas$.parse( input$, - (value$) => components.BulkTriggerEventDto$.outboundSchema.parse(value$), + (value$) => components.TriggerEventRequestDto$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = encodeJSON$("body", payload$, { explode: true }); - const path$ = this.templateURLComponent("/v1/events/trigger/bulk")(); + const path$ = this.templateURLComponent("/v1/events/trigger")(); const query$ = ""; @@ -167,7 +174,7 @@ export class Events extends ClientSDK { security$ = {}; } const context = { - operationID: "EventsController_triggerBulk", + operationID: "EventsController_trigger", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -207,8 +214,8 @@ export class Events extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(201, z.array(components.TriggerEventResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(201, components.TriggerEventResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -301,39 +308,32 @@ export class Events extends ClientSDK { } /** - * Cancel triggered event + * Bulk trigger event * * @remarks * - * Using a previously generated transactionId during the event trigger, - * will cancel any active or pending workflows. This is useful to cancel active digests, delays etc... + * Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. + * The bulk API is limited to 100 events per request. * */ - async cancel( - transactionId: string, + async triggerBulk( + request: components.BulkTriggerEventDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.EventsControllerCancelRequest = { - transactionId: transactionId, - }; + ): Promise> { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.EventsControllerCancelRequest$.outboundSchema.parse(value$), + (value$) => components.BulkTriggerEventDto$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$, { explode: true }); - const pathParams$ = { - transactionId: encodeSimple$("transactionId", payload$.transactionId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/events/trigger/{transactionId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/events/trigger/bulk")(); const query$ = ""; @@ -346,7 +346,7 @@ export class Events extends ClientSDK { security$ = {}; } const context = { - operationID: "EventsController_cancel", + operationID: "EventsController_triggerBulk", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -357,7 +357,7 @@ export class Events extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "POST", path: path$, headers: headers$, query: query$, @@ -386,8 +386,8 @@ export class Events extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.DataBooleanDto$) + const [result$] = await this.matcher>() + .json(201, z.array(components.TriggerEventResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/feeds.ts b/src/sdk/feeds.ts index a33cd939..2439e4c9 100644 --- a/src/sdk/feeds.ts +++ b/src/sdk/feeds.ts @@ -41,15 +41,25 @@ export class Feeds extends ClientSDK { } /** - * Get feeds + * Create feed */ - async retrieve( + async create( + request: components.CreateFeedRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); + const payload$ = schemas$.parse( + input$, + (value$) => components.CreateFeedRequestDto$.outboundSchema.parse(value$), + "Input validation failed" + ); + const body$ = encodeJSON$("body", payload$, { explode: true }); + const path$ = this.templateURLComponent("/v1/feeds")(); const query$ = ""; @@ -63,7 +73,7 @@ export class Feeds extends ClientSDK { security$ = {}; } const context = { - operationID: "FeedsController_getFeeds", + operationID: "FeedsController_createFeed", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -74,10 +84,11 @@ export class Feeds extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, + body: body$, }, options ); @@ -102,8 +113,8 @@ export class Feeds extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(200, z.array(components.FeedResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(201, components.FeedResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -111,26 +122,34 @@ export class Feeds extends ClientSDK { } /** - * Create feed + * Delete feed */ - async create( - request: components.CreateFeedRequestDto, + async delete( + feedId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise> { + const input$: operations.FeedsControllerDeleteFeedByIdRequest = { + feedId: feedId, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => components.CreateFeedRequestDto$.outboundSchema.parse(value$), + (value$) => + operations.FeedsControllerDeleteFeedByIdRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = null; - const path$ = this.templateURLComponent("/v1/feeds")(); + const pathParams$ = { + feedId: encodeSimple$("feedId", payload$.feedId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/feeds/{feedId}")(pathParams$); const query$ = ""; @@ -143,7 +162,7 @@ export class Feeds extends ClientSDK { security$ = {}; } const context = { - operationID: "FeedsController_createFeed", + operationID: "FeedsController_deleteFeedById", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -154,7 +173,7 @@ export class Feeds extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -183,8 +202,8 @@ export class Feeds extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.FeedResponseDto$) + const [result$] = await this.matcher>() + .json(200, z.array(components.FeedResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -192,34 +211,16 @@ export class Feeds extends ClientSDK { } /** - * Delete feed + * Get feeds */ - async delete( - feedId: string, + async retrieve( options?: RequestOptions & { retries?: retries$.RetryConfig } ): Promise> { - const input$: operations.FeedsControllerDeleteFeedByIdRequest = { - feedId: feedId, - }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); - const payload$ = schemas$.parse( - input$, - (value$) => - operations.FeedsControllerDeleteFeedByIdRequest$.outboundSchema.parse(value$), - "Input validation failed" - ); - const body$ = null; - - const pathParams$ = { - feedId: encodeSimple$("feedId", payload$.feedId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/feeds/{feedId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/feeds")(); const query$ = ""; @@ -232,7 +233,7 @@ export class Feeds extends ClientSDK { security$ = {}; } const context = { - operationID: "FeedsController_deleteFeedById", + operationID: "FeedsController_getFeeds", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -243,11 +244,10 @@ export class Feeds extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "GET", path: path$, headers: headers$, query: query$, - body: body$, }, options ); diff --git a/src/sdk/integrations.ts b/src/sdk/integrations.ts index 04e442cd..c5f1b7f0 100644 --- a/src/sdk/integrations.ts +++ b/src/sdk/integrations.ts @@ -47,18 +47,28 @@ export class Integrations extends ClientSDK { } /** - * Get integrations + * Create integration * * @remarks - * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change + * Create an integration for the current environment the user is based on the API key provided */ - async list( + async create( + request: components.CreateIntegrationRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); + const payload$ = schemas$.parse( + input$, + (value$) => components.CreateIntegrationRequestDto$.outboundSchema.parse(value$), + "Input validation failed" + ); + const body$ = encodeJSON$("body", payload$, { explode: true }); + const path$ = this.templateURLComponent("/v1/integrations")(); const query$ = ""; @@ -72,7 +82,7 @@ export class Integrations extends ClientSDK { security$ = {}; } const context = { - operationID: "IntegrationsController_listIntegrations", + operationID: "IntegrationsController_createIntegration", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -83,10 +93,11 @@ export class Integrations extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, + body: body$, }, options ); @@ -111,8 +122,8 @@ export class Integrations extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(200, z.array(components.IntegrationResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(201, components.IntegrationResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -120,29 +131,36 @@ export class Integrations extends ClientSDK { } /** - * Create integration - * - * @remarks - * Create an integration for the current environment the user is based on the API key provided + * Delete integration */ - async create( - request: components.CreateIntegrationRequestDto, + async delete( + integrationId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise> { + const input$: operations.IntegrationsControllerRemoveIntegrationRequest = { + integrationId: integrationId, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => components.CreateIntegrationRequestDto$.outboundSchema.parse(value$), + (value$) => + operations.IntegrationsControllerRemoveIntegrationRequest$.outboundSchema.parse( + value$ + ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = null; - const path$ = this.templateURLComponent("/v1/integrations")(); + const pathParams$ = { + integrationId: encodeSimple$("integrationId", payload$.integrationId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/integrations/{integrationId}")(pathParams$); const query$ = ""; @@ -155,7 +173,7 @@ export class Integrations extends ClientSDK { security$ = {}; } const context = { - operationID: "IntegrationsController_createIntegration", + operationID: "IntegrationsController_removeIntegration", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -166,7 +184,7 @@ export class Integrations extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -195,8 +213,8 @@ export class Integrations extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.IntegrationResponseDto$) + const [result$] = await this.matcher>() + .json(200, z.array(components.IntegrationResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -204,19 +222,19 @@ export class Integrations extends ClientSDK { } /** - * Get active integrations + * Get integrations * * @remarks - * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change + * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change */ - async listActive( + async list( options?: RequestOptions & { retries?: retries$.RetryConfig } ): Promise> { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); - const path$ = this.templateURLComponent("/v1/integrations/active")(); + const path$ = this.templateURLComponent("/v1/integrations")(); const query$ = ""; @@ -229,7 +247,7 @@ export class Integrations extends ClientSDK { security$ = {}; } const context = { - operationID: "IntegrationsController_getActiveIntegrations", + operationID: "IntegrationsController_listIntegrations", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -277,39 +295,19 @@ export class Integrations extends ClientSDK { } /** - * Update integration + * Get active integrations + * + * @remarks + * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change */ - async update( - integrationId: string, - updateIntegrationRequestDto: components.UpdateIntegrationRequestDto, + async listActive( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.IntegrationsControllerUpdateIntegrationByIdRequest = { - integrationId: integrationId, - updateIntegrationRequestDto: updateIntegrationRequestDto, - }; + ): Promise> { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); - const payload$ = schemas$.parse( - input$, - (value$) => - operations.IntegrationsControllerUpdateIntegrationByIdRequest$.outboundSchema.parse( - value$ - ), - "Input validation failed" - ); - const body$ = encodeJSON$("body", payload$.UpdateIntegrationRequestDto, { explode: true }); - - const pathParams$ = { - integrationId: encodeSimple$("integrationId", payload$.integrationId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/integrations/{integrationId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/integrations/active")(); const query$ = ""; @@ -322,22 +320,21 @@ export class Integrations extends ClientSDK { security$ = {}; } const context = { - operationID: "IntegrationsController_updateIntegrationById", + operationID: "IntegrationsController_getActiveIntegrations", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "PUT", + method: "GET", path: path$, headers: headers$, query: query$, - body: body$, }, options ); @@ -362,22 +359,22 @@ export class Integrations extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.IntegrationResponseDto$) - .fail([404, 409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher>() + .json(200, z.array(components.IntegrationResponseDto$.inboundSchema)) + .fail([409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Delete integration + * Set integration as primary */ - async delete( + async setAsPrimary( integrationId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$: operations.IntegrationsControllerRemoveIntegrationRequest = { + ): Promise { + const input$: operations.IntegrationsControllerSetIntegrationAsPrimaryRequest = { integrationId: integrationId, }; const headers$ = new Headers(); @@ -387,7 +384,7 @@ export class Integrations extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.IntegrationsControllerRemoveIntegrationRequest$.outboundSchema.parse( + operations.IntegrationsControllerSetIntegrationAsPrimaryRequest$.outboundSchema.parse( value$ ), "Input validation failed" @@ -400,7 +397,9 @@ export class Integrations extends ClientSDK { charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/integrations/{integrationId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/integrations/{integrationId}/set-primary")( + pathParams$ + ); const query$ = ""; @@ -413,18 +412,18 @@ export class Integrations extends ClientSDK { security$ = {}; } const context = { - operationID: "IntegrationsController_removeIntegration", + operationID: "IntegrationsController_setIntegrationAsPrimary", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "DELETE", + method: "POST", path: path$, headers: headers$, query: query$, @@ -453,37 +452,40 @@ export class Integrations extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(200, z.array(components.IntegrationResponseDto$.inboundSchema)) - .fail([409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .json([200, 201], components.IntegrationResponseDto$) + .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Set integration as primary + * Update integration */ - async setAsPrimary( + async update( integrationId: string, + updateIntegrationRequestDto: components.UpdateIntegrationRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } ): Promise { - const input$: operations.IntegrationsControllerSetIntegrationAsPrimaryRequest = { + const input$: operations.IntegrationsControllerUpdateIntegrationByIdRequest = { integrationId: integrationId, + updateIntegrationRequestDto: updateIntegrationRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.IntegrationsControllerSetIntegrationAsPrimaryRequest$.outboundSchema.parse( + operations.IntegrationsControllerUpdateIntegrationByIdRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$.UpdateIntegrationRequestDto, { explode: true }); const pathParams$ = { integrationId: encodeSimple$("integrationId", payload$.integrationId, { @@ -491,9 +493,7 @@ export class Integrations extends ClientSDK { charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/integrations/{integrationId}/set-primary")( - pathParams$ - ); + const path$ = this.templateURLComponent("/v1/integrations/{integrationId}")(pathParams$); const query$ = ""; @@ -506,7 +506,7 @@ export class Integrations extends ClientSDK { security$ = {}; } const context = { - operationID: "IntegrationsController_setIntegrationAsPrimary", + operationID: "IntegrationsController_updateIntegrationById", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -517,7 +517,7 @@ export class Integrations extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "PUT", path: path$, headers: headers$, query: query$, @@ -547,7 +547,7 @@ export class Integrations extends ClientSDK { ); const [result$] = await this.matcher() - .json([200, 201], components.IntegrationResponseDto$) + .json(200, components.IntegrationResponseDto$) .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/layouts.ts b/src/sdk/layouts.ts index 98504055..f04eb73f 100644 --- a/src/sdk/layouts.ts +++ b/src/sdk/layouts.ts @@ -45,36 +45,21 @@ export class Layouts extends ClientSDK { } /** - * Filter layouts + * Layout creation * * @remarks - * Returns a list of layouts that can be paginated using the `page` query parameter and filtered by the environment where it is executed from the organization the user belongs to. + * Create a layout */ - async list( - request: operations.LayoutsControllerListLayoutsRequest, + async create( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = typeof request === "undefined" ? {} : request; + ): Promise { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); - - const payload$ = schemas$.parse( - input$, - (value$) => - operations.LayoutsControllerListLayoutsRequest$.outboundSchema.parse(value$), - "Input validation failed" - ); - const body$ = null; + headers$.set("Accept", "application/json"); const path$ = this.templateURLComponent("/v1/layouts")(); - const query$ = encodeFormQuery$({ - orderBy: payload$.orderBy, - page: payload$.page, - pageSize: payload$.pageSize, - sortBy: payload$.sortBy, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -85,22 +70,21 @@ export class Layouts extends ClientSDK { security$ = {}; } const context = { - operationID: "LayoutsController_listLayouts", + operationID: "LayoutsController_PropertyDescriptor", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["400", "409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, - body: body$, }, options ); @@ -125,28 +109,46 @@ export class Layouts extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(200, z.void()) - .fail([400, 409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .json(201, components.CreateLayoutResponseDto$) + .fail([409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Layout creation + * Delete layout * * @remarks - * Create a layout + * Execute a soft delete of a layout given a certain ID. */ - async create( + async delete( + layoutId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { + ): Promise { + const input$: operations.LayoutsControllerDeleteLayoutRequest = { + layoutId: layoutId, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); - const path$ = this.templateURLComponent("/v1/layouts")(); + const payload$ = schemas$.parse( + input$, + (value$) => + operations.LayoutsControllerDeleteLayoutRequest$.outboundSchema.parse(value$), + "Input validation failed" + ); + const body$ = null; + + const pathParams$ = { + layoutId: encodeSimple$("layoutId", payload$.layoutId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/layouts/{layoutId}")(pathParams$); const query$ = ""; @@ -159,21 +161,22 @@ export class Layouts extends ClientSDK { security$ = {}; } const context = { - operationID: "LayoutsController_PropertyDescriptor", + operationID: "LayoutsController_deleteLayout", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, + body: body$, }, options ); @@ -198,47 +201,45 @@ export class Layouts extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.CreateLayoutResponseDto$) - .fail([409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .void(204, z.void()) + .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Get layout + * Filter layouts * * @remarks - * Get a layout by its ID + * Returns a list of layouts that can be paginated using the `page` query parameter and filtered by the environment where it is executed from the organization the user belongs to. */ - async retrieve( - layoutId: string, + async list( + request: operations.LayoutsControllerListLayoutsRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.LayoutsControllerGetLayoutRequest = { - layoutId: layoutId, - }; + ): Promise { + const input$ = typeof request === "undefined" ? {} : request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, - (value$) => operations.LayoutsControllerGetLayoutRequest$.outboundSchema.parse(value$), + (value$) => + operations.LayoutsControllerListLayoutsRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const pathParams$ = { - layoutId: encodeSimple$("layoutId", payload$.layoutId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/layouts/{layoutId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/layouts")(); - const query$ = ""; + const query$ = encodeFormQuery$({ + orderBy: payload$.orderBy, + page: payload$.page, + pageSize: payload$.pageSize, + sortBy: payload$.sortBy, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -249,13 +250,13 @@ export class Layouts extends ClientSDK { security$ = {}; } const context = { - operationID: "LayoutsController_getLayout", + operationID: "LayoutsController_listLayouts", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["400", "409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { @@ -289,35 +290,34 @@ export class Layouts extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.GetLayoutResponseDto$) - .fail([404, 409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .void(200, z.void()) + .fail([400, 409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Delete layout + * Get layout * * @remarks - * Execute a soft delete of a layout given a certain ID. + * Get a layout by its ID */ - async delete( + async retrieve( layoutId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.LayoutsControllerDeleteLayoutRequest = { + ): Promise { + const input$: operations.LayoutsControllerGetLayoutRequest = { layoutId: layoutId, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => - operations.LayoutsControllerDeleteLayoutRequest$.outboundSchema.parse(value$), + (value$) => operations.LayoutsControllerGetLayoutRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; @@ -341,7 +341,7 @@ export class Layouts extends ClientSDK { security$ = {}; } const context = { - operationID: "LayoutsController_deleteLayout", + operationID: "LayoutsController_getLayout", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -352,7 +352,7 @@ export class Layouts extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "GET", path: path$, headers: headers$, query: query$, @@ -381,8 +381,8 @@ export class Layouts extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(204, z.void()) + const [result$] = await this.matcher() + .json(200, components.GetLayoutResponseDto$) .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); @@ -390,32 +390,29 @@ export class Layouts extends ClientSDK { } /** - * Update a layout + * Set default layout * * @remarks - * Update the name, content and variables of a layout. Also change it to be default or no. + * Sets the default layout for the environment and updates to non default to the existing default layout (if any). */ - async update( + async setAsDefault( layoutId: string, - updateLayoutRequestDto: components.UpdateLayoutRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.LayoutsControllerUpdateLayoutRequest = { + ): Promise { + const input$: operations.LayoutsControllerSetDefaultLayoutRequest = { layoutId: layoutId, - updateLayoutRequestDto: updateLayoutRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, (value$) => - operations.LayoutsControllerUpdateLayoutRequest$.outboundSchema.parse(value$), + operations.LayoutsControllerSetDefaultLayoutRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.UpdateLayoutRequestDto, { explode: true }); + const body$ = null; const pathParams$ = { layoutId: encodeSimple$("layoutId", payload$.layoutId, { @@ -423,7 +420,7 @@ export class Layouts extends ClientSDK { charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/layouts/{layoutId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/layouts/{layoutId}/default")(pathParams$); const query$ = ""; @@ -436,21 +433,18 @@ export class Layouts extends ClientSDK { security$ = {}; } const context = { - operationID: "LayoutsController_updateLayout", + operationID: "LayoutsController_setDefaultLayout", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { - context, - errorCodes: ["400", "404", "409", "429", "4XX", "503", "5XX"], - }; + const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "PATCH", + method: "POST", path: path$, headers: headers$, query: query$, @@ -479,38 +473,41 @@ export class Layouts extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.UpdateLayoutResponseDto$) - .fail([400, 404, 409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .void(204, z.void()) + .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Set default layout + * Update a layout * * @remarks - * Sets the default layout for the environment and updates to non default to the existing default layout (if any). + * Update the name, content and variables of a layout. Also change it to be default or no. */ - async setAsDefault( + async update( layoutId: string, + updateLayoutRequestDto: components.UpdateLayoutRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.LayoutsControllerSetDefaultLayoutRequest = { + ): Promise { + const input$: operations.LayoutsControllerUpdateLayoutRequest = { layoutId: layoutId, + updateLayoutRequestDto: updateLayoutRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); + headers$.set("Content-Type", "application/json"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.LayoutsControllerSetDefaultLayoutRequest$.outboundSchema.parse(value$), + operations.LayoutsControllerUpdateLayoutRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$.UpdateLayoutRequestDto, { explode: true }); const pathParams$ = { layoutId: encodeSimple$("layoutId", payload$.layoutId, { @@ -518,7 +515,7 @@ export class Layouts extends ClientSDK { charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/layouts/{layoutId}/default")(pathParams$); + const path$ = this.templateURLComponent("/v1/layouts/{layoutId}")(pathParams$); const query$ = ""; @@ -531,18 +528,21 @@ export class Layouts extends ClientSDK { security$ = {}; } const context = { - operationID: "LayoutsController_setDefaultLayout", + operationID: "LayoutsController_updateLayout", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; + const doOptions = { + context, + errorCodes: ["400", "404", "409", "429", "4XX", "503", "5XX"], + }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "POST", + method: "PATCH", path: path$, headers: headers$, query: query$, @@ -571,9 +571,9 @@ export class Layouts extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(204, z.void()) - .fail([404, 409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .json(200, components.UpdateLayoutResponseDto$) + .fail([400, 404, 409, 429, "4XX", 503, "5XX"]) .match(response); return result$; diff --git a/src/sdk/messages.ts b/src/sdk/messages.ts index 4365277e..0efd9dfe 100644 --- a/src/sdk/messages.ts +++ b/src/sdk/messages.ts @@ -44,16 +44,18 @@ export class Messages extends ClientSDK { } /** - * Get messages + * Delete message * * @remarks - * Returns a list of messages, could paginate using the `page` query parameter + * Deletes a message entity from the Novu platform */ - async retrieve( - request: operations.MessagesControllerGetMessagesRequest, + async delete( + messageId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = typeof request === "undefined" ? {} : request; + ): Promise { + const input$: operations.MessagesControllerDeleteMessageRequest = { + messageId: messageId, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); @@ -61,20 +63,20 @@ export class Messages extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.MessagesControllerGetMessagesRequest$.outboundSchema.parse(value$), + operations.MessagesControllerDeleteMessageRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const path$ = this.templateURLComponent("/v1/messages")(); + const pathParams$ = { + messageId: encodeSimple$("messageId", payload$.messageId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/messages/{messageId}")(pathParams$); - const query$ = encodeFormQuery$({ - channel: payload$.channel, - limit: payload$.limit, - page: payload$.page, - subscriberId: payload$.subscriberId, - transactionId: payload$.transactionId, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -85,7 +87,7 @@ export class Messages extends ClientSDK { security$ = {}; } const context = { - operationID: "MessagesController_getMessages", + operationID: "MessagesController_deleteMessage", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -96,7 +98,7 @@ export class Messages extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -125,8 +127,8 @@ export class Messages extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.ActivitiesResponseDto$) + const [result$] = await this.matcher() + .json(200, components.DeleteMessageResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -134,39 +136,47 @@ export class Messages extends ClientSDK { } /** - * Delete message + * Delete messages by transactionId * * @remarks - * Deletes a message entity from the Novu platform + * Deletes messages entity from the Novu platform using TransactionId of message */ - async delete( - messageId: string, + async deleteByTransactionId( + transactionId: string, + channel?: operations.Channel | undefined, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.MessagesControllerDeleteMessageRequest = { - messageId: messageId, + ): Promise { + const input$: operations.MessagesControllerDeleteMessagesByTransactionIdRequest = { + channel: channel, + transactionId: transactionId, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, (value$) => - operations.MessagesControllerDeleteMessageRequest$.outboundSchema.parse(value$), + operations.MessagesControllerDeleteMessagesByTransactionIdRequest$.outboundSchema.parse( + value$ + ), "Input validation failed" ); const body$ = null; const pathParams$ = { - messageId: encodeSimple$("messageId", payload$.messageId, { + transactionId: encodeSimple$("transactionId", payload$.transactionId, { explode: false, charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/messages/{messageId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/messages/transaction/{transactionId}")( + pathParams$ + ); - const query$ = ""; + const query$ = encodeFormQuery$({ + channel: payload$.channel, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -177,7 +187,7 @@ export class Messages extends ClientSDK { security$ = {}; } const context = { - operationID: "MessagesController_deleteMessage", + operationID: "MessagesController_deleteMessagesByTransactionId", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -217,8 +227,8 @@ export class Messages extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.DeleteMessageResponseDto$) + const [result$] = await this.matcher() + .void(204, z.void()) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -226,46 +236,36 @@ export class Messages extends ClientSDK { } /** - * Delete messages by transactionId + * Get messages * * @remarks - * Deletes messages entity from the Novu platform using TransactionId of message + * Returns a list of messages, could paginate using the `page` query parameter */ - async deleteByTransactionId( - transactionId: string, - channel?: operations.QueryParamChannel | undefined, + async retrieve( + request: operations.MessagesControllerGetMessagesRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.MessagesControllerDeleteMessagesByTransactionIdRequest = { - channel: channel, - transactionId: transactionId, - }; + ): Promise { + const input$ = typeof request === "undefined" ? {} : request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.MessagesControllerDeleteMessagesByTransactionIdRequest$.outboundSchema.parse( - value$ - ), + operations.MessagesControllerGetMessagesRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const pathParams$ = { - transactionId: encodeSimple$("transactionId", payload$.transactionId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/messages/transaction/{transactionId}")( - pathParams$ - ); + const path$ = this.templateURLComponent("/v1/messages")(); const query$ = encodeFormQuery$({ channel: payload$.channel, + limit: payload$.limit, + page: payload$.page, + subscriberId: payload$.subscriberId, + transactionId: payload$.transactionId, }); let security$; @@ -277,7 +277,7 @@ export class Messages extends ClientSDK { security$ = {}; } const context = { - operationID: "MessagesController_deleteMessagesByTransactionId", + operationID: "MessagesController_getMessages", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -288,7 +288,7 @@ export class Messages extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "GET", path: path$, headers: headers$, query: query$, @@ -317,8 +317,8 @@ export class Messages extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(204, z.void()) + const [result$] = await this.matcher() + .json(200, components.ActivitiesResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/novumessages.ts b/src/sdk/novumessages.ts index d70873fe..a0a8802c 100644 --- a/src/sdk/novumessages.ts +++ b/src/sdk/novumessages.ts @@ -41,16 +41,16 @@ export class NovuMessages extends ClientSDK { } /** - * Mark a subscriber messages as seen, read, unseen or unread + * Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed. */ - async markAllAs( + async markAll( subscriberId: string, - messageMarkAsRequestDto: components.MessageMarkAsRequestDto, + markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$: operations.SubscribersControllerMarkMessagesAsRequest = { + ): Promise { + const input$: operations.SubscribersControllerMarkAllUnreadAsReadRequest = { subscriberId: subscriberId, - messageMarkAsRequestDto: messageMarkAsRequestDto, + markAllMessageAsRequestDto: markAllMessageAsRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); @@ -60,10 +60,12 @@ export class NovuMessages extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerMarkMessagesAsRequest$.outboundSchema.parse(value$), + operations.SubscribersControllerMarkAllUnreadAsReadRequest$.outboundSchema.parse( + value$ + ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.MessageMarkAsRequestDto, { explode: true }); + const body$ = encodeJSON$("body", payload$.MarkAllMessageAsRequestDto, { explode: true }); const pathParams$ = { subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { @@ -71,7 +73,7 @@ export class NovuMessages extends ClientSDK { charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/messages/mark-as")( + const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/messages/mark-all")( pathParams$ ); @@ -86,7 +88,7 @@ export class NovuMessages extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_markMessagesAs", + operationID: "SubscribersController_markAllUnreadAsRead", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -126,8 +128,8 @@ export class NovuMessages extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(201, z.array(components.MessageEntity$.inboundSchema)) + const [result$] = await this.matcher() + .json(201, z.number()) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -135,16 +137,16 @@ export class NovuMessages extends ClientSDK { } /** - * Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed. + * Mark a subscriber messages as seen, read, unseen or unread */ - async markAll( + async markAllAs( subscriberId: string, - markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto, + messageMarkAsRequestDto: components.MessageMarkAsRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.SubscribersControllerMarkAllUnreadAsReadRequest = { + ): Promise> { + const input$: operations.SubscribersControllerMarkMessagesAsRequest = { subscriberId: subscriberId, - markAllMessageAsRequestDto: markAllMessageAsRequestDto, + messageMarkAsRequestDto: messageMarkAsRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); @@ -154,12 +156,10 @@ export class NovuMessages extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerMarkAllUnreadAsReadRequest$.outboundSchema.parse( - value$ - ), + operations.SubscribersControllerMarkMessagesAsRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.MarkAllMessageAsRequestDto, { explode: true }); + const body$ = encodeJSON$("body", payload$.MessageMarkAsRequestDto, { explode: true }); const pathParams$ = { subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { @@ -167,7 +167,7 @@ export class NovuMessages extends ClientSDK { charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/messages/mark-all")( + const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/messages/mark-as")( pathParams$ ); @@ -182,7 +182,7 @@ export class NovuMessages extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_markAllUnreadAsRead", + operationID: "SubscribersController_markMessagesAs", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -222,8 +222,8 @@ export class NovuMessages extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, z.number()) + const [result$] = await this.matcher>() + .json(201, z.array(components.MessageEntity$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/novusubscribers.ts b/src/sdk/novusubscribers.ts index d453cb13..8c3cfd43 100644 --- a/src/sdk/novusubscribers.ts +++ b/src/sdk/novusubscribers.ts @@ -136,46 +136,42 @@ export class NovuSubscribers extends ClientSDK { } /** - * Check topic subscriber + * Subscribers removal * * @remarks - * Check if a subscriber belongs to a certain topic + * Remove subscribers from a topic */ - async retrieve( + async delete( topicKey: string, - externalSubscriberId: string, + removeSubscribersRequestDto: components.RemoveSubscribersRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.TopicsControllerGetTopicSubscriberRequest = { + ): Promise { + const input$: operations.TopicsControllerRemoveSubscribersRequest = { topicKey: topicKey, - externalSubscriberId: externalSubscriberId, + removeSubscribersRequestDto: removeSubscribersRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "application/json"); + headers$.set("Content-Type", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, (value$) => - operations.TopicsControllerGetTopicSubscriberRequest$.outboundSchema.parse(value$), + operations.TopicsControllerRemoveSubscribersRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$.RemoveSubscribersRequestDto, { explode: true }); const pathParams$ = { - externalSubscriberId: encodeSimple$( - "externalSubscriberId", - payload$.externalSubscriberId, - { explode: false, charEncoding: "percent" } - ), topicKey: encodeSimple$("topicKey", payload$.topicKey, { explode: false, charEncoding: "percent", }), }; - const path$ = this.templateURLComponent( - "/v1/topics/{topicKey}/subscribers/{externalSubscriberId}" - )(pathParams$); + const path$ = this.templateURLComponent("/v1/topics/{topicKey}/subscribers/removal")( + pathParams$ + ); const query$ = ""; @@ -188,7 +184,7 @@ export class NovuSubscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "TopicsController_getTopicSubscriber", + operationID: "TopicsController_removeSubscribers", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -199,7 +195,7 @@ export class NovuSubscribers extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, @@ -228,8 +224,8 @@ export class NovuSubscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.TopicSubscriberDto$) + const [result$] = await this.matcher() + .void(204, z.void()) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -237,42 +233,46 @@ export class NovuSubscribers extends ClientSDK { } /** - * Subscribers removal + * Check topic subscriber * * @remarks - * Remove subscribers from a topic + * Check if a subscriber belongs to a certain topic */ - async delete( + async retrieve( topicKey: string, - removeSubscribersRequestDto: components.RemoveSubscribersRequestDto, + externalSubscriberId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.TopicsControllerRemoveSubscribersRequest = { + ): Promise { + const input$: operations.TopicsControllerGetTopicSubscriberRequest = { topicKey: topicKey, - removeSubscribersRequestDto: removeSubscribersRequestDto, + externalSubscriberId: externalSubscriberId, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); - headers$.set("Accept", "*/*"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.TopicsControllerRemoveSubscribersRequest$.outboundSchema.parse(value$), + operations.TopicsControllerGetTopicSubscriberRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.RemoveSubscribersRequestDto, { explode: true }); + const body$ = null; const pathParams$ = { + externalSubscriberId: encodeSimple$( + "externalSubscriberId", + payload$.externalSubscriberId, + { explode: false, charEncoding: "percent" } + ), topicKey: encodeSimple$("topicKey", payload$.topicKey, { explode: false, charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/topics/{topicKey}/subscribers/removal")( - pathParams$ - ); + const path$ = this.templateURLComponent( + "/v1/topics/{topicKey}/subscribers/{externalSubscriberId}" + )(pathParams$); const query$ = ""; @@ -285,7 +285,7 @@ export class NovuSubscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "TopicsController_removeSubscribers", + operationID: "TopicsController_getTopicSubscriber", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -296,7 +296,7 @@ export class NovuSubscribers extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "GET", path: path$, headers: headers$, query: query$, @@ -325,8 +325,8 @@ export class NovuSubscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(204, z.void()) + const [result$] = await this.matcher() + .json(200, components.TopicSubscriberDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/organizations.ts b/src/sdk/organizations.ts index a04abd40..041f1bb1 100644 --- a/src/sdk/organizations.ts +++ b/src/sdk/organizations.ts @@ -41,26 +41,36 @@ export class Organizations extends ClientSDK { void this.options$; } - private _members?: Members; - get members(): Members { - return (this._members ??= new Members(this.options$)); - } - private _branding?: Branding; get branding(): Branding { return (this._branding ??= new Branding(this.options$)); } + private _members?: Members; + get members(): Members { + return (this._members ??= new Members(this.options$)); + } + /** - * Fetch all organizations + * Create an organization */ - async list( + async create( + request: components.CreateOrganizationDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); + const payload$ = schemas$.parse( + input$, + (value$) => components.CreateOrganizationDto$.outboundSchema.parse(value$), + "Input validation failed" + ); + const body$ = encodeJSON$("body", payload$, { explode: true }); + const path$ = this.templateURLComponent("/v1/organizations")(); const query$ = ""; @@ -74,7 +84,7 @@ export class Organizations extends ClientSDK { security$ = {}; } const context = { - operationID: "OrganizationController_listOrganizations", + operationID: "OrganizationController_createOrganization", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +95,11 @@ export class Organizations extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, + body: body$, }, options ); @@ -113,8 +124,8 @@ export class Organizations extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(200, z.array(components.OrganizationResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(201, components.OrganizationResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -122,25 +133,15 @@ export class Organizations extends ClientSDK { } /** - * Create an organization + * Fetch all organizations */ - async create( - request: components.CreateOrganizationDto, + async list( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise> { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); - const payload$ = schemas$.parse( - input$, - (value$) => components.CreateOrganizationDto$.outboundSchema.parse(value$), - "Input validation failed" - ); - const body$ = encodeJSON$("body", payload$, { explode: true }); - const path$ = this.templateURLComponent("/v1/organizations")(); const query$ = ""; @@ -154,7 +155,7 @@ export class Organizations extends ClientSDK { security$ = {}; } const context = { - operationID: "OrganizationController_createOrganization", + operationID: "OrganizationController_listOrganizations", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -165,11 +166,10 @@ export class Organizations extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "GET", path: path$, headers: headers$, query: query$, - body: body$, }, options ); @@ -194,8 +194,8 @@ export class Organizations extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.OrganizationResponseDto$) + const [result$] = await this.matcher>() + .json(200, z.array(components.OrganizationResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/preferences.ts b/src/sdk/preferences.ts index ebfbb746..54cf4dd9 100644 --- a/src/sdk/preferences.ts +++ b/src/sdk/preferences.ts @@ -136,44 +136,44 @@ export class Preferences extends ClientSDK { } /** - * Update subscriber global preferences + * Get subscriber preferences by level */ - async updateGlobal( + async retrieveByLevel( + parameter: string, subscriberId: string, - updateSubscriberGlobalPreferencesRequestDto: components.UpdateSubscriberGlobalPreferencesRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest = { + ): Promise> { + const input$: operations.SubscribersControllerGetSubscriberPreferenceByLevelRequest = { + parameter: parameter, subscriberId: subscriberId, - updateSubscriberGlobalPreferencesRequestDto: - updateSubscriberGlobalPreferencesRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest$.outboundSchema.parse( + operations.SubscribersControllerGetSubscriberPreferenceByLevelRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.UpdateSubscriberGlobalPreferencesRequestDto, { - explode: true, - }); + const body$ = null; const pathParams$ = { + parameter: encodeSimple$("parameter", payload$.parameter, { + explode: false, + charEncoding: "percent", + }), subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { explode: false, charEncoding: "percent", }), }; - const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/preferences")( - pathParams$ - ); + const path$ = this.templateURLComponent( + "/v1/subscribers/{subscriberId}/preferences/{parameter}" + )(pathParams$); const query$ = ""; @@ -186,7 +186,7 @@ export class Preferences extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_updateSubscriberGlobalPreferences", + operationID: "SubscribersController_getSubscriberPreferenceByLevel", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -197,7 +197,7 @@ export class Preferences extends ClientSDK { context, { security: securitySettings$, - method: "PATCH", + method: "GET", path: path$, headers: headers$, query: query$, @@ -226,8 +226,10 @@ export class Preferences extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.UpdateSubscriberPreferenceResponseDto$) + const [result$] = await this.matcher< + Array + >() + .json(200, z.array(components.GetSubscriberPreferencesResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -235,30 +237,29 @@ export class Preferences extends ClientSDK { } /** - * Get subscriber preferences by level + * Update subscriber preference */ - async retrieveByLevel( - parameter: string, - subscriberId: string, + async update( + request: operations.SubscribersControllerUpdateSubscriberPreferenceRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$: operations.SubscribersControllerGetSubscriberPreferenceByLevelRequest = { - parameter: parameter, - subscriberId: subscriberId, - }; + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerGetSubscriberPreferenceByLevelRequest$.outboundSchema.parse( + operations.SubscribersControllerUpdateSubscriberPreferenceRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$.UpdateSubscriberPreferenceRequestDto, { + explode: true, + }); const pathParams$ = { parameter: encodeSimple$("parameter", payload$.parameter, { @@ -285,7 +286,7 @@ export class Preferences extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_getSubscriberPreferenceByLevel", + operationID: "SubscribersController_updateSubscriberPreference", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -296,7 +297,7 @@ export class Preferences extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "PATCH", path: path$, headers: headers$, query: query$, @@ -325,10 +326,8 @@ export class Preferences extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher< - Array - >() - .json(200, z.array(components.GetSubscriberPreferencesResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(200, components.UpdateSubscriberPreferenceResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -336,13 +335,18 @@ export class Preferences extends ClientSDK { } /** - * Update subscriber preference + * Update subscriber global preferences */ - async update( - request: operations.SubscribersControllerUpdateSubscriberPreferenceRequest, + async updateGlobal( + subscriberId: string, + updateSubscriberGlobalPreferencesRequestDto: components.UpdateSubscriberGlobalPreferencesRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } ): Promise { - const input$ = request; + const input$: operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest = { + subscriberId: subscriberId, + updateSubscriberGlobalPreferencesRequestDto: + updateSubscriberGlobalPreferencesRequestDto, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Content-Type", "application/json"); @@ -351,28 +355,24 @@ export class Preferences extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerUpdateSubscriberPreferenceRequest$.outboundSchema.parse( + operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.UpdateSubscriberPreferenceRequestDto, { + const body$ = encodeJSON$("body", payload$.UpdateSubscriberGlobalPreferencesRequestDto, { explode: true, }); const pathParams$ = { - parameter: encodeSimple$("parameter", payload$.parameter, { - explode: false, - charEncoding: "percent", - }), subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { explode: false, charEncoding: "percent", }), }; - const path$ = this.templateURLComponent( - "/v1/subscribers/{subscriberId}/preferences/{parameter}" - )(pathParams$); + const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/preferences")( + pathParams$ + ); const query$ = ""; @@ -385,7 +385,7 @@ export class Preferences extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_updateSubscriberPreference", + operationID: "SubscribersController_updateSubscriberGlobalPreferences", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; diff --git a/src/sdk/sdk.ts b/src/sdk/sdk.ts index 2f15c781..5b395f30 100644 --- a/src/sdk/sdk.ts +++ b/src/sdk/sdk.ts @@ -49,9 +49,9 @@ export class Novu extends ClientSDK { void this.options$; } - private _organizations?: Organizations; - get organizations(): Organizations { - return (this._organizations ??= new Organizations(this.options$)); + private _changes?: Changes; + get changes(): Changes { + return (this._changes ??= new Changes(this.options$)); } private _environments?: Environments; @@ -59,24 +59,34 @@ export class Novu extends ClientSDK { return (this._environments ??= new Environments(this.options$)); } + private _events?: Events; + get events(): Events { + return (this._events ??= new Events(this.options$)); + } + private _executionDetails?: ExecutionDetails; get executionDetails(): ExecutionDetails { return (this._executionDetails ??= new ExecutionDetails(this.options$)); } - private _workflows?: Workflows; - get workflows(): Workflows { - return (this._workflows ??= new Workflows(this.options$)); + private _feeds?: Feeds; + get feeds(): Feeds { + return (this._feeds ??= new Feeds(this.options$)); } - private _events?: Events; - get events(): Events { - return (this._events ??= new Events(this.options$)); + private _integrations?: Integrations; + get integrations(): Integrations { + return (this._integrations ??= new Integrations(this.options$)); } - private _notifications?: Notifications; - get notifications(): Notifications { - return (this._notifications ??= new Notifications(this.options$)); + private _layouts?: Layouts; + get layouts(): Layouts { + return (this._layouts ??= new Layouts(this.options$)); + } + + private _messages?: Messages; + get messages(): Messages { + return (this._messages ??= new Messages(this.options$)); } private _workflowGroups?: WorkflowGroups; @@ -84,14 +94,14 @@ export class Novu extends ClientSDK { return (this._workflowGroups ??= new WorkflowGroups(this.options$)); } - private _integrations?: Integrations; - get integrations(): Integrations { - return (this._integrations ??= new Integrations(this.options$)); + private _notifications?: Notifications; + get notifications(): Notifications { + return (this._notifications ??= new Notifications(this.options$)); } - private _changes?: Changes; - get changes(): Changes { - return (this._changes ??= new Changes(this.options$)); + private _organizations?: Organizations; + get organizations(): Organizations { + return (this._organizations ??= new Organizations(this.options$)); } private _subscribers?: Subscribers; @@ -99,19 +109,9 @@ export class Novu extends ClientSDK { return (this._subscribers ??= new Subscribers(this.options$)); } - private _feeds?: Feeds; - get feeds(): Feeds { - return (this._feeds ??= new Feeds(this.options$)); - } - - private _layouts?: Layouts; - get layouts(): Layouts { - return (this._layouts ??= new Layouts(this.options$)); - } - - private _messages?: Messages; - get messages(): Messages { - return (this._messages ??= new Messages(this.options$)); + private _tenants?: Tenants; + get tenants(): Tenants { + return (this._tenants ??= new Tenants(this.options$)); } private _topics?: Topics; @@ -119,8 +119,8 @@ export class Novu extends ClientSDK { return (this._topics ??= new Topics(this.options$)); } - private _tenants?: Tenants; - get tenants(): Tenants { - return (this._tenants ??= new Tenants(this.options$)); + private _workflows?: Workflows; + get workflows(): Workflows { + return (this._workflows ??= new Workflows(this.options$)); } } diff --git a/src/sdk/stats.ts b/src/sdk/stats.ts index e835123d..f7402451 100644 --- a/src/sdk/stats.ts +++ b/src/sdk/stats.ts @@ -41,18 +41,34 @@ export class Stats extends ClientSDK { } /** - * Get notification statistics + * Get notification graph statistics */ - async retrieve( + async graph( + days?: number | undefined, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { + ): Promise> { + const input$: operations.NotificationsControllerGetActivityGraphStatsRequest = { + days: days, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); - const path$ = this.templateURLComponent("/v1/notifications/stats")(); + const payload$ = schemas$.parse( + input$, + (value$) => + operations.NotificationsControllerGetActivityGraphStatsRequest$.outboundSchema.parse( + value$ + ), + "Input validation failed" + ); + const body$ = null; - const query$ = ""; + const path$ = this.templateURLComponent("/v1/notifications/graph/stats")(); + + const query$ = encodeFormQuery$({ + days: payload$.days, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -63,7 +79,7 @@ export class Stats extends ClientSDK { security$ = {}; } const context = { - operationID: "NotificationsController_getActivityStats", + operationID: "NotificationsController_getActivityGraphStats", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -78,6 +94,7 @@ export class Stats extends ClientSDK { path: path$, headers: headers$, query: query$, + body: body$, }, options ); @@ -102,8 +119,8 @@ export class Stats extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.ActivityStatsResponseDto$) + const [result$] = await this.matcher>() + .json(200, z.array(components.ActivityGraphStatesResponse$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -111,34 +128,18 @@ export class Stats extends ClientSDK { } /** - * Get notification graph statistics + * Get notification statistics */ - async graph( - days?: number | undefined, + async retrieve( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$: operations.NotificationsControllerGetActivityGraphStatsRequest = { - days: days, - }; + ): Promise { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); - const payload$ = schemas$.parse( - input$, - (value$) => - operations.NotificationsControllerGetActivityGraphStatsRequest$.outboundSchema.parse( - value$ - ), - "Input validation failed" - ); - const body$ = null; - - const path$ = this.templateURLComponent("/v1/notifications/graph/stats")(); + const path$ = this.templateURLComponent("/v1/notifications/stats")(); - const query$ = encodeFormQuery$({ - days: payload$.days, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -149,7 +150,7 @@ export class Stats extends ClientSDK { security$ = {}; } const context = { - operationID: "NotificationsController_getActivityGraphStats", + operationID: "NotificationsController_getActivityStats", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -164,7 +165,6 @@ export class Stats extends ClientSDK { path: path$, headers: headers$, query: query$, - body: body$, }, options ); @@ -189,8 +189,8 @@ export class Stats extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(200, z.array(components.ActivityGraphStatesResponse$.inboundSchema)) + const [result$] = await this.matcher() + .json(200, components.ActivityStatsResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/subscribers.ts b/src/sdk/subscribers.ts index cb545337..156c5eb8 100644 --- a/src/sdk/subscribers.ts +++ b/src/sdk/subscribers.ts @@ -57,14 +57,14 @@ export class Subscribers extends ClientSDK { return (this._credentials ??= new Credentials(this.options$)); } - private _properties?: Properties; - get properties(): Properties { - return (this._properties ??= new Properties(this.options$)); + private _authentication?: Authentication; + get authentication(): Authentication { + return (this._authentication ??= new Authentication(this.options$)); } - private _preferences?: Preferences; - get preferences(): Preferences { - return (this._preferences ??= new Preferences(this.options$)); + private _messages?: NovuMessages; + get messages(): NovuMessages { + return (this._messages ??= new NovuMessages(this.options$)); } private _notifications?: NovuNotifications; @@ -72,51 +72,42 @@ export class Subscribers extends ClientSDK { return (this._notifications ??= new NovuNotifications(this.options$)); } - private _messages?: NovuMessages; - get messages(): NovuMessages { - return (this._messages ??= new NovuMessages(this.options$)); + private _properties?: Properties; + get properties(): Properties { + return (this._properties ??= new Properties(this.options$)); } - private _authentication?: Authentication; - get authentication(): Authentication { - return (this._authentication ??= new Authentication(this.options$)); + private _preferences?: Preferences; + get preferences(): Preferences { + return (this._preferences ??= new Preferences(this.options$)); } /** - * Get subscribers + * Create subscriber * * @remarks - * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter + * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity. */ - async list( - page?: number | undefined, - limit?: number | undefined, + async create( + request: components.CreateSubscriberRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$: operations.SubscribersControllerListSubscribersRequest = { - page: page, - limit: limit, - }; + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => - operations.SubscribersControllerListSubscribersRequest$.outboundSchema.parse( - value$ - ), + (value$) => components.CreateSubscriberRequestDto$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$, { explode: true }); const path$ = this.templateURLComponent("/v1/subscribers")(); - const query$ = encodeFormQuery$({ - limit: payload$.limit, - page: payload$.page, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -127,7 +118,7 @@ export class Subscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_listSubscribers", + operationID: "SubscribersController_createSubscriber", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -138,7 +129,7 @@ export class Subscribers extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, @@ -167,67 +158,41 @@ export class Subscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const responseFields$ = { - HttpMeta: { Response: response, Request: request$ }, - }; - - const [result$, raw$] = - await this.matcher() - .json(200, operations.SubscribersControllerListSubscribersResponse$, { - key: "Result", - }) - .fail([409, 429, "4XX", 503, "5XX"]) - .match(response, { extraFields: responseFields$ }); - - const nextFunc = ( - responseData: unknown - ): Paginator => { - const page = input$.page || 0; - const nextPage = page + 1; - - if (!responseData) { - return () => null; - } - const results = jp.value(responseData, "$.data.resultArray"); - if (!results.length) { - return () => null; - } - const limit = input$.limit || 0; - if (results.length < limit) { - return () => null; - } - - return () => this.list(nextPage, limit, options); - }; + const [result$] = await this.matcher() + .json(201, components.SubscriberResponseDto$) + .fail([409, 429, "4XX", 503, "5XX"]) + .match(response); - const page$ = { ...result$, next: nextFunc(raw$) }; - return { ...page$, ...createPageIterator(page$) }; + return result$; } /** - * Create subscriber + * Bulk create subscribers * * @remarks - * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity. + * + * Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API. + * The bulk API is limited to 500 subscribers per request. + * */ - async create( - request: components.CreateSubscriberRequestDto, + async createBulk( + request: components.BulkSubscriberCreateDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { + ): Promise { const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Content-Type", "application/json"); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, - (value$) => components.CreateSubscriberRequestDto$.outboundSchema.parse(value$), + (value$) => components.BulkSubscriberCreateDto$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = encodeJSON$("body", payload$, { explode: true }); - const path$ = this.templateURLComponent("/v1/subscribers")(); + const path$ = this.templateURLComponent("/v1/subscribers/bulk")(); const query$ = ""; @@ -240,7 +205,7 @@ export class Subscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_createSubscriber", + operationID: "SubscribersController_bulkCreateSubscribers", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -280,8 +245,8 @@ export class Subscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.SubscriberResponseDto$) + const [result$] = await this.matcher() + .void(201, z.void()) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -289,16 +254,16 @@ export class Subscribers extends ClientSDK { } /** - * Get subscriber + * Delete subscriber * * @remarks - * Get subscriber by your internal id used to identify the subscriber + * Deletes a subscriber entity from the Novu platform */ - async retrieve( + async delete( subscriberId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.SubscribersControllerGetSubscriberRequest = { + ): Promise { + const input$: operations.SubscribersControllerRemoveSubscriberRequest = { subscriberId: subscriberId, }; const headers$ = new Headers(); @@ -308,7 +273,9 @@ export class Subscribers extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerGetSubscriberRequest$.outboundSchema.parse(value$), + operations.SubscribersControllerRemoveSubscriberRequest$.outboundSchema.parse( + value$ + ), "Input validation failed" ); const body$ = null; @@ -332,7 +299,7 @@ export class Subscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_getSubscriber", + operationID: "SubscribersController_removeSubscriber", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -343,7 +310,7 @@ export class Subscribers extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -372,8 +339,8 @@ export class Subscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.SubscriberResponseDto$) + const [result$] = await this.matcher() + .json(200, components.DeleteSubscriberResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -381,44 +348,40 @@ export class Subscribers extends ClientSDK { } /** - * Update subscriber + * Get subscribers * * @remarks - * Used to update the subscriber entity with new information + * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter */ - async update( - subscriberId: string, - updateSubscriberRequestDto: components.UpdateSubscriberRequestDto, + async list( + page?: number | undefined, + limit?: number | undefined, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.SubscribersControllerUpdateSubscriberRequest = { - subscriberId: subscriberId, - updateSubscriberRequestDto: updateSubscriberRequestDto, + ): Promise> { + const input$: operations.SubscribersControllerListSubscribersRequest = { + page: page, + limit: limit, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerUpdateSubscriberRequest$.outboundSchema.parse( + operations.SubscribersControllerListSubscribersRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.UpdateSubscriberRequestDto, { explode: true }); + const body$ = null; - const pathParams$ = { - subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/subscribers")(); - const query$ = ""; + const query$ = encodeFormQuery$({ + limit: payload$.limit, + page: payload$.page, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -429,7 +392,7 @@ export class Subscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_updateSubscriber", + operationID: "SubscribersController_listSubscribers", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -440,7 +403,7 @@ export class Subscribers extends ClientSDK { context, { security: securitySettings$, - method: "PUT", + method: "GET", path: path$, headers: headers$, query: query$, @@ -469,25 +432,54 @@ export class Subscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.SubscriberResponseDto$) - .fail([409, 429, "4XX", 503, "5XX"]) - .match(response); + const responseFields$ = { + HttpMeta: { Response: response, Request: request$ }, + }; - return result$; + const [result$, raw$] = + await this.matcher() + .json(200, operations.SubscribersControllerListSubscribersResponse$, { + key: "Result", + }) + .fail([409, 429, "4XX", 503, "5XX"]) + .match(response, { extraFields: responseFields$ }); + + const nextFunc = ( + responseData: unknown + ): Paginator => { + const page = input$.page || 0; + const nextPage = page + 1; + + if (!responseData) { + return () => null; + } + const results = jp.value(responseData, "$.data.resultArray"); + if (!results.length) { + return () => null; + } + const limit = input$.limit || 0; + if (results.length < limit) { + return () => null; + } + + return () => this.list(nextPage, limit, options); + }; + + const page$ = { ...result$, next: nextFunc(raw$) }; + return { ...page$, ...createPageIterator(page$) }; } /** - * Delete subscriber + * Get subscriber * * @remarks - * Deletes a subscriber entity from the Novu platform + * Get subscriber by your internal id used to identify the subscriber */ - async delete( + async retrieve( subscriberId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.SubscribersControllerRemoveSubscriberRequest = { + ): Promise { + const input$: operations.SubscribersControllerGetSubscriberRequest = { subscriberId: subscriberId, }; const headers$ = new Headers(); @@ -497,9 +489,7 @@ export class Subscribers extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.SubscribersControllerRemoveSubscriberRequest$.outboundSchema.parse( - value$ - ), + operations.SubscribersControllerGetSubscriberRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; @@ -523,7 +513,7 @@ export class Subscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_removeSubscriber", + operationID: "SubscribersController_getSubscriber", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -534,7 +524,7 @@ export class Subscribers extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "GET", path: path$, headers: headers$, query: query$, @@ -563,8 +553,8 @@ export class Subscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.DeleteSubscriberResponseDto$) + const [result$] = await this.matcher() + .json(200, components.SubscriberResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -572,32 +562,42 @@ export class Subscribers extends ClientSDK { } /** - * Bulk create subscribers + * Update subscriber * * @remarks - * - * Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API. - * The bulk API is limited to 500 subscribers per request. - * + * Used to update the subscriber entity with new information */ - async createBulk( - request: components.BulkSubscriberCreateDto, + async update( + subscriberId: string, + updateSubscriberRequestDto: components.UpdateSubscriberRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise { + const input$: operations.SubscribersControllerUpdateSubscriberRequest = { + subscriberId: subscriberId, + updateSubscriberRequestDto: updateSubscriberRequestDto, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Content-Type", "application/json"); - headers$.set("Accept", "*/*"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => components.BulkSubscriberCreateDto$.outboundSchema.parse(value$), + (value$) => + operations.SubscribersControllerUpdateSubscriberRequest$.outboundSchema.parse( + value$ + ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = encodeJSON$("body", payload$.UpdateSubscriberRequestDto, { explode: true }); - const path$ = this.templateURLComponent("/v1/subscribers/bulk")(); + const pathParams$ = { + subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}")(pathParams$); const query$ = ""; @@ -610,7 +610,7 @@ export class Subscribers extends ClientSDK { security$ = {}; } const context = { - operationID: "SubscribersController_bulkCreateSubscribers", + operationID: "SubscribersController_updateSubscriber", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -621,7 +621,7 @@ export class Subscribers extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "PUT", path: path$, headers: headers$, query: query$, @@ -650,8 +650,8 @@ export class Subscribers extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(201, z.void()) + const [result$] = await this.matcher() + .json(200, components.SubscriberResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/tenants.ts b/src/sdk/tenants.ts index fb136738..a0869877 100644 --- a/src/sdk/tenants.ts +++ b/src/sdk/tenants.ts @@ -47,37 +47,31 @@ export class Tenants extends ClientSDK { } /** - * Get tenants + * Create tenant * * @remarks - * Returns a list of tenants, could paginated using the `page` and `limit` query parameter + * Create tenant under the current environment */ - async list( - page?: number | undefined, - limit?: number | undefined, + async create( + request: components.CreateTenantRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { - const input$: operations.TenantControllerListTenantsRequest = { - page: page, - limit: limit, - }; + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.TenantControllerListTenantsRequest$.outboundSchema.parse(value$), + (value$) => components.CreateTenantRequestDto$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$, { explode: true }); const path$ = this.templateURLComponent("/v1/tenants")(); - const query$ = encodeFormQuery$({ - limit: payload$.limit, - page: payload$.page, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -88,7 +82,7 @@ export class Tenants extends ClientSDK { security$ = {}; } const context = { - operationID: "TenantController_listTenants", + operationID: "TenantController_createTenant", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -99,7 +93,7 @@ export class Tenants extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, @@ -128,64 +122,46 @@ export class Tenants extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const responseFields$ = { - HttpMeta: { Response: response, Request: request$ }, - }; - - const [result$, raw$] = await this.matcher() - .json(200, operations.TenantControllerListTenantsResponse$, { key: "Result" }) + const [result$] = await this.matcher() + .json([200, 201], components.CreateTenantResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) - .match(response, { extraFields: responseFields$ }); - - const nextFunc = ( - responseData: unknown - ): Paginator => { - const page = input$.page || 0; - const nextPage = page + 1; - - if (!responseData) { - return () => null; - } - const results = jp.value(responseData, "$.data.resultArray"); - if (!results.length) { - return () => null; - } - const limit = input$.limit || 0; - if (results.length < limit) { - return () => null; - } - - return () => this.list(nextPage, limit, options); - }; + .match(response); - const page$ = { ...result$, next: nextFunc(raw$) }; - return { ...page$, ...createPageIterator(page$) }; + return result$; } /** - * Create tenant + * Delete tenant * * @remarks - * Create tenant under the current environment + * Deletes a tenant entity from the Novu platform */ - async create( - request: components.CreateTenantRequestDto, + async delete( + identifier: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise { + const input$: operations.TenantControllerRemoveTenantRequest = { + identifier: identifier, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, - (value$) => components.CreateTenantRequestDto$.outboundSchema.parse(value$), + (value$) => + operations.TenantControllerRemoveTenantRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = null; - const path$ = this.templateURLComponent("/v1/tenants")(); + const pathParams$ = { + identifier: encodeSimple$("identifier", payload$.identifier, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/tenants/{identifier}")(pathParams$); const query$ = ""; @@ -198,18 +174,18 @@ export class Tenants extends ClientSDK { security$ = {}; } const context = { - operationID: "TenantController_createTenant", + operationID: "TenantController_removeTenant", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -238,26 +214,28 @@ export class Tenants extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json([200, 201], components.CreateTenantResponseDto$) - .fail([409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .void(204, z.void()) + .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Get tenant + * Get tenants * * @remarks - * Get tenant by your internal id used to identify the tenant + * Returns a list of tenants, could paginated using the `page` and `limit` query parameter */ - async retrieve( - identifier: string, + async list( + page?: number | undefined, + limit?: number | undefined, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.TenantControllerGetTenantByIdRequest = { - identifier: identifier, + ): Promise> { + const input$: operations.TenantControllerListTenantsRequest = { + page: page, + limit: limit, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); @@ -265,21 +243,17 @@ export class Tenants extends ClientSDK { const payload$ = schemas$.parse( input$, - (value$) => - operations.TenantControllerGetTenantByIdRequest$.outboundSchema.parse(value$), + (value$) => operations.TenantControllerListTenantsRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const pathParams$ = { - identifier: encodeSimple$("identifier", payload$.identifier, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/tenants/{identifier}")(pathParams$); + const path$ = this.templateURLComponent("/v1/tenants")(); - const query$ = ""; + const query$ = encodeFormQuery$({ + limit: payload$.limit, + page: payload$.page, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -290,13 +264,13 @@ export class Tenants extends ClientSDK { security$ = {}; } const context = { - operationID: "TenantController_getTenantById", + operationID: "TenantController_listTenants", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { @@ -330,35 +304,61 @@ export class Tenants extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.GetTenantResponseDto$) - .fail([404, 409, 429, "4XX", 503, "5XX"]) - .match(response); + const responseFields$ = { + HttpMeta: { Response: response, Request: request$ }, + }; - return result$; + const [result$, raw$] = await this.matcher() + .json(200, operations.TenantControllerListTenantsResponse$, { key: "Result" }) + .fail([409, 429, "4XX", 503, "5XX"]) + .match(response, { extraFields: responseFields$ }); + + const nextFunc = ( + responseData: unknown + ): Paginator => { + const page = input$.page || 0; + const nextPage = page + 1; + + if (!responseData) { + return () => null; + } + const results = jp.value(responseData, "$.data.resultArray"); + if (!results.length) { + return () => null; + } + const limit = input$.limit || 0; + if (results.length < limit) { + return () => null; + } + + return () => this.list(nextPage, limit, options); + }; + + const page$ = { ...result$, next: nextFunc(raw$) }; + return { ...page$, ...createPageIterator(page$) }; } /** - * Delete tenant + * Get tenant * * @remarks - * Deletes a tenant entity from the Novu platform + * Get tenant by your internal id used to identify the tenant */ - async delete( + async retrieve( identifier: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.TenantControllerRemoveTenantRequest = { + ): Promise { + const input$: operations.TenantControllerGetTenantByIdRequest = { identifier: identifier, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.TenantControllerRemoveTenantRequest$.outboundSchema.parse(value$), + operations.TenantControllerGetTenantByIdRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; @@ -382,7 +382,7 @@ export class Tenants extends ClientSDK { security$ = {}; } const context = { - operationID: "TenantController_removeTenant", + operationID: "TenantController_getTenantById", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -393,7 +393,7 @@ export class Tenants extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "GET", path: path$, headers: headers$, query: query$, @@ -422,8 +422,8 @@ export class Tenants extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(204, z.void()) + const [result$] = await this.matcher() + .json(200, components.GetTenantResponseDto$) .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/topics.ts b/src/sdk/topics.ts index 0e05bbdb..be161f0d 100644 --- a/src/sdk/topics.ts +++ b/src/sdk/topics.ts @@ -51,34 +51,31 @@ export class Topics extends ClientSDK { } /** - * Filter topics + * Topic creation * * @remarks - * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter + * Create a topic */ - async list( - request: operations.TopicsControllerListTopicsRequest, + async create( + request: components.CreateTopicRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = typeof request === "undefined" ? {} : request; + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.TopicsControllerListTopicsRequest$.outboundSchema.parse(value$), + (value$) => components.CreateTopicRequestDto$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$, { explode: true }); const path$ = this.templateURLComponent("/v1/topics")(); - const query$ = encodeFormQuery$({ - key: payload$.key, - page: payload$.page, - pageSize: payload$.pageSize, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -89,7 +86,7 @@ export class Topics extends ClientSDK { security$ = {}; } const context = { - operationID: "TopicsController_listTopics", + operationID: "TopicsController_createTopic", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -100,7 +97,7 @@ export class Topics extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, @@ -129,8 +126,8 @@ export class Topics extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.FilterTopicsResponseDto$) + const [result$] = await this.matcher() + .json(201, components.CreateTopicResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -138,29 +135,36 @@ export class Topics extends ClientSDK { } /** - * Topic creation + * Delete topic * * @remarks - * Create a topic + * Delete a topic by its topic key if it has no subscribers */ - async create( - request: components.CreateTopicRequestDto, + async delete( + topicKey: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise { + const input$: operations.TopicsControllerDeleteTopicRequest = { + topicKey: topicKey, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); - headers$.set("Accept", "application/json"); + headers$.set("Accept", "*/*"); const payload$ = schemas$.parse( input$, - (value$) => components.CreateTopicRequestDto$.outboundSchema.parse(value$), + (value$) => operations.TopicsControllerDeleteTopicRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = null; - const path$ = this.templateURLComponent("/v1/topics")(); + const pathParams$ = { + topicKey: encodeSimple$("topicKey", payload$.topicKey, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/topics/{topicKey}")(pathParams$); const query$ = ""; @@ -173,18 +177,18 @@ export class Topics extends ClientSDK { security$ = {}; } const context = { - operationID: "TopicsController_createTopic", + operationID: "TopicsController_deleteTopic", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -213,47 +217,43 @@ export class Topics extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.CreateTopicResponseDto$) - .fail([409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .void(204, z.void()) + .fail([404, 409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Get topic + * Filter topics * * @remarks - * Get a topic by its topic key + * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter */ - async retrieve( - topicKey: string, + async list( + request: operations.TopicsControllerListTopicsRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.TopicsControllerGetTopicRequest = { - topicKey: topicKey, - }; + ): Promise { + const input$ = typeof request === "undefined" ? {} : request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.TopicsControllerGetTopicRequest$.outboundSchema.parse(value$), + (value$) => operations.TopicsControllerListTopicsRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const pathParams$ = { - topicKey: encodeSimple$("topicKey", payload$.topicKey, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/topics/{topicKey}")(pathParams$); + const path$ = this.templateURLComponent("/v1/topics")(); - const query$ = ""; + const query$ = encodeFormQuery$({ + key: payload$.key, + page: payload$.page, + pageSize: payload$.pageSize, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -264,7 +264,7 @@ export class Topics extends ClientSDK { security$ = {}; } const context = { - operationID: "TopicsController_getTopic", + operationID: "TopicsController_listTopics", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -304,8 +304,8 @@ export class Topics extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.GetTopicResponseDto$) + const [result$] = await this.matcher() + .json(200, components.FilterTopicsResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -313,28 +313,31 @@ export class Topics extends ClientSDK { } /** - * Delete topic + * Rename a topic * * @remarks - * Delete a topic by its topic key if it has no subscribers + * Rename a topic by providing a new name */ - async delete( + async rename( topicKey: string, + renameTopicRequestDto: components.RenameTopicRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.TopicsControllerDeleteTopicRequest = { + ): Promise { + const input$: operations.TopicsControllerRenameTopicRequest = { topicKey: topicKey, + renameTopicRequestDto: renameTopicRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Accept", "*/*"); + headers$.set("Content-Type", "application/json"); + headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.TopicsControllerDeleteTopicRequest$.outboundSchema.parse(value$), + (value$) => operations.TopicsControllerRenameTopicRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$.RenameTopicRequestDto, { explode: true }); const pathParams$ = { topicKey: encodeSimple$("topicKey", payload$.topicKey, { @@ -355,18 +358,18 @@ export class Topics extends ClientSDK { security$ = {}; } const context = { - operationID: "TopicsController_deleteTopic", + operationID: "TopicsController_renameTopic", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; const securitySettings$ = this.resolveGlobalSecurity(security$); - const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] }; + const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] }; const request$ = this.createRequest$( context, { security: securitySettings$, - method: "DELETE", + method: "PATCH", path: path$, headers: headers$, query: query$, @@ -395,40 +398,37 @@ export class Topics extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .void(204, z.void()) - .fail([404, 409, 429, "4XX", 503, "5XX"]) + const [result$] = await this.matcher() + .json(200, components.RenameTopicResponseDto$) + .fail([409, 429, "4XX", 503, "5XX"]) .match(response); return result$; } /** - * Rename a topic + * Get topic * * @remarks - * Rename a topic by providing a new name + * Get a topic by its topic key */ - async rename( + async retrieve( topicKey: string, - renameTopicRequestDto: components.RenameTopicRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.TopicsControllerRenameTopicRequest = { + ): Promise { + const input$: operations.TopicsControllerGetTopicRequest = { topicKey: topicKey, - renameTopicRequestDto: renameTopicRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => operations.TopicsControllerRenameTopicRequest$.outboundSchema.parse(value$), + (value$) => operations.TopicsControllerGetTopicRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.RenameTopicRequestDto, { explode: true }); + const body$ = null; const pathParams$ = { topicKey: encodeSimple$("topicKey", payload$.topicKey, { @@ -449,7 +449,7 @@ export class Topics extends ClientSDK { security$ = {}; } const context = { - operationID: "TopicsController_renameTopic", + operationID: "TopicsController_getTopic", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -460,7 +460,7 @@ export class Topics extends ClientSDK { context, { security: securitySettings$, - method: "PATCH", + method: "GET", path: path$, headers: headers$, query: query$, @@ -489,8 +489,8 @@ export class Topics extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.RenameTopicResponseDto$) + const [result$] = await this.matcher() + .json(200, components.GetTopicResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/workflowgroups.ts b/src/sdk/workflowgroups.ts index 49b66bd6..f05c73db 100644 --- a/src/sdk/workflowgroups.ts +++ b/src/sdk/workflowgroups.ts @@ -41,18 +41,28 @@ export class WorkflowGroups extends ClientSDK { } /** - * Get workflow groups + * Create workflow group * * @remarks * workflow group was previously named notification group */ - async list( + async create( + request: components.CreateNotificationGroupRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise> { + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); + const payload$ = schemas$.parse( + input$, + (value$) => components.CreateNotificationGroupRequestDto$.outboundSchema.parse(value$), + "Input validation failed" + ); + const body$ = encodeJSON$("body", payload$, { explode: true }); + const path$ = this.templateURLComponent("/v1/notification-groups")(); const query$ = ""; @@ -66,7 +76,7 @@ export class WorkflowGroups extends ClientSDK { security$ = {}; } const context = { - operationID: "NotificationGroupsController_listNotificationGroups", + operationID: "NotificationGroupsController_createNotificationGroup", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -77,10 +87,11 @@ export class WorkflowGroups extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, + body: body$, }, options ); @@ -105,8 +116,8 @@ export class WorkflowGroups extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher>() - .json(200, z.array(components.NotificationGroupResponseDto$.inboundSchema)) + const [result$] = await this.matcher() + .json(201, components.NotificationGroupResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -114,29 +125,36 @@ export class WorkflowGroups extends ClientSDK { } /** - * Create workflow group + * Delete workflow group * * @remarks * workflow group was previously named notification group */ - async create( - request: components.CreateNotificationGroupRequestDto, + async delete( + id: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise { + const input$: operations.NotificationGroupsControllerDeleteNotificationGroupRequest = { + id: id, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => components.CreateNotificationGroupRequestDto$.outboundSchema.parse(value$), + (value$) => + operations.NotificationGroupsControllerDeleteNotificationGroupRequest$.outboundSchema.parse( + value$ + ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = null; - const path$ = this.templateURLComponent("/v1/notification-groups")(); + const pathParams$ = { + id: encodeSimple$("id", payload$.id, { explode: false, charEncoding: "percent" }), + }; + const path$ = this.templateURLComponent("/v1/notification-groups/{id}")(pathParams$); const query$ = ""; @@ -149,7 +167,7 @@ export class WorkflowGroups extends ClientSDK { security$ = {}; } const context = { - operationID: "NotificationGroupsController_createNotificationGroup", + operationID: "NotificationGroupsController_deleteNotificationGroup", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -160,7 +178,7 @@ export class WorkflowGroups extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -189,8 +207,8 @@ export class WorkflowGroups extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.NotificationGroupResponseDto$) + const [result$] = await this.matcher() + .json(200, components.DeleteNotificationGroupResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -198,36 +216,19 @@ export class WorkflowGroups extends ClientSDK { } /** - * Get workflow group + * Get workflow groups * * @remarks * workflow group was previously named notification group */ - async retrieve( - id: string, + async list( options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.NotificationGroupsControllerGetNotificationGroupRequest = { - id: id, - }; + ): Promise> { const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); - const payload$ = schemas$.parse( - input$, - (value$) => - operations.NotificationGroupsControllerGetNotificationGroupRequest$.outboundSchema.parse( - value$ - ), - "Input validation failed" - ); - const body$ = null; - - const pathParams$ = { - id: encodeSimple$("id", payload$.id, { explode: false, charEncoding: "percent" }), - }; - const path$ = this.templateURLComponent("/v1/notification-groups/{id}")(pathParams$); + const path$ = this.templateURLComponent("/v1/notification-groups")(); const query$ = ""; @@ -240,7 +241,7 @@ export class WorkflowGroups extends ClientSDK { security$ = {}; } const context = { - operationID: "NotificationGroupsController_getNotificationGroup", + operationID: "NotificationGroupsController_listNotificationGroups", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -255,7 +256,6 @@ export class WorkflowGroups extends ClientSDK { path: path$, headers: headers$, query: query$, - body: body$, }, options ); @@ -280,8 +280,8 @@ export class WorkflowGroups extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.NotificationGroupResponseDto$) + const [result$] = await this.matcher>() + .json(200, z.array(components.NotificationGroupResponseDto$.inboundSchema)) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -289,16 +289,16 @@ export class WorkflowGroups extends ClientSDK { } /** - * Delete workflow group + * Get workflow group * * @remarks * workflow group was previously named notification group */ - async delete( + async retrieve( id: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.NotificationGroupsControllerDeleteNotificationGroupRequest = { + ): Promise { + const input$: operations.NotificationGroupsControllerGetNotificationGroupRequest = { id: id, }; const headers$ = new Headers(); @@ -308,7 +308,7 @@ export class WorkflowGroups extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.NotificationGroupsControllerDeleteNotificationGroupRequest$.outboundSchema.parse( + operations.NotificationGroupsControllerGetNotificationGroupRequest$.outboundSchema.parse( value$ ), "Input validation failed" @@ -331,7 +331,7 @@ export class WorkflowGroups extends ClientSDK { security$ = {}; } const context = { - operationID: "NotificationGroupsController_deleteNotificationGroup", + operationID: "NotificationGroupsController_getNotificationGroup", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -342,7 +342,7 @@ export class WorkflowGroups extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "GET", path: path$, headers: headers$, query: query$, @@ -371,8 +371,8 @@ export class WorkflowGroups extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.DeleteNotificationGroupResponseDto$) + const [result$] = await this.matcher() + .json(200, components.NotificationGroupResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); diff --git a/src/sdk/workflows.ts b/src/sdk/workflows.ts index 5d234a14..e709d479 100644 --- a/src/sdk/workflows.ts +++ b/src/sdk/workflows.ts @@ -56,35 +56,31 @@ export class Workflows extends ClientSDK { } /** - * Get workflows + * Create workflow * * @remarks - * Workflows were previously named notification templates + * Workflow was previously named notification template */ - async list( - request: operations.WorkflowControllerListWorkflowsRequest, + async create( + request: components.CreateWorkflowRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = typeof request === "undefined" ? {} : request; + ): Promise { + const input$ = request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => - operations.WorkflowControllerListWorkflowsRequest$.outboundSchema.parse(value$), + (value$) => components.CreateWorkflowRequestDto$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$, { explode: true }); const path$ = this.templateURLComponent("/v1/workflows")(); - const query$ = encodeFormQuery$({ - limit: payload$.limit, - page: payload$.page, - query: payload$.query, - }); + const query$ = ""; let security$; if (typeof this.options$.apiKey === "function") { @@ -95,7 +91,7 @@ export class Workflows extends ClientSDK { security$ = {}; } const context = { - operationID: "WorkflowController_listWorkflows", + operationID: "WorkflowController_create", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -106,7 +102,7 @@ export class Workflows extends ClientSDK { context, { security: securitySettings$, - method: "GET", + method: "POST", path: path$, headers: headers$, query: query$, @@ -135,8 +131,8 @@ export class Workflows extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.WorkflowsResponseDto$) + const [result$] = await this.matcher() + .json(201, components.WorkflowResponse$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -144,29 +140,39 @@ export class Workflows extends ClientSDK { } /** - * Create workflow + * Delete workflow * * @remarks * Workflow was previously named notification template */ - async create( - request: components.CreateWorkflowRequestDto, + async delete( + workflowId: string, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$ = request; + ): Promise { + const input$: operations.WorkflowControllerDeleteWorkflowByIdRequest = { + workflowId: workflowId, + }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, - (value$) => components.CreateWorkflowRequestDto$.outboundSchema.parse(value$), + (value$) => + operations.WorkflowControllerDeleteWorkflowByIdRequest$.outboundSchema.parse( + value$ + ), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$, { explode: true }); + const body$ = null; - const path$ = this.templateURLComponent("/v1/workflows")(); + const pathParams$ = { + workflowId: encodeSimple$("workflowId", payload$.workflowId, { + explode: false, + charEncoding: "percent", + }), + }; + const path$ = this.templateURLComponent("/v1/workflows/{workflowId}")(pathParams$); const query$ = ""; @@ -179,7 +185,7 @@ export class Workflows extends ClientSDK { security$ = {}; } const context = { - operationID: "WorkflowController_create", + operationID: "WorkflowController_deleteWorkflowById", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -190,7 +196,7 @@ export class Workflows extends ClientSDK { context, { security: securitySettings$, - method: "POST", + method: "DELETE", path: path$, headers: headers$, query: query$, @@ -219,8 +225,8 @@ export class Workflows extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(201, components.WorkflowResponse$) + const [result$] = await this.matcher() + .json(200, components.DataBooleanDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -228,18 +234,16 @@ export class Workflows extends ClientSDK { } /** - * Get workflow + * Get workflows * * @remarks - * Workflow was previously named notification template + * Workflows were previously named notification templates */ - async retrieve( - workflowId: string, + async list( + request: operations.WorkflowControllerListWorkflowsRequest, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.WorkflowControllerGetWorkflowByIdRequest = { - workflowId: workflowId, - }; + ): Promise { + const input$ = typeof request === "undefined" ? {} : request; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); headers$.set("Accept", "application/json"); @@ -247,20 +251,18 @@ export class Workflows extends ClientSDK { const payload$ = schemas$.parse( input$, (value$) => - operations.WorkflowControllerGetWorkflowByIdRequest$.outboundSchema.parse(value$), + operations.WorkflowControllerListWorkflowsRequest$.outboundSchema.parse(value$), "Input validation failed" ); const body$ = null; - const pathParams$ = { - workflowId: encodeSimple$("workflowId", payload$.workflowId, { - explode: false, - charEncoding: "percent", - }), - }; - const path$ = this.templateURLComponent("/v1/workflows/{workflowId}")(pathParams$); + const path$ = this.templateURLComponent("/v1/workflows")(); - const query$ = ""; + const query$ = encodeFormQuery$({ + limit: payload$.limit, + page: payload$.page, + query: payload$.query, + }); let security$; if (typeof this.options$.apiKey === "function") { @@ -271,7 +273,7 @@ export class Workflows extends ClientSDK { security$ = {}; } const context = { - operationID: "WorkflowController_getWorkflowById", + operationID: "WorkflowController_listWorkflows", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -311,8 +313,8 @@ export class Workflows extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.WorkflowResponse$) + const [result$] = await this.matcher() + .json(200, components.WorkflowsResponseDto$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response); @@ -320,34 +322,29 @@ export class Workflows extends ClientSDK { } /** - * Update workflow + * Get workflow * * @remarks * Workflow was previously named notification template */ - async update( + async retrieve( workflowId: string, - updateWorkflowRequestDto: components.UpdateWorkflowRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } ): Promise { - const input$: operations.WorkflowControllerUpdateWorkflowByIdRequest = { + const input$: operations.WorkflowControllerGetWorkflowByIdRequest = { workflowId: workflowId, - updateWorkflowRequestDto: updateWorkflowRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); - headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.WorkflowControllerUpdateWorkflowByIdRequest$.outboundSchema.parse( - value$ - ), + operations.WorkflowControllerGetWorkflowByIdRequest$.outboundSchema.parse(value$), "Input validation failed" ); - const body$ = encodeJSON$("body", payload$.UpdateWorkflowRequestDto, { explode: true }); + const body$ = null; const pathParams$ = { workflowId: encodeSimple$("workflowId", payload$.workflowId, { @@ -368,7 +365,7 @@ export class Workflows extends ClientSDK { security$ = {}; } const context = { - operationID: "WorkflowController_updateWorkflowById", + operationID: "WorkflowController_getWorkflowById", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -379,7 +376,7 @@ export class Workflows extends ClientSDK { context, { security: securitySettings$, - method: "PUT", + method: "GET", path: path$, headers: headers$, query: query$, @@ -417,31 +414,34 @@ export class Workflows extends ClientSDK { } /** - * Delete workflow + * Update workflow * * @remarks * Workflow was previously named notification template */ - async delete( + async update( workflowId: string, + updateWorkflowRequestDto: components.UpdateWorkflowRequestDto, options?: RequestOptions & { retries?: retries$.RetryConfig } - ): Promise { - const input$: operations.WorkflowControllerDeleteWorkflowByIdRequest = { + ): Promise { + const input$: operations.WorkflowControllerUpdateWorkflowByIdRequest = { workflowId: workflowId, + updateWorkflowRequestDto: updateWorkflowRequestDto, }; const headers$ = new Headers(); headers$.set("user-agent", SDK_METADATA.userAgent); + headers$.set("Content-Type", "application/json"); headers$.set("Accept", "application/json"); const payload$ = schemas$.parse( input$, (value$) => - operations.WorkflowControllerDeleteWorkflowByIdRequest$.outboundSchema.parse( + operations.WorkflowControllerUpdateWorkflowByIdRequest$.outboundSchema.parse( value$ ), "Input validation failed" ); - const body$ = null; + const body$ = encodeJSON$("body", payload$.UpdateWorkflowRequestDto, { explode: true }); const pathParams$ = { workflowId: encodeSimple$("workflowId", payload$.workflowId, { @@ -462,7 +462,7 @@ export class Workflows extends ClientSDK { security$ = {}; } const context = { - operationID: "WorkflowController_deleteWorkflowById", + operationID: "WorkflowController_updateWorkflowById", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -473,7 +473,7 @@ export class Workflows extends ClientSDK { context, { security: securitySettings$, - method: "DELETE", + method: "PUT", path: path$, headers: headers$, query: query$, @@ -502,8 +502,8 @@ export class Workflows extends ClientSDK { { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] } ); - const [result$] = await this.matcher() - .json(200, components.DataBooleanDto$) + const [result$] = await this.matcher() + .json(200, components.WorkflowResponse$) .fail([409, 429, "4XX", 503, "5XX"]) .match(response);