@zennify/sdk-js 1.7.2 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zennify/sdk-js",
-  "version": "1.7.2",
+  "version": "1.10.0",
   "description": "A simple package to work with https://api.zennify.app",
   "main": "dist/main.js",
   "keywords": [],

package/src/errors.ts

@@ -83,6 +83,7 @@ export interface APIErrors {
     'INVALID_REFUND_VALUE_EXCEEDS_ORDER_VALUE': {};
     'ORDER_TRANSACTION_ALREADY_REFUNDED': {};
     'FAILED_REFUND': {};
+    'INVALID_METADATA': { details: string };
     // MP errors
     'MP_ACCOUNT_OFFLINE': {};
     'MP_PIX_KEY_NOT_CONFIGURED': {};

package/src/interfaces/Transactions.ts

@@ -1,29 +1,39 @@
-export type FullTransaction = {
+export type BaseTransaction<TransactionMetadata extends any = any> = {
     id: string,
+    created_at: string,
     entity: 'semiauto' | 'mercadopago',
     method: 'pix',
-    managed: null,
+    managed?: boolean | null,
     status: 'approved' | 'cancelled' | 'expired' | 'pending' | 'refused' | 'rejected' | 'analysis',
     value: number,
     base_value: number,
     refunded_value: number,
-    refund_reason: null,
-    refund_comment: null,
-    refund_requested_by: null,
-    pix_e2eid: null,
-    pix_qrcode: null,
-    payer_bank: null,
-    order: {
+    refund_reason?: string | null,
+    refund_comment?: string | null,
+    refund_requested_by?: string | null,
+    pix_e2eid?: string | null,
+    pix_qrcode?: string | null,
+    payer_bank?: string | null,
+    metadata?: TransactionMetadata | null
+};
+
+type DiscordOrder = {
+    platform: 'discord',
+    discord_guild_id?: string | null,
+    discord_channel_id?: string | null,
+    discord_channel_message_id?: string | null
+}
+
+export type SaleTransaction = BaseTransaction & {
+    type: 'sale',
+    order: DiscordOrder & {
         id: string,
         created_at: string,
-        platform: 'discord',
-        discord_guild_id: null,
         discount: number,
         subtotal: number,
         total_value: number,
-        rating: null,
-        rating_message: null,
-        metadata: null,
+        rating?: number | null,
+        rating_message?: number | null,
         payer: {
             id: number,
             username: string,
@@ -37,19 +47,21 @@ export type FullTransaction = {
         store: {
             id: number,
             name: string,
-            icon_id: null,
-            banner_id: null
+            icon_id?: number | null,
+            banner_id?: number | null
         },
         products: [
             {
                 id: number,
                 name: string,
                 value: number,
-                icon_id: null,
-                banner_id: null,
+                icon_id?: number | null,
+                banner_id?: number | null
                 amount: number,
                 delivered: string[]
             }
         ]
     }
-}
+};
+
+export type FullTransaction<TransactionMetadata extends any = any> = BaseTransaction<TransactionMetadata> & SaleTransaction;

package/translations/en_US.json

@@ -231,6 +231,10 @@
         "name": "Failed to refund this order",
         "message": "Please contact support."
     },
+    "INVALID_METADATA": {
+        "name": "Invalid metadata for update",
+        "message": "Must be a JSON array or JSON object with up to 1000 characters"
+    },
     "THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_PIX": {
         "name": "This seller has not yet configured receipt via PIX",
         "message": "Choose another method or wait for seller configuration."

package/translations/pt_BR.json

@@ -227,6 +227,10 @@
         "name": "Ocorreu uma falha ao reembolsar este pedido",
         "message": "Entre em contato com o suporte."
     },
+    "INVALID_METADATA": {
+        "name": "Metadados inválidos para atualização",
+        "message": "Precisa ser um array JSON ou objeto JSON com até 1000 caracteres"
+    },
     "THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_PIX": {
         "name": "O vendedor não configurou o recebimento via Pix",
         "message": "Escolha outro método ou aguarde a configuração do vendedor."

package/types/errors.d.ts

@@ -76,6 +76,9 @@ export interface APIErrors {
     'INVALID_REFUND_VALUE_EXCEEDS_ORDER_VALUE': {};
     'ORDER_TRANSACTION_ALREADY_REFUNDED': {};
     'FAILED_REFUND': {};
+    'INVALID_METADATA': {
+        details: string;
+    };
     'MP_ACCOUNT_OFFLINE': {};
     'MP_PIX_KEY_NOT_CONFIGURED': {};
     'MP_NOT_ALLOWED_TO_SELL': {};

package/types/interfaces/Transactions.d.ts

@@ -1,29 +1,37 @@
-export type FullTransaction = {
+export type BaseTransaction<TransactionMetadata extends any = any> = {
     id: string;
+    created_at: string;
     entity: 'semiauto' | 'mercadopago';
     method: 'pix';
-    managed: null;
+    managed?: boolean | null;
     status: 'approved' | 'cancelled' | 'expired' | 'pending' | 'refused' | 'rejected' | 'analysis';
     value: number;
     base_value: number;
     refunded_value: number;
-    refund_reason: null;
-    refund_comment: null;
-    refund_requested_by: null;
-    pix_e2eid: null;
-    pix_qrcode: null;
-    payer_bank: null;
-    order: {
+    refund_reason?: string | null;
+    refund_comment?: string | null;
+    refund_requested_by?: string | null;
+    pix_e2eid?: string | null;
+    pix_qrcode?: string | null;
+    payer_bank?: string | null;
+    metadata?: TransactionMetadata | null;
+};
+type DiscordOrder = {
+    platform: 'discord';
+    discord_guild_id?: string | null;
+    discord_channel_id?: string | null;
+    discord_channel_message_id?: string | null;
+};
+export type SaleTransaction = BaseTransaction & {
+    type: 'sale';
+    order: DiscordOrder & {
         id: string;
         created_at: string;
-        platform: 'discord';
-        discord_guild_id: null;
         discount: number;
         subtotal: number;
         total_value: number;
-        rating: null;
-        rating_message: null;
-        metadata: null;
+        rating?: number | null;
+        rating_message?: number | null;
         payer: {
             id: number;
             username: string;
@@ -37,19 +45,21 @@ export type FullTransaction = {
         store: {
             id: number;
             name: string;
-            icon_id: null;
-            banner_id: null;
+            icon_id?: number | null;
+            banner_id?: number | null;
         };
         products: [
             {
                 id: number;
                 name: string;
                 value: number;
-                icon_id: null;
-                banner_id: null;
+                icon_id?: number | null;
+                banner_id?: number | null;
                 amount: number;
                 delivered: string[];
             }
         ];
     };
 };
+export type FullTransaction<TransactionMetadata extends any = any> = BaseTransaction<TransactionMetadata> & SaleTransaction;
+export {};