@mazmo/sdk 4.1.0 → 5.0.0

package/README.md

@@ -45,11 +45,12 @@ The SDK follows semver, and a release says what changed in the API's public endp
 
 - **major**: an endpoint was removed, or changed in a way code written against the previous version may
   not handle;
-- **minor**: an endpoint or a field was added;
+- **minor**: an endpoint, a field, or a value of an enum was added. Keep a `default` when you switch
+  over an enum the API answers, as you do over the error codes;
 - **patch**: the SDK itself changed, not the endpoints.
 
 Each release says, at the end of this page, which version of the API it was built against.
 
 The reference of every endpoint is at [docs.mazmo.net](https://docs.mazmo.net).
 
-Built against version 7.7.96 of the Mazmo API.
+Built against version 7.7.97 of the Mazmo API.

package/dist/index.cjs

@@ -82,7 +82,6 @@ var routes = {
   },
   bank: {
     acknowledgeCoupon: { method: "PUT", path: "/bank/coupons/:couponCode" },
-    createOrder: { method: "POST", path: "/bank/orders" },
     createTransaction: { method: "POST", path: "/bank/transactions" },
     deleteCoupon: { method: "DELETE", path: "/bank/coupons/:couponId" },
     getCoupon: { method: "GET", path: "/bank/coupons/:couponCode" },
@@ -279,14 +278,11 @@ var routes = {
     addToFollowList: { method: "POST", path: "/users/followlists/:listId" },
     assignOrgPoints: { method: "POST", path: "/users/orgpoints/assign" },
     cancelMySubscription: { method: "DELETE", path: "/users/subscriptions" },
-    cancelSubscription: { method: "DELETE", path: "/users/subscriptions/:subscriptionId" },
-    connectMercadopago: { method: "POST", path: "/users/marketplace/mercadopago" },
     createBlock: { method: "POST", path: "/users/blocks" },
     createFollowList: { method: "POST", path: "/users/followlists" },
     createOrganizationSession: { method: "POST", path: "/users/organizations/session" },
     createReport: { method: "POST", path: "/users/reports" },
     createSavedSearch: { method: "POST", path: "/users/saved-searches" },
-    createSubscription: { method: "POST", path: "/users/subscriptions" },
     deleteFollowList: { method: "DELETE", path: "/users/followlists/:listId" },
     deleteSavedSearch: { method: "DELETE", path: "/users/saved-searches/:id" },
     dismissSuggestion: { method: "DELETE", path: "/users/suggestions/:userId" },

package/dist/index.d.cts

@@ -1441,40 +1441,6 @@ interface Onboarding {
         emailConfirm: boolean;
     };
 }
-interface Order {
-    id: string;
-    buyerId: number;
-    item: {
-        name: string;
-        data?: unknown;
-    };
-    completed: boolean;
-    mercadopago?: {
-        preference?: unknown;
-    };
-    paypal?: {
-        order?: unknown;
-        payments?: unknown[];
-    };
-    gumroad?: {
-        saleId?: string;
-        sale?: unknown;
-    };
-    coupon?: string | Coupon;
-    invoice?: {
-        items: Array<{
-            _id?: string;
-            id?: string;
-            name?: string;
-            total?: number;
-        }>;
-        subtotal?: number;
-        total?: number;
-        currency: "ARS" | "USD";
-    };
-    createdAt: string;
-    updatedAt: string;
-}
 interface OrganizationWebhookDeliveries {
     deliveries: OrganizationWebhookDelivery[];
 }
@@ -2922,23 +2888,6 @@ interface BankAcknowledgeCoupon {
     response: Coupon;
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
 }
-/**
- * POST /bank/orders
- *
- * Start a purchase
- */
-interface BankCreateOrder {
-    request: {
-        body: {
-            itemName: string;
-            itemData?: unknown;
-            paymentMethod: string;
-            coupon?: string;
-        };
-    };
-    response: Order;
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"EVENT_STARTED"> | ApiErrorOf<"BANNED"> | ApiErrorOf<"RSVP_LIMIT_REACHED"> | ApiErrorOf<"ENROLLMENT_REQUIRED"> | ApiErrorOf<"ALREADY_RSVPD"> | ApiErrorOf<"MARKETPLACE_NOT_FOUND"> | ApiErrorOf<"IVALID_PAYMENT_METHOD"> | ApiErrorOf<"ITEM_NOT_FOUND"> | ApiErrorOf<"COUPON_DOESNT_EXIST"> | ApiErrorOf<"COUPON_ALREADY_USED"> | ApiErrorOf<"COUPON_EXPIRED">;
-}
 /**
  * POST /bank/transactions
  *
@@ -6159,38 +6108,6 @@ interface UsersCancelMySubscription {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ACTIVE_SUBSCRIPTION"> | ApiErrorOf<"CANCEL_ON_PROVIDER_SITE">;
 }
-/**
- * DELETE /users/subscriptions/:subscriptionId
- *
- * Drop a pending subscription
- */
-interface UsersCancelSubscription {
-    request: {
-        params: {
-            subscriptionId: string;
-        };
-    };
-    response: {
-        success: true;
-        result: string;
-    };
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"INVALID_PARAMS"> | ApiErrorOf<"UNAUTHORIZED"> | ApiErrorOf<"NOT_ACTIVE_SUBSCRIPTION"> | ApiErrorOf<"CANCEL_ON_PROVIDER_SITE">;
-}
-/**
- * POST /users/marketplace/mercadopago
- *
- * Connect Mercado Pago
- */
-interface UsersConnectMercadopago {
-    request: {
-        body: {
-            code: string;
-            redirectUri: string;
-        };
-    };
-    response: string;
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
-}
 /**
  * POST /users/blocks
  *
@@ -6267,56 +6184,6 @@ interface UsersCreateSavedSearch {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"LOW_PLAN"> | ApiErrorOf<"LIMIT_REACHED">;
 }
-/**
- * POST /users/subscriptions
- *
- * Subscribe to a membership
- */
-interface UsersCreateSubscription {
-    request: {
-        body: {
-            planName: "BASIC" | "VELVET" | "LATEX" | "LEATHER";
-            provider: "mercadopago" | "gumroad";
-            email?: string;
-        };
-    };
-    response: {
-        success: true;
-        result: string;
-        data: {
-            updated: boolean;
-        };
-        upserted: {
-            subscriptions: Record<string, {
-                id: string;
-                userId: string;
-                provider: "mercadopago" | "paypal" | "gumroad" | "complimentary";
-                providerSubscriptionId?: string;
-                providerSubscriptionInitPoint?: string;
-                status: "active" | "cancelled" | "paused" | "pending";
-                planName: "BASIC" | "VELVET" | "LATEX" | "LEATHER";
-                amount: number;
-                currency: "ARS" | "USD";
-                startedAt?: string;
-                cancelledAt?: string;
-                validUntil?: string;
-                nextPaymentDate?: string;
-                lastPaymentAt?: string;
-                renewalFailed: boolean;
-                manageUrl?: string;
-                payments: Array<{
-                    id: string;
-                    status?: "approved" | "failed" | "refunded";
-                    currency?: "ARS" | "USD";
-                    amount: number;
-                    paidAt?: string;
-                    providerPaymentId?: string;
-                }>;
-            }>;
-        };
-    };
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"MERCADOPAGO_FOREIGN_PAYER"> | ApiErrorOf<"EMAIL_REQUIRED">;
-}
 /**
  * DELETE /users/followlists/:listId
  *
@@ -8313,7 +8180,6 @@ type Endpoints = {
     };
     bank: {
         acknowledgeCoupon: BankAcknowledgeCoupon;
-        createOrder: BankCreateOrder;
         createTransaction: BankCreateTransaction;
         deleteCoupon: BankDeleteCoupon;
         getCoupon: BankGetCoupon;
@@ -8510,14 +8376,11 @@ type Endpoints = {
         addToFollowList: UsersAddToFollowList;
         assignOrgPoints: UsersAssignOrgPoints;
         cancelMySubscription: UsersCancelMySubscription;
-        cancelSubscription: UsersCancelSubscription;
-        connectMercadopago: UsersConnectMercadopago;
         createBlock: UsersCreateBlock;
         createFollowList: UsersCreateFollowList;
         createOrganizationSession: UsersCreateOrganizationSession;
         createReport: UsersCreateReport;
         createSavedSearch: UsersCreateSavedSearch;
-        createSubscription: UsersCreateSubscription;
         deleteFollowList: UsersDeleteFollowList;
         deleteSavedSearch: UsersDeleteSavedSearch;
         dismissSuggestion: UsersDismissSuggestion;

package/dist/index.d.ts

@@ -1441,40 +1441,6 @@ interface Onboarding {
         emailConfirm: boolean;
     };
 }
-interface Order {
-    id: string;
-    buyerId: number;
-    item: {
-        name: string;
-        data?: unknown;
-    };
-    completed: boolean;
-    mercadopago?: {
-        preference?: unknown;
-    };
-    paypal?: {
-        order?: unknown;
-        payments?: unknown[];
-    };
-    gumroad?: {
-        saleId?: string;
-        sale?: unknown;
-    };
-    coupon?: string | Coupon;
-    invoice?: {
-        items: Array<{
-            _id?: string;
-            id?: string;
-            name?: string;
-            total?: number;
-        }>;
-        subtotal?: number;
-        total?: number;
-        currency: "ARS" | "USD";
-    };
-    createdAt: string;
-    updatedAt: string;
-}
 interface OrganizationWebhookDeliveries {
     deliveries: OrganizationWebhookDelivery[];
 }
@@ -2922,23 +2888,6 @@ interface BankAcknowledgeCoupon {
     response: Coupon;
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
 }
-/**
- * POST /bank/orders
- *
- * Start a purchase
- */
-interface BankCreateOrder {
-    request: {
-        body: {
-            itemName: string;
-            itemData?: unknown;
-            paymentMethod: string;
-            coupon?: string;
-        };
-    };
-    response: Order;
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"EVENT_STARTED"> | ApiErrorOf<"BANNED"> | ApiErrorOf<"RSVP_LIMIT_REACHED"> | ApiErrorOf<"ENROLLMENT_REQUIRED"> | ApiErrorOf<"ALREADY_RSVPD"> | ApiErrorOf<"MARKETPLACE_NOT_FOUND"> | ApiErrorOf<"IVALID_PAYMENT_METHOD"> | ApiErrorOf<"ITEM_NOT_FOUND"> | ApiErrorOf<"COUPON_DOESNT_EXIST"> | ApiErrorOf<"COUPON_ALREADY_USED"> | ApiErrorOf<"COUPON_EXPIRED">;
-}
 /**
  * POST /bank/transactions
  *
@@ -6159,38 +6108,6 @@ interface UsersCancelMySubscription {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ACTIVE_SUBSCRIPTION"> | ApiErrorOf<"CANCEL_ON_PROVIDER_SITE">;
 }
-/**
- * DELETE /users/subscriptions/:subscriptionId
- *
- * Drop a pending subscription
- */
-interface UsersCancelSubscription {
-    request: {
-        params: {
-            subscriptionId: string;
-        };
-    };
-    response: {
-        success: true;
-        result: string;
-    };
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"INVALID_PARAMS"> | ApiErrorOf<"UNAUTHORIZED"> | ApiErrorOf<"NOT_ACTIVE_SUBSCRIPTION"> | ApiErrorOf<"CANCEL_ON_PROVIDER_SITE">;
-}
-/**
- * POST /users/marketplace/mercadopago
- *
- * Connect Mercado Pago
- */
-interface UsersConnectMercadopago {
-    request: {
-        body: {
-            code: string;
-            redirectUri: string;
-        };
-    };
-    response: string;
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
-}
 /**
  * POST /users/blocks
  *
@@ -6267,56 +6184,6 @@ interface UsersCreateSavedSearch {
     };
     error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"LOW_PLAN"> | ApiErrorOf<"LIMIT_REACHED">;
 }
-/**
- * POST /users/subscriptions
- *
- * Subscribe to a membership
- */
-interface UsersCreateSubscription {
-    request: {
-        body: {
-            planName: "BASIC" | "VELVET" | "LATEX" | "LEATHER";
-            provider: "mercadopago" | "gumroad";
-            email?: string;
-        };
-    };
-    response: {
-        success: true;
-        result: string;
-        data: {
-            updated: boolean;
-        };
-        upserted: {
-            subscriptions: Record<string, {
-                id: string;
-                userId: string;
-                provider: "mercadopago" | "paypal" | "gumroad" | "complimentary";
-                providerSubscriptionId?: string;
-                providerSubscriptionInitPoint?: string;
-                status: "active" | "cancelled" | "paused" | "pending";
-                planName: "BASIC" | "VELVET" | "LATEX" | "LEATHER";
-                amount: number;
-                currency: "ARS" | "USD";
-                startedAt?: string;
-                cancelledAt?: string;
-                validUntil?: string;
-                nextPaymentDate?: string;
-                lastPaymentAt?: string;
-                renewalFailed: boolean;
-                manageUrl?: string;
-                payments: Array<{
-                    id: string;
-                    status?: "approved" | "failed" | "refunded";
-                    currency?: "ARS" | "USD";
-                    amount: number;
-                    paidAt?: string;
-                    providerPaymentId?: string;
-                }>;
-            }>;
-        };
-    };
-    error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"MERCADOPAGO_FOREIGN_PAYER"> | ApiErrorOf<"EMAIL_REQUIRED">;
-}
 /**
  * DELETE /users/followlists/:listId
  *
@@ -8313,7 +8180,6 @@ type Endpoints = {
     };
     bank: {
         acknowledgeCoupon: BankAcknowledgeCoupon;
-        createOrder: BankCreateOrder;
         createTransaction: BankCreateTransaction;
         deleteCoupon: BankDeleteCoupon;
         getCoupon: BankGetCoupon;
@@ -8510,14 +8376,11 @@ type Endpoints = {
         addToFollowList: UsersAddToFollowList;
         assignOrgPoints: UsersAssignOrgPoints;
         cancelMySubscription: UsersCancelMySubscription;
-        cancelSubscription: UsersCancelSubscription;
-        connectMercadopago: UsersConnectMercadopago;
         createBlock: UsersCreateBlock;
         createFollowList: UsersCreateFollowList;
         createOrganizationSession: UsersCreateOrganizationSession;
         createReport: UsersCreateReport;
         createSavedSearch: UsersCreateSavedSearch;
-        createSubscription: UsersCreateSubscription;
         deleteFollowList: UsersDeleteFollowList;
         deleteSavedSearch: UsersDeleteSavedSearch;
         dismissSuggestion: UsersDismissSuggestion;

package/dist/index.js

@@ -80,7 +80,6 @@ var routes = {
   },
   bank: {
     acknowledgeCoupon: { method: "PUT", path: "/bank/coupons/:couponCode" },
-    createOrder: { method: "POST", path: "/bank/orders" },
     createTransaction: { method: "POST", path: "/bank/transactions" },
     deleteCoupon: { method: "DELETE", path: "/bank/coupons/:couponId" },
     getCoupon: { method: "GET", path: "/bank/coupons/:couponCode" },
@@ -277,14 +276,11 @@ var routes = {
     addToFollowList: { method: "POST", path: "/users/followlists/:listId" },
     assignOrgPoints: { method: "POST", path: "/users/orgpoints/assign" },
     cancelMySubscription: { method: "DELETE", path: "/users/subscriptions" },
-    cancelSubscription: { method: "DELETE", path: "/users/subscriptions/:subscriptionId" },
-    connectMercadopago: { method: "POST", path: "/users/marketplace/mercadopago" },
     createBlock: { method: "POST", path: "/users/blocks" },
     createFollowList: { method: "POST", path: "/users/followlists" },
     createOrganizationSession: { method: "POST", path: "/users/organizations/session" },
     createReport: { method: "POST", path: "/users/reports" },
     createSavedSearch: { method: "POST", path: "/users/saved-searches" },
-    createSubscription: { method: "POST", path: "/users/subscriptions" },
     deleteFollowList: { method: "DELETE", path: "/users/followlists/:listId" },
     deleteSavedSearch: { method: "DELETE", path: "/users/saved-searches/:id" },
     dismissSuggestion: { method: "DELETE", path: "/users/suggestions/:userId" },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mazmo/sdk",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "description": "Typed client for the Mazmo API",
   "license": "MIT",
   "homepage": "https://docs.mazmo.net",
@@ -33,7 +33,7 @@
     "node": ">=18"
   },
   "mazmo": {
-    "commit": "42bef6e8a7d3bfbcb6fc0c75049fa3f31338fb31",
-    "apiVersion": "7.7.96"
+    "commit": "53ee69223787f0d1b01b5438692665206360a93c",
+    "apiVersion": "7.7.97"
   }
 }