@mazmo/sdk 3.0.0 → 4.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.82 of the Mazmo API.
+Built against version 7.7.87 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" },
@@ -323,6 +324,7 @@ var routes = {
     searchAdvancedUsers: { method: "GET", path: "/users/advanced-search" },
     searchUsers: { method: "GET", path: "/users/search/:query" },
     sortTags: { method: "PUT", path: "/users/tags/sort" },
+    testOrganizationWebhook: { method: "POST", path: "/users/organizationwebhooks/test" },
     transferOrgPoints: { method: "POST", path: "/users/orgpoints/transfer" },
     updateAvatar: { method: "PUT", path: "/users/avatar" },
     updateCover: { method: "PUT", path: "/users/cover" },

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 | OrgWebhookPausedAlert;
+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 | MercadopagoDisconnectedAlert;
 interface AlertComment {
     id: string;
     content?: string;
@@ -1350,6 +1350,18 @@ interface Membership {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * The MercadoPago account linked to the account stopped working and has to be linked again to receive payments.
+ */
+interface MercadopagoDisconnectedAlert {
+    id: string;
+    type: "MERCADOPAGO_DISCONNECTED";
+    payload: Record<string, never>;
+    userId: number;
+    read: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
 interface Messenger {
     id: string;
     participants: MessengerParticipant[];
@@ -1459,6 +1471,49 @@ 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;
+    /**
+     * Whether it was a test delivery, requested by the organization, with made-up data.
+     */
+    test: boolean;
+}
 interface OrganizationWebhookError {
     /**
      * `status` when the URL answered an error status, `timeout` when it answered nothing in time, `connection` when it could not be reached.
@@ -6470,6 +6525,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
  *
@@ -7121,6 +7196,20 @@ interface UsersSortTags {
     }) | HiddenUser | ClosedUser;
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"INVALID_PARAMS">;
 }
+/**
+ * POST /users/organizationwebhooks/test
+ *
+ * Send a test delivery to a webhook
+ */
+interface UsersTestOrganizationWebhook {
+    request: {
+        body: {
+            event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+        };
+    };
+    response: OrganizationWebhookDelivery;
+    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
+}
 /**
  * POST /users/orgpoints/transfer
  *
@@ -8384,6 +8473,7 @@ type Endpoints = {
         listBlocks: UsersListBlocks;
         listFollowLists: UsersListFollowLists;
         listMyOrgPointsLedger: UsersListMyOrgPointsLedger;
+        listOrganizationWebhookDeliveries: UsersListOrganizationWebhookDeliveries;
         listOrgPointsHolders: UsersListOrgPointsHolders;
         listReports: UsersListReports;
         listSavedSearches: UsersListSavedSearches;
@@ -8405,6 +8495,7 @@ type Endpoints = {
         searchAdvancedUsers: UsersSearchAdvancedUsers;
         searchUsers: UsersSearchUsers;
         sortTags: UsersSortTags;
+        testOrganizationWebhook: UsersTestOrganizationWebhook;
         transferOrgPoints: UsersTransferOrgPoints;
         updateAvatar: UsersUpdateAvatar;
         updateCover: UsersUpdateCover;

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 | OrgWebhookPausedAlert;
+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 | MercadopagoDisconnectedAlert;
 interface AlertComment {
     id: string;
     content?: string;
@@ -1350,6 +1350,18 @@ interface Membership {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * The MercadoPago account linked to the account stopped working and has to be linked again to receive payments.
+ */
+interface MercadopagoDisconnectedAlert {
+    id: string;
+    type: "MERCADOPAGO_DISCONNECTED";
+    payload: Record<string, never>;
+    userId: number;
+    read: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
 interface Messenger {
     id: string;
     participants: MessengerParticipant[];
@@ -1459,6 +1471,49 @@ 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;
+    /**
+     * Whether it was a test delivery, requested by the organization, with made-up data.
+     */
+    test: boolean;
+}
 interface OrganizationWebhookError {
     /**
      * `status` when the URL answered an error status, `timeout` when it answered nothing in time, `connection` when it could not be reached.
@@ -6470,6 +6525,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
  *
@@ -7121,6 +7196,20 @@ interface UsersSortTags {
     }) | HiddenUser | ClosedUser;
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"INVALID_PARAMS">;
 }
+/**
+ * POST /users/organizationwebhooks/test
+ *
+ * Send a test delivery to a webhook
+ */
+interface UsersTestOrganizationWebhook {
+    request: {
+        body: {
+            event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
+        };
+    };
+    response: OrganizationWebhookDelivery;
+    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
+}
 /**
  * POST /users/orgpoints/transfer
  *
@@ -8384,6 +8473,7 @@ type Endpoints = {
         listBlocks: UsersListBlocks;
         listFollowLists: UsersListFollowLists;
         listMyOrgPointsLedger: UsersListMyOrgPointsLedger;
+        listOrganizationWebhookDeliveries: UsersListOrganizationWebhookDeliveries;
         listOrgPointsHolders: UsersListOrgPointsHolders;
         listReports: UsersListReports;
         listSavedSearches: UsersListSavedSearches;
@@ -8405,6 +8495,7 @@ type Endpoints = {
         searchAdvancedUsers: UsersSearchAdvancedUsers;
         searchUsers: UsersSearchUsers;
         sortTags: UsersSortTags;
+        testOrganizationWebhook: UsersTestOrganizationWebhook;
         transferOrgPoints: UsersTransferOrgPoints;
         updateAvatar: UsersUpdateAvatar;
         updateCover: UsersUpdateCover;

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" },
@@ -321,6 +322,7 @@ var routes = {
     searchAdvancedUsers: { method: "GET", path: "/users/advanced-search" },
     searchUsers: { method: "GET", path: "/users/search/:query" },
     sortTags: { method: "PUT", path: "/users/tags/sort" },
+    testOrganizationWebhook: { method: "POST", path: "/users/organizationwebhooks/test" },
     transferOrgPoints: { method: "POST", path: "/users/orgpoints/transfer" },
     updateAvatar: { method: "PUT", path: "/users/avatar" },
     updateCover: { method: "PUT", path: "/users/cover" },

package/package.json

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