diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 7f62c21..3643563 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 9bfe35dd-87f6-4b74-8789-134b7aa9c364 management: - docChecksum: dc140a35a497f4d13f89c53973c7b07e + docChecksum: 11b7e948445214c3d50ad397d0f0bc1a docVersion: "1.0" - speakeasyVersion: 1.469.0 - generationVersion: 2.493.21 - releaseVersion: 0.0.4 - configChecksum: 7ce5ac4a94c7b9681c6c297f225951a0 + speakeasyVersion: 1.469.2 + generationVersion: 2.493.23 + releaseVersion: 0.0.5 + configChecksum: faba383df96e35edb63974db683fe6e3 repoURL: https://github.com/novuhq/novu-go.git installationURL: https://github.com/novuhq/novu-go features: @@ -567,7 +567,7 @@ examples: EventsController_triggerBulk: speakeasy-default-events-controller-trigger-bulk: requestBody: - application/json: {"events": [{"name": "workflow_identifier", "payload": {"comment_id": "string", "post": {"text": "string"}}, "bridgeUrl": "https://example.com/bridge", "overrides": {"fcm": {"data": {"key": "value"}}}, "to": {"subscriberId": ""}}, {"name": "workflow_identifier", "payload": {"comment_id": "string", "post": {"text": "string"}}, "bridgeUrl": "https://example.com/bridge", "overrides": {"fcm": {"data": {"key": "value"}}}, "to": [{"topicKey": "", "type": "Subscriber"}]}, {"name": "workflow_identifier", "payload": {"comment_id": "string", "post": {"text": "string"}}, "bridgeUrl": "https://example.com/bridge", "overrides": {"fcm": {"data": {"key": "value"}}}, "to": ["SUBSCRIBER_ID", "SUBSCRIBER_ID"]}]} + application/json: {"events": [{"name": "workflow_identifier", "payload": {"comment_id": "string", "post": {"text": "string"}}, "bridgeUrl": "https://example.com/bridge", "overrides": {"fcm": {"data": {"key": "value"}}}, "to": {"subscriberId": ""}}, {"name": "workflow_identifier", "payload": {"comment_id": "string", "post": {"text": "string"}}, "bridgeUrl": "https://example.com/bridge", "overrides": {"fcm": {"data": {"key": "value"}}}, "to": {"topicKey": "", "type": "Subscriber"}}, {"name": "workflow_identifier", "payload": {"comment_id": "string", "post": {"text": "string"}}, "bridgeUrl": "https://example.com/bridge", "overrides": {"fcm": {"data": {"key": "value"}}}, "to": ["SUBSCRIBER_ID", "SUBSCRIBER_ID"]}]} responses: "201": application/json: [{"acknowledged": true, "status": "error"}, {"acknowledged": true, "status": "no_workflow_active_steps_defined"}, {"acknowledged": true, "status": "trigger_not_active"}] @@ -581,7 +581,7 @@ examples: application/json: {"name": "", "payload": {"comment_id": "string", "post": {"text": "string"}}} responses: "200": - application/json: {"acknowledged": true, "status": "trigger_not_active"} + application/json: {"acknowledged": true, "status": "error"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -598,19 +598,11 @@ examples: application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} - SupportController_fetchUserOrganizations: - speakeasy-default-support-controller-fetch-user-organizations: - requestBody: - application/json: {"timestamp": ""} - responses: - "201": - application/json: {} - SupportController_createThread: - speakeasy-default-support-controller-create-thread: - requestBody: - application/json: {"text": ""} NotificationsController_listNotifications: speakeasy-default-notifications-controller-list-notifications: + parameters: + query: + page: 0 responses: "200": application/json: {"hasMore": false, "data": [{"_environmentId": "", "_organizationId": "", "_subscriberId": "", "transactionId": ""}, {"_environmentId": "", "_organizationId": "", "_subscriberId": "", "transactionId": ""}], "pageSize": 6783.17, "page": 1777.06} @@ -634,7 +626,7 @@ examples: speakeasy-default-notifications-controller-get-activity-stats: responses: "200": - application/json: {"weeklySent": 3704.56, "monthlySent": 9198.31} + application/json: {"weeklySent": 7003.47, "monthlySent": 5588.34} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -643,7 +635,7 @@ examples: speakeasy-default-notifications-controller-get-activity-graph-stats: responses: "200": - application/json: [{"_id": "", "count": 4718.99, "templates": ["", "", ""], "channels": []}] + application/json: [{"_id": "", "count": 7916.4, "templates": [], "channels": ["in_app"]}] "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -710,7 +702,7 @@ examples: integrationId: "" responses: "200": - application/json: {"_environmentId": "", "_organizationId": "", "name": "", "identifier": "", "providerId": "", "channel": "email", "credentials": {}, "active": false, "deleted": false, "primary": true} + application/json: {"_environmentId": "", "_organizationId": "", "name": "", "identifier": "", "providerId": "", "channel": "push", "credentials": {}, "active": true, "deleted": true, "primary": false} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -722,13 +714,16 @@ examples: providerOrIntegrationId: "" responses: "200": - application/json: true + application/json: false "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} SubscribersController_listSubscribers: speakeasy-default-subscribers-controller-list-subscribers: + parameters: + query: + limit: 10 responses: "200": application/json: {"page": 7685.78, "hasMore": false, "pageSize": 6783.17, "data": []} @@ -742,7 +737,7 @@ examples: application/json: {"subscriberId": ""} responses: "201": - application/json: {"subscriberId": "", "channels": [{"providerId": "fcm", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1709824276522", "updatedAt": "1737042502546"} + application/json: {"subscriberId": "", "channels": [{"providerId": "fcm", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "getstream", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1707972815287", "updatedAt": "1737314430894"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -755,7 +750,7 @@ examples: query: {} responses: "200": - application/json: {"subscriberId": "", "channels": [{"providerId": "push-webhook", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1715785758022", "updatedAt": "1737044393819"} + application/json: {"subscriberId": "", "channels": [{"providerId": "whatsapp-business", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "whatsapp-business", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "rocket-chat", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": false, "createdAt": "1720241064814", "updatedAt": "1737284567088"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -769,7 +764,7 @@ examples: application/json: {"email": "john.doe@example.com", "firstName": "John", "lastName": "Doe", "phone": "+1234567890", "avatar": "https://example.com/avatar.jpg", "locale": "en-US", "data": {"preferences": {"notifications": true, "theme": "dark"}, "tags": ["premium", "newsletter"]}} responses: "200": - application/json: {"subscriberId": "", "channels": [{"providerId": "fcm", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "zulip", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "pusher-beams", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": false, "createdAt": "1721003385247", "updatedAt": "1737121556053"} + application/json: {"subscriberId": "", "channels": [{"providerId": "fcm", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "zulip", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "pusher-beams", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": false, "createdAt": "1721212462816", "updatedAt": "1737330633622"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -797,6 +792,20 @@ examples: application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} + SubscribersController_updateSubscriberOnlineFlag: + speakeasy-default-subscribers-controller-update-subscriber-online-flag: + parameters: + path: + subscriberId: "" + requestBody: + application/json: {"isOnline": true} + responses: + "200": + application/json: {"subscriberId": "", "channels": [{"providerId": "zulip", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "msteams", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1710485263063", "updatedAt": "1737251227705"} + "400": + application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} + "422": + application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} SubscribersController_updateSubscriberChannel: speakeasy-default-subscribers-controller-update-subscriber-channel: parameters: @@ -806,7 +815,7 @@ examples: application/json: {"providerId": "pushpad", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}} responses: "200": - application/json: {"subscriberId": "", "channels": [{"providerId": "zulip", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "pusher-beams", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": false, "createdAt": "1721003385277", "updatedAt": "1737121556083"} + application/json: {"subscriberId": "", "channels": [{"providerId": "zulip", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "pusher-beams", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": false, "createdAt": "1721212462931", "updatedAt": "1737330633737"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -820,7 +829,7 @@ examples: application/json: {"providerId": "zulip", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}} responses: "200": - application/json: {"subscriberId": "", "channels": [{"providerId": "pushpad", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "apns", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": false, "createdAt": "1737034392564", "updatedAt": "1737084342945"} + application/json: {"subscriberId": "", "channels": [{"providerId": "pushpad", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "apns", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": false, "createdAt": "1737243470227", "updatedAt": "1737293420608"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -836,20 +845,6 @@ examples: application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} - SubscribersController_updateSubscriberOnlineFlag: - speakeasy-default-subscribers-controller-update-subscriber-online-flag: - parameters: - path: - subscriberId: "" - requestBody: - application/json: {"isOnline": false} - responses: - "200": - application/json: {"subscriberId": "", "channels": [{"providerId": "one-signal", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1726655907694", "updatedAt": "1737109058245"} - "400": - application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} - "422": - application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} SubscribersController_listSubscriberPreferences: speakeasy-default-subscribers-controller-list-subscriber-preferences: parameters: @@ -863,20 +858,6 @@ examples: application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} - SubscribersController_updateSubscriberGlobalPreferences: - speakeasy-default-subscribers-controller-update-subscriber-global-preferences: - parameters: - path: - subscriberId: "" - requestBody: - application/json: {} - responses: - "200": - application/json: {"preference": {"enabled": true, "channels": {}}} - "400": - application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} - "422": - application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} SubscribersController_getSubscriberPreferenceByLevel: speakeasy-default-subscribers-controller-get-subscriber-preference-by-level: parameters: @@ -886,22 +867,7 @@ examples: query: {} responses: "200": - application/json: [{"preference": {"enabled": true, "channels": {}}}] - "400": - application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} - "422": - application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} - SubscribersController_updateSubscriberPreference: - speakeasy-default-subscribers-controller-update-subscriber-preference: - parameters: - path: - subscriberId: "" - parameter: "" - requestBody: - application/json: {} - responses: - "200": - application/json: {"template": {"_id": "", "name": "", "critical": false, "triggers": [{"type": "event", "identifier": "", "variables": [{"name": ""}]}, {"type": "event", "identifier": "", "variables": [{"name": ""}, {"name": ""}, {"name": ""}]}]}, "preference": {"enabled": false, "channels": {}}} + application/json: [{"preference": {"enabled": true, "channels": {}}}, {"preference": {"enabled": true, "channels": {}}}] "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -912,10 +878,11 @@ examples: path: subscriberId: "" query: + limit: 10 payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=" responses: "200": - application/json: {"totalCount": 5, "hasMore": true, "data": [{"_id": "615c1f2f9b0c5b001f8e4e3b", "_templateId": "template_12345", "_environmentId": "env_67890", "_messageTemplateId": "message_template_54321", "_organizationId": "org_98765", "_notificationId": "notification_123456", "_subscriberId": "subscriber_112233", "_feedId": "feed_445566", "_jobId": "job_778899", "createdAt": "2024-12-10T10:10:59.639Z", "updatedAt": "2024-12-10T10:10:59.639Z", "actor": {"data": null, "type": "system_icon"}, "transactionId": "transaction_123456", "templateIdentifier": "template_abcdef", "providerId": "provider_xyz", "content": "This is a test notification content.", "subject": "Test Notification Subject", "channel": "push", "read": false, "seen": true, "deleted": false, "deviceTokens": ["token1", "token2"], "cta": {"data": {}}, "status": "sent", "payload": {"key": "value"}, "overrides": {"overrideKey": "overrideValue"}}, {"_id": "615c1f2f9b0c5b001f8e4e3b", "_templateId": "template_12345", "_environmentId": "env_67890", "_messageTemplateId": "message_template_54321", "_organizationId": "org_98765", "_notificationId": "notification_123456", "_subscriberId": "subscriber_112233", "_feedId": "feed_445566", "_jobId": "job_778899", "createdAt": "2024-12-10T10:10:59.639Z", "updatedAt": "2024-12-10T10:10:59.639Z", "actor": {"data": null, "type": "system_icon"}, "transactionId": "transaction_123456", "templateIdentifier": "template_abcdef", "providerId": "provider_xyz", "content": "This is a test notification content.", "subject": "Test Notification Subject", "channel": "push", "read": false, "seen": true, "deleted": false, "deviceTokens": ["token1", "token2"], "cta": {"data": {}}, "status": "sent", "payload": {"key": "value"}, "overrides": {"overrideKey": "overrideValue"}}, {"_id": "615c1f2f9b0c5b001f8e4e3b", "_templateId": "template_12345", "_environmentId": "env_67890", "_messageTemplateId": "message_template_54321", "_organizationId": "org_98765", "_notificationId": "notification_123456", "_subscriberId": "subscriber_112233", "_feedId": "feed_445566", "_jobId": "job_778899", "createdAt": "2024-12-10T10:10:59.639Z", "updatedAt": "2024-12-10T10:10:59.639Z", "actor": {"data": null, "type": "system_icon"}, "transactionId": "transaction_123456", "templateIdentifier": "template_abcdef", "providerId": "provider_xyz", "content": "This is a test notification content.", "subject": "Test Notification Subject", "channel": "in_app", "read": false, "seen": true, "deleted": false, "deviceTokens": ["token1", "token2"], "cta": {"data": {}}, "status": "sent", "payload": {"key": "value"}, "overrides": {"overrideKey": "overrideValue"}}], "pageSize": 2, "page": 1} + application/json: {"totalCount": 5, "hasMore": true, "data": [], "pageSize": 2, "page": 1} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -925,7 +892,9 @@ examples: parameters: path: subscriberId: "" - query: {} + query: + seen: false + limit: 100 responses: "200": application/json: {"count": 2166.35} @@ -942,7 +911,7 @@ examples: application/json: {"messageId": "", "markAs": "unread"} responses: "201": - application/json: [] + application/json: [{"_templateId": "", "_environmentId": "", "_messageTemplateId": "", "_organizationId": "", "_notificationId": "", "_subscriberId": "", "subscriber": {"subscriberId": "", "channels": [{"providerId": "push-webhook", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "one-signal", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "discord", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1730297681553", "updatedAt": "1737319062752"}, "createdAt": "1727906075121", "content": {"type": "text", "content": ""}, "transactionId": "", "channel": "push", "read": false, "seen": true, "cta": {"data": {}}, "status": "warning"}] "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -969,10 +938,10 @@ examples: type: "" subscriberId: "" requestBody: - application/json: {"status": "done"} + application/json: {"status": "pending"} responses: "201": - application/json: {"_templateId": "", "_environmentId": "", "_messageTemplateId": "", "_organizationId": "", "_notificationId": "", "_subscriberId": "", "subscriber": {"subscriberId": "", "channels": [{"providerId": "push-webhook", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1718601447016", "updatedAt": "1737120025559"}, "createdAt": "1710453533428", "content": {"type": "button", "content": ""}, "transactionId": "", "channel": "chat", "read": true, "seen": true, "cta": {"data": {}}, "status": "error"} + application/json: {"_templateId": "", "_environmentId": "", "_messageTemplateId": "", "_organizationId": "", "_notificationId": "", "_subscriberId": "", "subscriber": {"subscriberId": "", "channels": [{"providerId": "mattermost", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}, {"providerId": "push-webhook", "credentials": {"webhookUrl": "https://example.com/webhook", "channel": "general", "deviceTokens": ["token1", "token2", "token3"], "alertUid": "12345-abcde", "title": "Critical Alert", "imageUrl": "https://example.com/image.png", "state": "resolved", "externalUrl": "https://example.com/details"}, "_integrationId": ""}], "_organizationId": "", "_environmentId": "", "deleted": true, "createdAt": "1706846287057", "updatedAt": "1737312652745"}, "createdAt": "1719541180067", "content": "", "transactionId": "", "channel": "sms", "read": false, "seen": true, "cta": {"data": {}}, "status": "error"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -1010,11 +979,44 @@ examples: application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} + SubscribersController_updateSubscriberGlobalPreferences: + speakeasy-default-subscribers-controller-update-subscriber-global-preferences: + parameters: + path: + subscriberId: "" + requestBody: + application/json: {} + responses: + "200": + application/json: {"preference": {"enabled": true, "channels": {}}} + "400": + application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} + "422": + application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} + SubscribersController_updateSubscriberPreference: + speakeasy-default-subscribers-controller-update-subscriber-preference: + parameters: + path: + subscriberId: "" + parameter: "" + requestBody: + application/json: {} + responses: + "200": + application/json: {"template": {"_id": "", "name": "", "critical": false, "triggers": [{"type": "event", "identifier": "", "variables": [{"name": ""}]}, {"type": "event", "identifier": "", "variables": [{"name": ""}, {"name": ""}, {"name": ""}]}]}, "preference": {"enabled": false, "channels": {}}} + "400": + application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} + "422": + application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} MessagesController_getMessages: speakeasy-default-messages-controller-get-messages: + parameters: + query: + page: 0 + limit: 10 responses: "200": - application/json: {"hasMore": true, "data": [{"_environmentId": "", "_organizationId": "", "_subscriberId": "", "transactionId": ""}, {"_environmentId": "", "_organizationId": "", "_subscriberId": "", "transactionId": ""}, {"_environmentId": "", "_organizationId": "", "_subscriberId": "", "transactionId": ""}], "pageSize": 3129.93, "page": 3234.02} + application/json: {"hasMore": false, "data": [{"_environmentId": "", "_organizationId": "", "_subscriberId": "", "transactionId": ""}, {"_environmentId": "", "_organizationId": "", "_subscriberId": "", "transactionId": ""}], "pageSize": 6783.17, "page": 1777.06} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -1084,7 +1086,7 @@ examples: topicKey: "" responses: "200": - application/json: {"_organizationId": "", "_environmentId": "", "key": "", "name": "", "subscribers": [""]} + application/json: {"_organizationId": "", "_environmentId": "", "key": "", "name": "", "subscribers": ["", ""]} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": @@ -1103,43 +1105,55 @@ examples: application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} - TopicsController_assign: - speakeasy-default-topics-controller-assign: + TopicsController_getTopicSubscriber: + speakeasy-default-topics-controller-get-topic-subscriber: parameters: path: + externalSubscriberId: "" topicKey: "" - requestBody: - application/json: {"subscribers": ["", "", ""]} responses: "200": - application/json: {"succeeded": []} + application/json: {"_organizationId": "org_123456789", "_environmentId": "env_123456789", "_subscriberId": "sub_123456789", "_topicId": "topic_123456789", "topicKey": "my_topic_key", "externalSubscriberId": "external_subscriber_123"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} - TopicsController_getTopicSubscriber: - speakeasy-default-topics-controller-get-topic-subscriber: + TopicsController_removeSubscribers: + speakeasy-default-topics-controller-remove-subscribers: parameters: path: - externalSubscriberId: "" topicKey: "" + requestBody: + application/json: {"subscribers": ["", ""]} responses: - "200": - application/json: {"_organizationId": "org_123456789", "_environmentId": "env_123456789", "_subscriberId": "sub_123456789", "_topicId": "topic_123456789", "topicKey": "my_topic_key", "externalSubscriberId": "external_subscriber_123"} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} - TopicsController_removeSubscribers: - speakeasy-default-topics-controller-remove-subscribers: + TopicsController_assign: + speakeasy-default-topics-controller-assign: parameters: path: topicKey: "" requestBody: application/json: {"subscribers": ["", ""]} responses: + "200": + application/json: {"succeeded": ["", ""]} "400": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123"} "422": application/json: {"statusCode": 404, "timestamp": "2024-12-12T13:00:00Z", "path": "/api/v1/resource", "message": "Resource not found.", "ctx": {"workflowId": "some_wf_id", "stepId": "some_wf_id"}, "errorId": "abc123", "errors": {"fieldName1": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName2": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName3": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}, "fieldName4": {"messages": ["Field is required", "Invalid format"], "value": "xx xx xx "}}} + SupportController_fetchUserOrganizations: + speakeasy-default-support-controller-fetch-user-organizations: + requestBody: + application/json: {"timestamp": ""} + responses: + "201": + application/json: {} + SupportController_createThread: + speakeasy-default-support-controller-create-thread: + requestBody: + application/json: {"text": ""} +examplesVersion: 1.0.0 generatedTests: {} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 483b8f6..00c5327 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -16,7 +16,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: true go: - version: 0.0.4 + version: 0.0.5 additionalDependencies: {} allowUnknownFieldsInWeakUnions: false clientServerStatusCodesAsErrors: true diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 4c880e8..5e378f5 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.469.0 +speakeasyVersion: 1.469.2 sources: novu-OAS: sourceNamespace: novu-oas - sourceRevisionDigest: sha256:21367ef75f16ed5cfdf8972684fbe3671307fe5f95f10842295478088904d0a5 - sourceBlobDigest: sha256:ba8ff28975436bfaa7b97c66c2a878486ea83454788feffc7c3b3b65390c3add + sourceRevisionDigest: sha256:c5afde79d343aedf8181232b89de49d7165957a7fa32835b0c742ed0d3b3015b + sourceBlobDigest: sha256:18c316b9321ad3e95d98430f5395c857fb1312d945662fcc975b94fa205f076a tags: - latest - - speakeasy-sdk-regen-1737123552 + - speakeasy-sdk-regen-1737159150 - "1.0" targets: novu: source: novu-OAS sourceNamespace: novu-oas - sourceRevisionDigest: sha256:21367ef75f16ed5cfdf8972684fbe3671307fe5f95f10842295478088904d0a5 - sourceBlobDigest: sha256:ba8ff28975436bfaa7b97c66c2a878486ea83454788feffc7c3b3b65390c3add + sourceRevisionDigest: sha256:c5afde79d343aedf8181232b89de49d7165957a7fa32835b0c742ed0d3b3015b + sourceBlobDigest: sha256:18c316b9321ad3e95d98430f5395c857fb1312d945662fcc975b94fa205f076a codeSamplesNamespace: novu-oas-go-code-samples - codeSamplesRevisionDigest: sha256:c0f498f3ef9a7ddfbc969555a2ef14a35283411527c473ec148198e91dcaf64e + codeSamplesRevisionDigest: sha256:a523494292324af9cd12339c33b175188b55eeeda76365ea51d091dde5a79bec workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 354d38b..b2f9f44 100644 --- a/README.md +++ b/README.md @@ -482,7 +482,7 @@ func main() { novugo.WithSecurity(os.Getenv("NOVU_API_KEY")), ) - res, err := s.Subscribers.List(ctx, nil, nil) + res, err := s.Subscribers.List(ctx, nil, novugo.Float64(10)) if err != nil { log.Fatal(err) } diff --git a/RELEASES.md b/RELEASES.md index b41dc69..cad22a3 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -8,4 +8,14 @@ Based on: ### Generated - [go v0.0.4] . ### Releases -- [Go v0.0.4] https://github.com/novuhq/novu-go/releases/tag/v0.0.4 - . \ No newline at end of file +- [Go v0.0.4] https://github.com/novuhq/novu-go/releases/tag/v0.0.4 - . + +## 2025-01-20 00:13:00 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.469.2 (2.493.23) https://github.com/speakeasy-api/speakeasy +### Generated +- [go v0.0.5] . +### Releases +- [Go v0.0.5] https://github.com/novuhq/novu-go/releases/tag/v0.0.5 - . \ No newline at end of file diff --git a/docs/models/components/actor.md b/docs/models/components/actor.md index 47be803..562340d 100644 --- a/docs/models/components/actor.md +++ b/docs/models/components/actor.md @@ -3,6 +3,8 @@ 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 diff --git a/docs/models/components/triggereventrequestdto.md b/docs/models/components/triggereventrequestdto.md index fc4ead5..a2b9ec6 100644 --- a/docs/models/components/triggereventrequestdto.md +++ b/docs/models/components/triggereventrequestdto.md @@ -11,6 +11,6 @@ | `Overrides` | map[string]map[string]*any* | :heavy_minus_sign: | This could be used to override provider specific configurations | {
"fcm": {
"data": {
"key": "value"
}
}
} | | `To` | [components.To](../../models/components/to.md) | :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 generate a UUID if not provided. | | -| `Actor` | [*components.Actor](../../models/components/actor.md) | :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 | | +| `Actor` | [*components.Actor](../../models/components/actor.md) | :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](../../models/components/tenant.md) | :heavy_minus_sign: | It is used to specify a tenant context during trigger event.
Existing tenants will be updated with the provided details. | | | `Controls` | [*components.WorkflowToStepControlValuesDto](../../models/components/workflowtostepcontrolvaluesdto.md) | :heavy_minus_sign: | Additional control configurations. | | \ No newline at end of file diff --git a/docs/sdks/credentials/README.md b/docs/sdks/credentials/README.md index 988f858..9c0aa31 100644 --- a/docs/sdks/credentials/README.md +++ b/docs/sdks/credentials/README.md @@ -85,6 +85,8 @@ func main() { 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 diff --git a/docs/sdks/messages/README.md b/docs/sdks/messages/README.md index 6f0823e..b2f6459 100644 --- a/docs/sdks/messages/README.md +++ b/docs/sdks/messages/README.md @@ -36,7 +36,10 @@ func main() { novugo.WithSecurity(os.Getenv("NOVU_API_KEY")), ) - res, err := s.Messages.List(ctx, operations.MessagesControllerGetMessagesRequest{}) + res, err := s.Messages.List(ctx, operations.MessagesControllerGetMessagesRequest{ + Page: novugo.Float64(0), + Limit: novugo.Float64(10), + }) if err != nil { log.Fatal(err) } diff --git a/docs/sdks/notifications/README.md b/docs/sdks/notifications/README.md index f741fca..58a14b1 100644 --- a/docs/sdks/notifications/README.md +++ b/docs/sdks/notifications/README.md @@ -32,7 +32,9 @@ func main() { novugo.WithSecurity(os.Getenv("NOVU_API_KEY")), ) - res, err := s.Notifications.List(ctx, operations.NotificationsControllerListNotificationsRequest{}) + res, err := s.Notifications.List(ctx, operations.NotificationsControllerListNotificationsRequest{ + Page: novugo.Float64(0), + }) if err != nil { log.Fatal(err) } diff --git a/docs/sdks/novu/README.md b/docs/sdks/novu/README.md index f7d9dae..6b2e73b 100644 --- a/docs/sdks/novu/README.md +++ b/docs/sdks/novu/README.md @@ -234,6 +234,8 @@ func main() { Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc. + + In the future could be used to trigger events to a subset of subscribers based on defined filters. ### Example Usage diff --git a/docs/sdks/novumessages/README.md b/docs/sdks/novumessages/README.md index 062b219..0a7887f 100644 --- a/docs/sdks/novumessages/README.md +++ b/docs/sdks/novumessages/README.md @@ -151,7 +151,7 @@ func main() { ) res, err := s.Subscribers.Messages.UpdateAction(ctx, "", "", "", components.MarkMessageActionAsSeenDto{ - Status: components.MarkMessageActionAsSeenDtoStatusDone, + Status: components.MarkMessageActionAsSeenDtoStatusPending, }) if err != nil { log.Fatal(err) diff --git a/docs/sdks/novusubscribersnotifications/README.md b/docs/sdks/novusubscribersnotifications/README.md index b668256..89be481 100644 --- a/docs/sdks/novusubscribersnotifications/README.md +++ b/docs/sdks/novusubscribersnotifications/README.md @@ -34,6 +34,7 @@ func main() { res, err := s.Subscribers.Notifications.GetFeed(ctx, operations.SubscribersControllerGetNotificationsFeedRequest{ SubscriberID: "", + Limit: novugo.Float64(10), Payload: novugo.String("btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30="), }) if err != nil { @@ -88,7 +89,7 @@ func main() { novugo.WithSecurity(os.Getenv("NOVU_API_KEY")), ) - res, err := s.Subscribers.Notifications.UnseenCount(ctx, "", nil, nil) + res, err := s.Subscribers.Notifications.UnseenCount(ctx, "", novugo.Bool(false), novugo.Float64(100)) if err != nil { log.Fatal(err) } diff --git a/docs/sdks/subscribers/README.md b/docs/sdks/subscribers/README.md index d0e79d9..a19d860 100644 --- a/docs/sdks/subscribers/README.md +++ b/docs/sdks/subscribers/README.md @@ -36,7 +36,7 @@ func main() { novugo.WithSecurity(os.Getenv("NOVU_API_KEY")), ) - res, err := s.Subscribers.List(ctx, nil, nil) + res, err := s.Subscribers.List(ctx, nil, novugo.Float64(10)) if err != nil { log.Fatal(err) } @@ -402,7 +402,7 @@ func main() { ) res, err := s.Subscribers.UpdateOnlineStatus(ctx, "", components.UpdateSubscriberOnlineFlagRequestDto{ - IsOnline: false, + IsOnline: true, }) if err != nil { log.Fatal(err) diff --git a/docs/sdks/topicssubscribers/README.md b/docs/sdks/topicssubscribers/README.md index 31aadc9..5f29880 100644 --- a/docs/sdks/topicssubscribers/README.md +++ b/docs/sdks/topicssubscribers/README.md @@ -35,7 +35,6 @@ func main() { Subscribers: []string{ "", "", - "", }, }) if err != nil { diff --git a/models/components/triggereventrequestdto.go b/models/components/triggereventrequestdto.go index 4579896..dd1e685 100644 --- a/models/components/triggereventrequestdto.go +++ b/models/components/triggereventrequestdto.go @@ -351,6 +351,8 @@ type TriggerEventRequestDto struct { // 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 Actor *Actor `json:"actor,omitempty"` // It is used to specify a tenant context during trigger event. diff --git a/novu.go b/novu.go index 91ae9e5..ceff6e3 100644 --- a/novu.go +++ b/novu.go @@ -171,9 +171,9 @@ func New(opts ...SDKOption) *Novu { sdkConfiguration: sdkConfiguration{ Language: "go", OpenAPIDocVersion: "1.0", - SDKVersion: "0.0.4", - GenVersion: "2.493.21", - UserAgent: "speakeasy-sdk/go 0.0.4 2.493.21 1.0 github.com/novuhq/novu-go", + SDKVersion: "0.0.5", + GenVersion: "2.493.23", + UserAgent: "speakeasy-sdk/go 0.0.5 2.493.23 1.0 github.com/novuhq/novu-go", Hooks: hooks.New(), }, }