@superblocksteam/sdk-api 2.0.93 → 2.0.94-next.0

package/src/integrations/hubspot/README.md

@@ -4,8 +4,8 @@ Manage contacts, deals, companies, and interact with HubSpot's CRM platform.
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
+| Method                        | Description                                         |
+| ----------------------------- | --------------------------------------------------- |
 | `apiRequest(options, schema)` | Make any HubSpot API request with schema validation |
 
 ## Usage
@@ -13,25 +13,30 @@ Manage contacts, deals, companies, and interact with HubSpot's CRM platform.
 ### Create a Contact
 
 ```typescript
-import { api, z } from "@superblocksteam/sdk-api";
+import { api, z, hubspot } from "@superblocksteam/sdk-api";
 
 // Integration ID from the integrations panel
 const PROD_HUBSPOT = "a1b2c3d4-5678-90ab-cdef-hubspot00001";
 
 const ContactSchema = z.object({
   id: z.string(),
-  properties: z.object({
-    email: z.string().optional(),
-    firstname: z.string().optional(),
-    lastname: z.string().optional(),
-    phone: z.string().optional(),
-    company: z.string().optional(),
-  }).passthrough(),
+  properties: z
+    .object({
+      email: z.string().optional(),
+      firstname: z.string().optional(),
+      lastname: z.string().optional(),
+      phone: z.string().optional(),
+      company: z.string().optional(),
+    })
+    .passthrough(),
   createdAt: z.string(),
   updatedAt: z.string(),
 });
 
 export default api({
+  integrations: {
+    hubspot: hubspot(PROD_HUBSPOT),
+  },
   name: "HubSpotExample",
   input: z.object({
     email: z.string().email(),
@@ -42,9 +47,7 @@ export default api({
     contactId: z.string(),
   }),
   async run(ctx, { email, firstName, lastName }) {
-    const hubspot = ctx.hubspot(PROD_HUBSPOT);
-
-    const result = await hubspot.apiRequest(
+    const result = await ctx.integrations.hubspot.apiRequest(
       {
         method: "POST",
         path: "/crm/v3/objects/contacts",
@@ -56,7 +59,7 @@ export default api({
           },
         },
       },
-      { response: ContactSchema }
+      { response: ContactSchema },
     );
 
     return { contactId: result.id };
@@ -67,7 +70,7 @@ export default api({
 ### Get a Contact
 
 ```typescript
-const contact = await hubspot.apiRequest(
+const contact = await ctx.integrations.hubspot.apiRequest(
   {
     method: "GET",
     path: `/crm/v3/objects/contacts/${contactId}`,
@@ -75,7 +78,7 @@ const contact = await hubspot.apiRequest(
       properties: "email,firstname,lastname,phone,company,lifecyclestage",
     },
   },
-  { response: ContactSchema }
+  { response: ContactSchema },
 );
 ```
 
@@ -85,14 +88,18 @@ const contact = await hubspot.apiRequest(
 const SearchResponseSchema = z.object({
   total: z.number(),
   results: z.array(ContactSchema),
-  paging: z.object({
-    next: z.object({
-      after: z.string(),
-    }).optional(),
-  }).optional(),
+  paging: z
+    .object({
+      next: z
+        .object({
+          after: z.string(),
+        })
+        .optional(),
+    })
+    .optional(),
 });
 
-const result = await hubspot.apiRequest(
+const result = await ctx.integrations.hubspot.apiRequest(
   {
     method: "POST",
     path: "/crm/v3/objects/contacts/search",
@@ -113,7 +120,7 @@ const result = await hubspot.apiRequest(
       limit: 25,
     },
   },
-  { response: SearchResponseSchema }
+  { response: SearchResponseSchema },
 );
 ```
 
@@ -122,18 +129,20 @@ const result = await hubspot.apiRequest(
 ```typescript
 const DealSchema = z.object({
   id: z.string(),
-  properties: z.object({
-    dealname: z.string().optional(),
-    amount: z.string().optional(),
-    dealstage: z.string().optional(),
-    closedate: z.string().optional(),
-    pipeline: z.string().optional(),
-  }).passthrough(),
+  properties: z
+    .object({
+      dealname: z.string().optional(),
+      amount: z.string().optional(),
+      dealstage: z.string().optional(),
+      closedate: z.string().optional(),
+      pipeline: z.string().optional(),
+    })
+    .passthrough(),
   createdAt: z.string(),
   updatedAt: z.string(),
 });
 
-const deal = await hubspot.apiRequest(
+const deal = await ctx.integrations.hubspot.apiRequest(
   {
     method: "POST",
     path: "/crm/v3/objects/deals",
@@ -147,7 +156,7 @@ const deal = await hubspot.apiRequest(
       },
     },
   },
-  { response: DealSchema }
+  { response: DealSchema },
 );
 ```
 
@@ -156,12 +165,14 @@ const deal = await hubspot.apiRequest(
 ```typescript
 const ListDealsResponseSchema = z.object({
   results: z.array(DealSchema),
-  paging: z.object({
-    next: z.object({ after: z.string() }).optional(),
-  }).optional(),
+  paging: z
+    .object({
+      next: z.object({ after: z.string() }).optional(),
+    })
+    .optional(),
 });
 
-const deals = await hubspot.apiRequest(
+const deals = await ctx.integrations.hubspot.apiRequest(
   {
     method: "GET",
     path: "/crm/v3/objects/deals",
@@ -170,7 +181,7 @@ const deals = await hubspot.apiRequest(
       properties: "dealname,amount,dealstage,closedate",
     },
   },
-  { response: ListDealsResponseSchema }
+  { response: ListDealsResponseSchema },
 );
 ```
 
@@ -179,17 +190,19 @@ const deals = await hubspot.apiRequest(
 ```typescript
 const CompanySchema = z.object({
   id: z.string(),
-  properties: z.object({
-    name: z.string().optional(),
-    domain: z.string().optional(),
-    industry: z.string().optional(),
-    phone: z.string().optional(),
-  }).passthrough(),
+  properties: z
+    .object({
+      name: z.string().optional(),
+      domain: z.string().optional(),
+      industry: z.string().optional(),
+      phone: z.string().optional(),
+    })
+    .passthrough(),
   createdAt: z.string(),
   updatedAt: z.string(),
 });
 
-const company = await hubspot.apiRequest(
+const company = await ctx.integrations.hubspot.apiRequest(
   {
     method: "POST",
     path: "/crm/v3/objects/companies",
@@ -202,7 +215,7 @@ const company = await hubspot.apiRequest(
       },
     },
   },
-  { response: CompanySchema }
+  { response: CompanySchema },
 );
 ```
 
@@ -210,28 +223,28 @@ const company = await hubspot.apiRequest(
 
 ```typescript
 // Associate a contact with a company
-await hubspot.apiRequest(
+await ctx.integrations.hubspot.apiRequest(
   {
     method: "PUT",
     path: `/crm/v3/objects/contacts/${contactId}/associations/companies/${companyId}/contact_to_company`,
   },
-  { response: z.object({}).optional() }
+  { response: z.object({}).optional() },
 );
 
 // Associate a deal with a contact
-await hubspot.apiRequest(
+await ctx.integrations.hubspot.apiRequest(
   {
     method: "PUT",
     path: `/crm/v3/objects/deals/${dealId}/associations/contacts/${contactId}/deal_to_contact`,
   },
-  { response: z.object({}).optional() }
+  { response: z.object({}).optional() },
 );
 ```
 
 ### Update Contact Properties
 
 ```typescript
-const updatedContact = await hubspot.apiRequest(
+const updatedContact = await ctx.integrations.hubspot.apiRequest(
   {
     method: "PATCH",
     path: `/crm/v3/objects/contacts/${contactId}`,
@@ -243,7 +256,7 @@ const updatedContact = await hubspot.apiRequest(
       },
     },
   },
-  { response: ContactSchema }
+  { response: ContactSchema },
 );
 ```
 
@@ -255,16 +268,16 @@ const EngagementsResponseSchema = z.object({
     z.object({
       id: z.string(),
       properties: z.record(z.unknown()),
-    })
+    }),
   ),
 });
 
-const engagements = await hubspot.apiRequest(
+const engagements = await ctx.integrations.hubspot.apiRequest(
   {
     method: "GET",
     path: `/crm/v3/objects/contacts/${contactId}/associations/notes`,
   },
-  { response: EngagementsResponseSchema }
+  { response: EngagementsResponseSchema },
 );
 ```
 
@@ -278,7 +291,7 @@ await hubspot.createContact({ ... });
 await hubspot.getDeals();
 
 // CORRECT - Use apiRequest
-await hubspot.apiRequest(
+await ctx.integrations.hubspot.apiRequest(
   { method: "POST", path: "/crm/v3/objects/contacts", body: { ... } },
   { response: ContactSchema }
 );
@@ -323,15 +336,15 @@ const body = { properties: { amount: "50000" } };
 ```typescript
 // Available operators
 const operators = [
-  "EQ",           // Equals
-  "NEQ",          // Not equals
-  "LT",           // Less than
-  "LTE",          // Less than or equal
-  "GT",           // Greater than
-  "GTE",          // Greater than or equal
-  "CONTAINS_TOKEN",  // Contains (for text)
+  "EQ", // Equals
+  "NEQ", // Not equals
+  "LT", // Less than
+  "LTE", // Less than or equal
+  "GT", // Greater than
+  "GTE", // Greater than or equal
+  "CONTAINS_TOKEN", // Contains (for text)
   "NOT_CONTAINS_TOKEN",
-  "HAS_PROPERTY",    // Property exists
+  "HAS_PROPERTY", // Property exists
   "NOT_HAS_PROPERTY",
 ];
 
@@ -373,7 +386,7 @@ async function getAllContacts(hubspot: HubSpotClient) {
   let after: string | undefined;
 
   while (true) {
-    const result = await hubspot.apiRequest(
+    const result = await ctx.integrations.hubspot.apiRequest(
       {
         method: "GET",
         path: "/crm/v3/objects/contacts",
@@ -382,7 +395,7 @@ async function getAllContacts(hubspot: HubSpotClient) {
           ...(after && { after }),
         },
       },
-      { response: ListContactsResponseSchema }
+      { response: ListContactsResponseSchema },
     );
 
     allContacts.push(...result.results);
@@ -401,7 +414,7 @@ Dates use ISO 8601 or Unix timestamp (milliseconds):
 ```typescript
 const body = {
   properties: {
-    closedate: "2024-12-31",  // ISO date
+    closedate: "2024-12-31", // ISO date
     // Or Unix timestamp in milliseconds
     closedate: "1735689600000",
   },
@@ -414,7 +427,7 @@ const body = {
 import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
-  const result = await hubspot.apiRequest(
+  const result = await ctx.integrations.hubspot.apiRequest(
     { method: "POST", path: "/crm/v3/objects/contacts", body: { ... } },
     { response: ContactSchema }
   );

package/src/integrations/hubspot/client.ts

@@ -5,8 +5,8 @@
  * HubSpot integrations use the REST API Integration plugin under the hood.
  */
 
-import { RestApiIntegrationClient } from '../base/index.js';
-import type { HubSpotClient } from './types.js';
+import { RestApiIntegrationClient } from "../base/index.js";
+import type { HubSpotClient } from "./types.js";
 
 /**
  * Internal implementation of HubSpotClient.
@@ -16,6 +16,8 @@ import type { HubSpotClient } from './types.js';
  * HubSpot API calls. At runtime, the orchestrator handles authentication
  * and API request execution.
  */
-export class HubSpotClientImpl extends RestApiIntegrationClient implements HubSpotClient {
+export class HubSpotClientImpl
+  extends RestApiIntegrationClient
+  implements HubSpotClient {
   // Inherits: name, pluginId, config, executeQuery, apiRequest()
 }

package/src/integrations/hubspot/index.ts

@@ -1,2 +1,2 @@
-export { HubSpotClientImpl } from './client.js';
-export type { HubSpotClient } from './types.js';
+export { HubSpotClientImpl } from "./client.js";
+export type { HubSpotClient } from "./types.js";

package/src/integrations/hubspot/types.ts

@@ -2,8 +2,8 @@
  * HubSpot client types.
  */
 
-import type { BaseIntegrationClient } from '../../types.js';
-import type { SupportsApiRequest } from '../base/index.js';
+import type { BaseIntegrationClient } from "../../types.js";
+import type { SupportsApiRequest } from "../base/index.js";
 
 /**
  * HubSpot client for API interactions.
@@ -13,7 +13,8 @@ import type { SupportsApiRequest } from '../base/index.js';
  *
  * @example
  * ```typescript
- * const hubspot = ctx.hubspot('My HubSpot');
+ * // Declare in api(): integrations: { hubspot: hubspot(INTEGRATION_ID) }
+ * // In run(), access via ctx.integrations.hubspot
  *
  * // Make API requests
  * const ResponseSchema = z.object({
@@ -29,6 +30,7 @@ import type { SupportsApiRequest } from '../base/index.js';
  * );
  * ```
  */
-export interface HubSpotClient extends BaseIntegrationClient, SupportsApiRequest {
+export interface HubSpotClient
+  extends BaseIntegrationClient, SupportsApiRequest {
   // apiRequest() method inherited from SupportsApiRequest
 }