@mazmo/sdk 2.0.0 → 3.0.0

package/README.md

@@ -52,4 +52,4 @@ Each release says, at the end of this page, which version of the API it was buil
 
 The reference of every endpoint is at [docs.mazmo.net](https://docs.mazmo.net).
 
-Built against version 7.7.81 of the Mazmo API.
+Built against version 7.7.82 of the Mazmo API.

package/dist/index.cjs

@@ -316,6 +316,7 @@ var routes = {
     renameDevice: { method: "PATCH", path: "/users/devices/:deviceId" },
     renameFollowList: { method: "PUT", path: "/users/followlists/:listId/name" },
     renameSavedSearch: { method: "PATCH", path: "/users/saved-searches/:id" },
+    resumeOrganizationWebhook: { method: "POST", path: "/users/organizationwebhooks/resume" },
     revokeOtherSessions: { method: "DELETE", path: "/users/sessions/others" },
     revokeSession: { method: "DELETE", path: "/users/sessions/:id" },
     rotateOrganizationWebhooksSecret: { method: "POST", path: "/users/organizationwebhooks/secret" },

package/dist/index.d.cts

@@ -64,7 +64,7 @@ interface AdminCoupon {
     createdAt: string;
     updatedAt: string;
 }
-type Alert = CommunityInviteCreatedAlert | ReactionReplyCreatedAlert | ReactionThreadCreatedAlert | FollowCreatedAlert | KnowCreatedAlert | KnowBannedAlert | CommentCreatedAlert | ReactionCommentCreatedAlert | ReactionPublicationCreatedAlert | RelationshipRequestedAlert | RelationshipApprovedAlert | RelationshipRejectedAlert | RelationshipRemovedAlert | SadesAssignmentAlert | SadesTransactionAlert | MessengerApprovedAlert | MessengerRequestedAlert | ChatChannelDeletedAlert | ChannelInvitationCreatedAlert | FeedPublicationReactedAlert | FeedCommentReactedAlert | FeedCommentCreatedAlert | FeedPublicationMentionAlert | FeedPublicationModeratedAlert | CommunitiesThreadMentionAlert | FeedPublicationVoteAlert | RsvpBannedAlert | RsvpCreatedAlert | BankTransactionCreatedAlert | ChatRequestsRefilledAlert | ThreadAwardedAlert | ReplyAwardedAlert | PublicationSingleUnlockedAlert | PublicationCrowdUnlockedAlert | TagExpiredAlert | EventInviteAlert | EnrollmentApprovedAlert | TagsGiftedAlert | OrgPointsTransferredAlert | VideoProcessingCompleteAlert | VideoProcessingFailedAlert | BugReportRejectedAlert | BugReportResolvedAlert | ChatterScoreStateChangedAlert | AnnouncementAlert | SubscriptionRenewalFailedAlert;
+type Alert = CommunityInviteCreatedAlert | ReactionReplyCreatedAlert | ReactionThreadCreatedAlert | FollowCreatedAlert | KnowCreatedAlert | KnowBannedAlert | CommentCreatedAlert | ReactionCommentCreatedAlert | ReactionPublicationCreatedAlert | RelationshipRequestedAlert | RelationshipApprovedAlert | RelationshipRejectedAlert | RelationshipRemovedAlert | SadesAssignmentAlert | SadesTransactionAlert | MessengerApprovedAlert | MessengerRequestedAlert | ChatChannelDeletedAlert | ChannelInvitationCreatedAlert | FeedPublicationReactedAlert | FeedCommentReactedAlert | FeedCommentCreatedAlert | FeedPublicationMentionAlert | FeedPublicationModeratedAlert | CommunitiesThreadMentionAlert | FeedPublicationVoteAlert | RsvpBannedAlert | RsvpCreatedAlert | BankTransactionCreatedAlert | ChatRequestsRefilledAlert | ThreadAwardedAlert | ReplyAwardedAlert | PublicationSingleUnlockedAlert | PublicationCrowdUnlockedAlert | TagExpiredAlert | EventInviteAlert | EnrollmentApprovedAlert | TagsGiftedAlert | OrgPointsTransferredAlert | VideoProcessingCompleteAlert | VideoProcessingFailedAlert | BugReportRejectedAlert | BugReportResolvedAlert | ChatterScoreStateChangedAlert | AnnouncementAlert | SubscriptionRenewalFailedAlert | OrgWebhookPausedAlert;
 interface AlertComment {
     id: string;
     content?: string;
@@ -1459,8 +1459,22 @@ interface Order {
     createdAt: string;
     updatedAt: string;
 }
+interface OrganizationWebhookError {
+    /**
+     * `status` when the URL answered an error status, `timeout` when it answered nothing in time, `connection` when it could not be reached.
+     */
+    reason: "status" | "timeout" | "connection";
+    /**
+     * The HTTP status the URL answered, or null when it answered none.
+     */
+    status: number | null;
+}
 interface OrganizationWebhooks {
     hooks: Partial<Record<"channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban", string>>;
+    /**
+     * The events whose URL kept failing, which are not delivered until the webhook is resumed or its URL changes. An event that is delivered is not in it.
+     */
+    paused: Partial<Record<"channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban", PausedOrganizationWebhook>>;
     secret: string | null;
 }
 interface OrgPointsHolder {
@@ -1504,6 +1518,22 @@ interface OrgPointsTransferredAlert {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * A webhook of the organization was paused because its URL kept failing.
+ */
+interface OrgWebhookPausedAlert {
+    id: string;
+    type: "ORG_WEBHOOK_PAUSED";
+    payload: {
+        event: string;
+        url: string;
+        lastError: OrganizationWebhookError;
+    };
+    userId: number;
+    read: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
 interface OwnMembership {
     _id: string;
     id: string;
@@ -1543,6 +1573,10 @@ interface OwnMembership {
     createdAt: string;
     updatedAt: string;
 }
+interface PausedOrganizationWebhook {
+    pausedAt: string;
+    lastError: OrganizationWebhookError;
+}
 interface Place {
     id: string;
     name: string;
@@ -6869,6 +6903,20 @@ interface UsersRenameSavedSearch {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"LOW_PLAN">;
 }
+/**
+ * POST /users/organizationwebhooks/resume
+ *
+ * Resume a webhook
+ */
+interface UsersResumeOrganizationWebhook {
+    request: {
+        body: {
+            event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+        };
+    };
+    response: OrganizationWebhooks;
+    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
+}
 /**
  * DELETE /users/sessions/others
  *
@@ -8350,6 +8398,7 @@ type Endpoints = {
         renameDevice: UsersRenameDevice;
         renameFollowList: UsersRenameFollowList;
         renameSavedSearch: UsersRenameSavedSearch;
+        resumeOrganizationWebhook: UsersResumeOrganizationWebhook;
         revokeOtherSessions: UsersRevokeOtherSessions;
         revokeSession: UsersRevokeSession;
         rotateOrganizationWebhooksSecret: UsersRotateOrganizationWebhooksSecret;

package/dist/index.d.ts

@@ -64,7 +64,7 @@ interface AdminCoupon {
     createdAt: string;
     updatedAt: string;
 }
-type Alert = CommunityInviteCreatedAlert | ReactionReplyCreatedAlert | ReactionThreadCreatedAlert | FollowCreatedAlert | KnowCreatedAlert | KnowBannedAlert | CommentCreatedAlert | ReactionCommentCreatedAlert | ReactionPublicationCreatedAlert | RelationshipRequestedAlert | RelationshipApprovedAlert | RelationshipRejectedAlert | RelationshipRemovedAlert | SadesAssignmentAlert | SadesTransactionAlert | MessengerApprovedAlert | MessengerRequestedAlert | ChatChannelDeletedAlert | ChannelInvitationCreatedAlert | FeedPublicationReactedAlert | FeedCommentReactedAlert | FeedCommentCreatedAlert | FeedPublicationMentionAlert | FeedPublicationModeratedAlert | CommunitiesThreadMentionAlert | FeedPublicationVoteAlert | RsvpBannedAlert | RsvpCreatedAlert | BankTransactionCreatedAlert | ChatRequestsRefilledAlert | ThreadAwardedAlert | ReplyAwardedAlert | PublicationSingleUnlockedAlert | PublicationCrowdUnlockedAlert | TagExpiredAlert | EventInviteAlert | EnrollmentApprovedAlert | TagsGiftedAlert | OrgPointsTransferredAlert | VideoProcessingCompleteAlert | VideoProcessingFailedAlert | BugReportRejectedAlert | BugReportResolvedAlert | ChatterScoreStateChangedAlert | AnnouncementAlert | SubscriptionRenewalFailedAlert;
+type Alert = CommunityInviteCreatedAlert | ReactionReplyCreatedAlert | ReactionThreadCreatedAlert | FollowCreatedAlert | KnowCreatedAlert | KnowBannedAlert | CommentCreatedAlert | ReactionCommentCreatedAlert | ReactionPublicationCreatedAlert | RelationshipRequestedAlert | RelationshipApprovedAlert | RelationshipRejectedAlert | RelationshipRemovedAlert | SadesAssignmentAlert | SadesTransactionAlert | MessengerApprovedAlert | MessengerRequestedAlert | ChatChannelDeletedAlert | ChannelInvitationCreatedAlert | FeedPublicationReactedAlert | FeedCommentReactedAlert | FeedCommentCreatedAlert | FeedPublicationMentionAlert | FeedPublicationModeratedAlert | CommunitiesThreadMentionAlert | FeedPublicationVoteAlert | RsvpBannedAlert | RsvpCreatedAlert | BankTransactionCreatedAlert | ChatRequestsRefilledAlert | ThreadAwardedAlert | ReplyAwardedAlert | PublicationSingleUnlockedAlert | PublicationCrowdUnlockedAlert | TagExpiredAlert | EventInviteAlert | EnrollmentApprovedAlert | TagsGiftedAlert | OrgPointsTransferredAlert | VideoProcessingCompleteAlert | VideoProcessingFailedAlert | BugReportRejectedAlert | BugReportResolvedAlert | ChatterScoreStateChangedAlert | AnnouncementAlert | SubscriptionRenewalFailedAlert | OrgWebhookPausedAlert;
 interface AlertComment {
     id: string;
     content?: string;
@@ -1459,8 +1459,22 @@ interface Order {
     createdAt: string;
     updatedAt: string;
 }
+interface OrganizationWebhookError {
+    /**
+     * `status` when the URL answered an error status, `timeout` when it answered nothing in time, `connection` when it could not be reached.
+     */
+    reason: "status" | "timeout" | "connection";
+    /**
+     * The HTTP status the URL answered, or null when it answered none.
+     */
+    status: number | null;
+}
 interface OrganizationWebhooks {
     hooks: Partial<Record<"channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban", string>>;
+    /**
+     * The events whose URL kept failing, which are not delivered until the webhook is resumed or its URL changes. An event that is delivered is not in it.
+     */
+    paused: Partial<Record<"channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban", PausedOrganizationWebhook>>;
     secret: string | null;
 }
 interface OrgPointsHolder {
@@ -1504,6 +1518,22 @@ interface OrgPointsTransferredAlert {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * A webhook of the organization was paused because its URL kept failing.
+ */
+interface OrgWebhookPausedAlert {
+    id: string;
+    type: "ORG_WEBHOOK_PAUSED";
+    payload: {
+        event: string;
+        url: string;
+        lastError: OrganizationWebhookError;
+    };
+    userId: number;
+    read: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
 interface OwnMembership {
     _id: string;
     id: string;
@@ -1543,6 +1573,10 @@ interface OwnMembership {
     createdAt: string;
     updatedAt: string;
 }
+interface PausedOrganizationWebhook {
+    pausedAt: string;
+    lastError: OrganizationWebhookError;
+}
 interface Place {
     id: string;
     name: string;
@@ -6869,6 +6903,20 @@ interface UsersRenameSavedSearch {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"LOW_PLAN">;
 }
+/**
+ * POST /users/organizationwebhooks/resume
+ *
+ * Resume a webhook
+ */
+interface UsersResumeOrganizationWebhook {
+    request: {
+        body: {
+            event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+        };
+    };
+    response: OrganizationWebhooks;
+    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
+}
 /**
  * DELETE /users/sessions/others
  *
@@ -8350,6 +8398,7 @@ type Endpoints = {
         renameDevice: UsersRenameDevice;
         renameFollowList: UsersRenameFollowList;
         renameSavedSearch: UsersRenameSavedSearch;
+        resumeOrganizationWebhook: UsersResumeOrganizationWebhook;
         revokeOtherSessions: UsersRevokeOtherSessions;
         revokeSession: UsersRevokeSession;
         rotateOrganizationWebhooksSecret: UsersRotateOrganizationWebhooksSecret;

package/dist/index.js

@@ -314,6 +314,7 @@ var routes = {
     renameDevice: { method: "PATCH", path: "/users/devices/:deviceId" },
     renameFollowList: { method: "PUT", path: "/users/followlists/:listId/name" },
     renameSavedSearch: { method: "PATCH", path: "/users/saved-searches/:id" },
+    resumeOrganizationWebhook: { method: "POST", path: "/users/organizationwebhooks/resume" },
     revokeOtherSessions: { method: "DELETE", path: "/users/sessions/others" },
     revokeSession: { method: "DELETE", path: "/users/sessions/:id" },
     rotateOrganizationWebhooksSecret: { method: "POST", path: "/users/organizationwebhooks/secret" },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mazmo/sdk",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Typed client for the Mazmo API",
   "license": "MIT",
   "homepage": "https://docs.mazmo.net",
@@ -33,7 +33,7 @@
     "node": ">=18"
   },
   "mazmo": {
-    "commit": "7b6940df44678212506dddd7e0b1318b2c3ab140",
-    "apiVersion": "7.7.81"
+    "commit": "5620500a62562867e30e0dfb18a6dbe2c1ea1384",
+    "apiVersion": "7.7.82"
   }
 }