@ixblix/sdk-js 0.4.2 → 0.5.0

package/README.md

@@ -154,10 +154,13 @@ Register a company (keyless), then activate it after payment to obtain the API
 key:
 
 ```ts
+const plans = await ixblix.listPlans();
+const plan = plans.find((p) => p.isActive && p.isPublic);
+
 const { company, payment } = await ixblix.registerCompany({
   name: "Acme CRM",
   handle: "acme-crm",
-  paymentProvider: "dummy",
+  planId: plan?.id,
 });
 
 // After the payment is confirmed:

package/dist/types.d.ts

@@ -19,17 +19,8 @@ export interface Contact {
     externalId: string;
     name?: string;
     metadata?: Record<string, unknown>;
-    /**
-     * LGPD consent status. Consent is memorized per company: once `GRANTED`, it
-     * is reused by every conversation with the same company and the customer is
-     * not asked again.
-     */
     consentStatus: ConsentStatus;
-    /**
-     * Timestamp of the first time the customer granted consent for this company.
-     * Absent/null when consent was never granted.
-     */
-    consentedAt?: string | null;
+    consentedAt?: string;
 }
 /** Payload used to create a conversation for a contact. */
 export interface ContactInput {
@@ -206,6 +197,8 @@ export interface Message {
     clientMessageId?: string | null;
     /** Identifier of the operator that sent this message (COMPANY-sent only). */
     operatorUuid?: string;
+    /** Identity of the operator that sent this message (COMPANY-sent only). */
+    operator?: Operator;
     /**
      * Identifier of the message this one replies to, when it is a reply.
      * Absent/null when the message is not a reply.
@@ -237,14 +230,19 @@ export interface MessageReaction {
     operatorUuid?: string | null;
     createdAt: string;
 }
-/** Result of adding, replacing or removing a message reaction. */
+/** Result of adding, replacing or removing an emoji reaction. */
 export interface MessageReactionResult {
-    id: string;
+    conversationId: string;
     messageId: string;
+    /** The message's reactions after the change. */
+    reactions: MessageReaction[];
+    /** `added` when a reaction was set or replaced, `removed` when cleared. */
+    action: "added" | "removed";
+    /** The emoji that was set, or null when removed. */
     emoji: string | null;
     senderType: SenderType;
     operatorUuid?: string | null;
-    createdAt: string;
+    reactedAt: string;
 }
 /** Metadata of a media file attached to a message. */
 export interface Media {
@@ -282,8 +280,11 @@ export interface RegisterCompanyInput {
     name: string;
     handle: string;
     planId?: string;
-    paymentProvider?: string;
     confirmationWebhookUrl?: string;
+    /** Contact e-mail forwarded to the gateway as the checkout customer e-mail. */
+    email?: string;
+    /** Tax id (CPF/CNPJ) required by some gateways such as Asaas. */
+    taxId?: string;
 }
 /** Payment instructions returned when registering a company. */
 export interface PaymentInstructions {
@@ -293,6 +294,11 @@ export interface PaymentInstructions {
     currency: string;
     confirmationUrl: string;
     status: string;
+    /**
+     * Hosted checkout URL the customer must be redirected to. Absent for free
+     * plans and for providers that settle the charge inline.
+     */
+    checkoutUrl?: string;
 }
 /** Result of registering a company. */
 export interface RegisterCompanyResult {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixblix/sdk-js",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "Official ixblix SDK for desk/CRM integrations. Create overflow conversations, exchange end-to-end encrypted messages and media, and manage company onboarding.",
   "license": "MIT",
   "type": "module",