@mazmo/sdk 2.0.0 → 3.1.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.85 of the Mazmo API.

package/dist/index.cjs

@@ -302,6 +302,7 @@ var routes = {
     listBlocks: { method: "GET", path: "/users/blocks" },
     listFollowLists: { method: "GET", path: "/users/followlists" },
     listMyOrgPointsLedger: { method: "GET", path: "/users/orgpoints/ledger" },
+    listOrganizationWebhookDeliveries: { method: "GET", path: "/users/:username/webhookdeliveries" },
     listOrgPointsHolders: { method: "GET", path: "/users/orgpoints/users" },
     listReports: { method: "GET", path: "/users/reports" },
     listSavedSearches: { method: "GET", path: "/users/saved-searches" },
@@ -316,6 +317,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,61 @@ interface Order {
     createdAt: string;
     updatedAt: string;
 }
+interface OrganizationWebhookDeliveries {
+    deliveries: OrganizationWebhookDelivery[];
+}
+interface OrganizationWebhookDelivery {
+    id: string;
+    event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+    /**
+     * The URL the event was sent to.
+     */
+    url: string;
+    /**
+     * When the last attempt was sent.
+     */
+    sentAt: string;
+    /**
+     * How many attempts it took, the last one included.
+     */
+    attempts: number;
+    /**
+     * Whether the URL answered a 2xx status.
+     */
+    delivered: boolean;
+    /**
+     * The HTTP status the URL answered on the last attempt, or null when it answered none.
+     */
+    status: number | null;
+    /**
+     * Why the last attempt got no response: `timeout` when the URL answered nothing in time, `refused` when it refused the connection, `dns` when its host does not resolve, `not-public` when it points to an address that is not public, `connection` when it could not be reached otherwise. Null when it answered a status.
+     */
+    error: "timeout" | "refused" | "dns" | "not-public" | "connection" | null;
+    /**
+     * How long the last attempt took, in milliseconds.
+     */
+    durationMs: number;
+    /**
+     * The first 500 characters of the body the URL answered, or null when it answered none.
+     */
+    response: string | null;
+}
+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 +1557,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 +1612,10 @@ interface OwnMembership {
     createdAt: string;
     updatedAt: string;
 }
+interface PausedOrganizationWebhook {
+    pausedAt: string;
+    lastError: OrganizationWebhookError;
+}
 interface Place {
     id: string;
     name: string;
@@ -6436,6 +6509,26 @@ interface UsersListMyOrgPointsLedger {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
 }
+/**
+ * GET /users/:username/webhookdeliveries
+ *
+ * List the webhook deliveries
+ */
+interface UsersListOrganizationWebhookDeliveries {
+    request: {
+        params: {
+            username: string;
+        };
+        query?: {
+            /**
+             * Only the deliveries of this event. Leaving it out answers those of every event.
+             */
+            event?: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+        };
+    };
+    response: OrganizationWebhookDeliveries;
+    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
+}
 /**
  * GET /users/orgpoints/users
  *
@@ -6869,6 +6962,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
  *
@@ -8336,6 +8443,7 @@ type Endpoints = {
         listBlocks: UsersListBlocks;
         listFollowLists: UsersListFollowLists;
         listMyOrgPointsLedger: UsersListMyOrgPointsLedger;
+        listOrganizationWebhookDeliveries: UsersListOrganizationWebhookDeliveries;
         listOrgPointsHolders: UsersListOrgPointsHolders;
         listReports: UsersListReports;
         listSavedSearches: UsersListSavedSearches;
@@ -8350,6 +8458,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,61 @@ interface Order {
     createdAt: string;
     updatedAt: string;
 }
+interface OrganizationWebhookDeliveries {
+    deliveries: OrganizationWebhookDelivery[];
+}
+interface OrganizationWebhookDelivery {
+    id: string;
+    event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+    /**
+     * The URL the event was sent to.
+     */
+    url: string;
+    /**
+     * When the last attempt was sent.
+     */
+    sentAt: string;
+    /**
+     * How many attempts it took, the last one included.
+     */
+    attempts: number;
+    /**
+     * Whether the URL answered a 2xx status.
+     */
+    delivered: boolean;
+    /**
+     * The HTTP status the URL answered on the last attempt, or null when it answered none.
+     */
+    status: number | null;
+    /**
+     * Why the last attempt got no response: `timeout` when the URL answered nothing in time, `refused` when it refused the connection, `dns` when its host does not resolve, `not-public` when it points to an address that is not public, `connection` when it could not be reached otherwise. Null when it answered a status.
+     */
+    error: "timeout" | "refused" | "dns" | "not-public" | "connection" | null;
+    /**
+     * How long the last attempt took, in milliseconds.
+     */
+    durationMs: number;
+    /**
+     * The first 500 characters of the body the URL answered, or null when it answered none.
+     */
+    response: string | null;
+}
+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 +1557,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 +1612,10 @@ interface OwnMembership {
     createdAt: string;
     updatedAt: string;
 }
+interface PausedOrganizationWebhook {
+    pausedAt: string;
+    lastError: OrganizationWebhookError;
+}
 interface Place {
     id: string;
     name: string;
@@ -6436,6 +6509,26 @@ interface UsersListMyOrgPointsLedger {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
 }
+/**
+ * GET /users/:username/webhookdeliveries
+ *
+ * List the webhook deliveries
+ */
+interface UsersListOrganizationWebhookDeliveries {
+    request: {
+        params: {
+            username: string;
+        };
+        query?: {
+            /**
+             * Only the deliveries of this event. Leaving it out answers those of every event.
+             */
+            event?: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+        };
+    };
+    response: OrganizationWebhookDeliveries;
+    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
+}
 /**
  * GET /users/orgpoints/users
  *
@@ -6869,6 +6962,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
  *
@@ -8336,6 +8443,7 @@ type Endpoints = {
         listBlocks: UsersListBlocks;
         listFollowLists: UsersListFollowLists;
         listMyOrgPointsLedger: UsersListMyOrgPointsLedger;
+        listOrganizationWebhookDeliveries: UsersListOrganizationWebhookDeliveries;
         listOrgPointsHolders: UsersListOrgPointsHolders;
         listReports: UsersListReports;
         listSavedSearches: UsersListSavedSearches;
@@ -8350,6 +8458,7 @@ type Endpoints = {
         renameDevice: UsersRenameDevice;
         renameFollowList: UsersRenameFollowList;
         renameSavedSearch: UsersRenameSavedSearch;
+        resumeOrganizationWebhook: UsersResumeOrganizationWebhook;
         revokeOtherSessions: UsersRevokeOtherSessions;
         revokeSession: UsersRevokeSession;
         rotateOrganizationWebhooksSecret: UsersRotateOrganizationWebhooksSecret;

package/dist/index.js

@@ -300,6 +300,7 @@ var routes = {
     listBlocks: { method: "GET", path: "/users/blocks" },
     listFollowLists: { method: "GET", path: "/users/followlists" },
     listMyOrgPointsLedger: { method: "GET", path: "/users/orgpoints/ledger" },
+    listOrganizationWebhookDeliveries: { method: "GET", path: "/users/:username/webhookdeliveries" },
     listOrgPointsHolders: { method: "GET", path: "/users/orgpoints/users" },
     listReports: { method: "GET", path: "/users/reports" },
     listSavedSearches: { method: "GET", path: "/users/saved-searches" },
@@ -314,6 +315,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.1.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": "2a14e9bf74372e764d5bdab5cb2fea41c5d7a144",
+    "apiVersion": "7.7.85"
   }
 }