@scalepad/sdk-core 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,93 @@
+# @scalepad/sdk-core
+
+Typed client for the ScalePad Core API routes used by the ScalePad CLI.
+
+## Install
+
+```bash
+npm install @scalepad/sdk-core
+```
+
+## Usage
+
+```ts
+import { createCoreClient } from "@scalepad/sdk-core";
+
+const client = createCoreClient({
+  apiKey: process.env.SCALEPAD_API_KEY!
+});
+
+const clients = await client.listClients({ pageSize: 10 });
+console.log(clients.data);
+```
+
+## API
+
+The package exports a generated client plus a small convenience wrapper.
+
+Wrapper helpers:
+
+- `createCoreClient(config)`
+- `ScalepadCoreClient`
+- `listClients(query)`
+- `getClient(id)`
+- `listIntegrationConfigurations()`
+- `listHardwareAssets(query)`
+- `listTickets(query)`
+
+Generated and schema exports:
+
+- `GeneratedCoreClient`
+- `coreOperations`
+- `ScalepadApiError`
+- `paths`
+
+## Client configuration
+
+```ts
+type CoreClientConfig = {
+  apiKey: string;
+  baseUrl?: string;
+  fetchImpl?: typeof fetch;
+  userAgent?: string;
+  maxRetries?: number;
+};
+```
+
+- `apiKey` is required and is sent as `x-api-key`
+- `baseUrl` defaults to `https://api.scalepad.com`
+- `fetchImpl` lets you inject a custom fetch implementation
+- `userAgent` defaults to `@scalepad/cli`
+- `maxRetries` controls retry attempts for `429` responses and defaults to `3`
+
+## List queries
+
+List endpoints accept this shared shape:
+
+```ts
+type ListQuery = {
+  cursor?: string;
+  pageSize?: number;
+  filters?: Record<string, string>;
+  sort?: string;
+};
+```
+
+Filters are translated to `filter[field]=expression` query parameters, and `pageSize` is translated to `page_size`.
+
+## Error handling
+
+Failed responses throw `ScalepadApiError`, which includes:
+
+- `status`: the HTTP status code
+- `payload`: the parsed response body when one is available
+
+## Development
+
+This package is generated from the checked-in OpenAPI spec in the monorepo root. To refresh or rebuild it:
+
+```bash
+pnpm fetch:specs
+pnpm generate:sdk
+pnpm --filter @scalepad/sdk-core build
+```

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "@scalepad/sdk-core",
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "description": "Typed ScalePad Core API client used by the ScalePad CLI.",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",

package/src/catalog.ts

@@ -1,277 +0,0 @@
-/* eslint-disable */
-export interface GeneratedOperation {
-  methodName: string;
-  method: "get" | "post" | "put" | "delete";
-  path: string;
-  action: "list" | "get" | "create" | "update" | "delete";
-  commandPath: readonly string[];
-  pathParams: readonly string[];
-  queryParams: readonly string[];
-  hasBody: boolean;
-  output: "list" | "object";
-  summary: string;
-  description: string;
-}
-
-export const coreOperations: readonly GeneratedOperation[] = [
-  {
-    methodName: "listAssetsHardware",
-    method: "get",
-    path: "/core/v1/assets/hardware",
-    action: "list",
-    commandPath: ["assets","hardware"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[name]","filter[client.id]","filter[client.name]","filter[contact.id]","filter[manufacturer.id]","filter[manufacturer.name]","filter[model.number]","filter[serial_number]","filter[type]","filter[location_name]","filter[configuration.cpu.name]","filter[configuration.cpu.manufacturer_name]","filter[configuration.cpu.manufacturer_id]","filter[configuration.ram_bytes]","filter[software.operating_system]","filter[software.antivirus_info.status]","filter[software.antivirus_info.definition_status]","filter[software.office_suite_info.name]","filter[software.office_suite_info.version]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List Hardware Assets",
-    description: "This endpoint retrieves a detailed list of hardware assets. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA hardware asset is an active physical device for a client managed by the MSP, enriched with information such as the associated client, assigned contact and other device-specific details."
-  },
-  {
-    methodName: "getAssetsHardwareById",
-    method: "get",
-    path: "/core/v1/assets/hardware/{id}",
-    action: "get",
-    commandPath: ["assets","hardware"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get Hardware Asset",
-    description: "This endpoint retrieves a single hardware asset, identified by its unique ID.\r\n            \r\nA hardware asset is an active physical device for a client managed by the MSP, enriched with information such as the associated client, assigned contact and other device-specific details."
-  },
-  {
-    methodName: "listAssetsSaas",
-    method: "get",
-    path: "/core/v1/assets/saas",
-    action: "list",
-    commandPath: ["assets","saas"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[client.id]","filter[client.name]","filter[product.manufacturer.id]","filter[product.manufacturer.name]","filter[product.id]","filter[product.name]","filter[product.category]","filter[product.manufacturer_sku.id]","filter[product.manufacturer_sku.name]","filter[status]","filter[term.starts_at]","filter[term.ends_at]","filter[term.is_auto_renewed]","filter[pool.type]","filter[pool.capacity]","filter[pool.utilized]","filter[pool.active]","filter[pool.suspended]","filter[pool.grace_period_warning]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List SaaS Assets",
-    description: "This endpoint retrieves a detailed list of SaaS assets. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA SaaS asset is a cloud-based software application used by a client organization, tracked and managed by the MSP as part of its service delivery."
-  },
-  {
-    methodName: "listAssetsSaasUsers",
-    method: "get",
-    path: "/core/v1/assets/saas-users",
-    action: "list",
-    commandPath: ["assets","saas-users"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[client.id]","filter[client.name]","filter[contact.id]","filter[asset.id]","filter[asset.status]","filter[product.manufacturer.id]","filter[product.manufacturer.name]","filter[product.id]","filter[product.name]","filter[product.category]","filter[product.manufacturer_sku.id]","filter[product.manufacturer_sku.name]","filter[term.starts_at]","filter[term.ends_at]","filter[activity.last_active_at]","filter[activity.is_active]","filter[authentication.is_mfa_enabled]","filter[authentication.default_mfa_method]","filter[is_admin]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List SaaS Users",
-    description: "This endpoint retrieves a detailed list of SaaS users. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA SaaS user is an individual at the client organization who has been assigned access to a SaaS license managed by the MSP."
-  },
-  {
-    methodName: "getAssetsSaasUsersById",
-    method: "get",
-    path: "/core/v1/assets/saas-users/{id}",
-    action: "get",
-    commandPath: ["assets","saas-users"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get SaaS User",
-    description: "This endpoint retrieves a single SaaS user, identified by its unique ID.\r\n            \r\nA SaaS user is an individual at the client organization who has been assigned access to a SaaS license managed by the MSP."
-  },
-  {
-    methodName: "getAssetsSaasById",
-    method: "get",
-    path: "/core/v1/assets/saas/{id}",
-    action: "get",
-    commandPath: ["assets","saas"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get SaaS Asset",
-    description: "This endpoint retrieves a single SaaS asset, identified by its unique ID.\r\n            \r\nA SaaS asset is a cloud-based software application used by a client organization, tracked and managed by the MSP as part of its service delivery."
-  },
-  {
-    methodName: "listClients",
-    method: "get",
-    path: "/core/v1/clients",
-    action: "list",
-    commandPath: ["clients"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[name]","filter[lifecycle]","filter[num_contacts]","filter[num_hardware_assets]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List Clients",
-    description: "This endpoint retrieves a detailed list of clients. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA client is an active customer organization managed by the MSP, enriched with data such as employee and device counts, geographic details, and other customer-specific details."
-  },
-  {
-    methodName: "getClientsById",
-    method: "get",
-    path: "/core/v1/clients/{id}",
-    action: "get",
-    commandPath: ["clients"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get Client",
-    description: "This endpoint retrieves a single client, identified by its unique ID.\r\n            \r\nA client is an active customer organization managed by the MSP, enriched with data such as employee and device counts, geographic details, and other customer-specific details."
-  },
-  {
-    methodName: "createContacts",
-    method: "post",
-    path: "/core/v1/contacts",
-    action: "create",
-    commandPath: ["contacts"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[client.id]","filter[client.name]","filter[title]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: true,
-    output: "object",
-    summary: "Create Contacts",
-    description: "This endpoint retrieves a detailed list of contacts. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA contact is an active individual associated with a client of an MSP, enriched with information such as their role, name and other contact-specific details."
-  },
-  {
-    methodName: "getContactsById",
-    method: "get",
-    path: "/core/v1/contacts/{id}",
-    action: "get",
-    commandPath: ["contacts"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get Contact",
-    description: "This endpoint retrieves a single contact, identified by its unique ID.\r\n            \r\nA contact is an active individual associated with a client of an MSP, enriched with information such as their role, name and other contact-specific details."
-  },
-  {
-    methodName: "listIntegrationsConfigurations",
-    method: "get",
-    path: "/core/v1/integrations/configurations",
-    action: "list",
-    commandPath: ["integrations","configurations"],
-    pathParams: [],
-    queryParams: [],
-    hasBody: false,
-    output: "list",
-    summary: "List Integration Configurations",
-    description: "This endpoint returns the list of integration configurations associated with the MSP. It indicates which configurations are the primary integrations associated with specific entities.\r\n            \r\nAn integration configuration is a specific instance of an integration."
-  },
-  {
-    methodName: "listIntegrationsVendors",
-    method: "get",
-    path: "/core/v1/integrations/vendors",
-    action: "list",
-    commandPath: ["integrations","vendors"],
-    pathParams: [],
-    queryParams: ["filter[name]","filter[vendor_id]","filter[category]","filter[data_types_supported]","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List Integration Vendors",
-    description: "This endpoint retrieves a complete list of integration vendors which can be used to identify third-party services and platforms that can be integrated with."
-  },
-  {
-    methodName: "createMembers",
-    method: "post",
-    path: "/core/v1/members",
-    action: "create",
-    commandPath: ["members"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[hired_at]","filter[title]","filter[is_scalepad_user]","filter[reports_to_member.id]","filter[hourly_cost.amount]","filter[daily_capacity]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: true,
-    output: "object",
-    summary: "Create Members",
-    description: "This endpoint retrieves a detailed list of members. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA member is an active user (employee, contractor, downstream IT, etc.) within the MSP, enriched with details including their roles, access to ScalePad products, and other associated employee attributes."
-  },
-  {
-    methodName: "getMembersById",
-    method: "get",
-    path: "/core/v1/members/{id}",
-    action: "get",
-    commandPath: ["members"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get Member",
-    description: "This endpoint retrieves a single member, identified by its unique ID.\r\n            \r\nA member is an active user (employee, contractor, downstream IT, etc.) within the MSP, enriched with details including their roles, access to ScalePad products, and other associated employee attributes."
-  },
-  {
-    methodName: "listOpportunities",
-    method: "get",
-    path: "/core/v1/opportunities",
-    action: "list",
-    commandPath: ["opportunities"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[title]","filter[source_status]","filter[source_stage]","filter[is_active]","filter[probability]","filter[client.id]","filter[client.name]","filter[contact.id]","filter[responsible_member.id]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List Opportunities",
-    description: "This endpoint retrieves a detailed list of opportunities. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nAn opportunity is a sales opportunity for an active client managed by the MSP, enriched with information such as status, stage, associated contact, and other sales-related information."
-  },
-  {
-    methodName: "getOpportunitiesById",
-    method: "get",
-    path: "/core/v1/opportunities/{id}",
-    action: "get",
-    commandPath: ["opportunities"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get Opportunity",
-    description: "This endpoint retrieves a single opportunity, identified by its unique ID.\r\n            \r\nAn opportunity is a sales opportunity for an active client managed by the MSP, enriched with information such as status, stage, associated contact, and other sales-related information."
-  },
-  {
-    methodName: "listServiceContracts",
-    method: "get",
-    path: "/core/v1/service/contracts",
-    action: "list",
-    commandPath: ["service","contracts"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[name]","filter[client.id]","filter[client.name]","filter[contact.id]","filter[is_recurring]","filter[type]","filter[term.starts_at]","filter[term.ends_at]","filter[term.is_auto_renew]","filter[term.billing_period]","filter[source_type]","filter[is_addendum]","filter[parent_contract.id]","filter[parent_contract.name]","filter[status]","filter[is_billable]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List Contracts",
-    description: "This endpoint retrieves a detailed list of contracts. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA contract is a formal agreement between the MSP and its active client, enriched with information such as the associated client, contact, and other agreement-specific details."
-  },
-  {
-    methodName: "getServiceContractsById",
-    method: "get",
-    path: "/core/v1/service/contracts/{id}",
-    action: "get",
-    commandPath: ["service","contracts"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get Contract",
-    description: "This endpoint retrieves a single contract, identified by its unique ID.\r\n            \r\nA contract is a formal agreement between the MSP and its active client, enriched with information such as the associated client, contact, and other agreement-specific details."
-  },
-  {
-    methodName: "listServiceTickets",
-    method: "get",
-    path: "/core/v1/service/tickets",
-    action: "list",
-    commandPath: ["service","tickets"],
-    pathParams: [],
-    queryParams: ["filter[id]","filter[owner_member.id]","filter[responsible_member.id]","filter[client.id]","filter[client.name]","filter[contact.id]","filter[contract.id]","filter[contract.name]","filter[board.id]","filter[board.name]","filter[category]","filter[timeline.created_at]","filter[timeline.updated_at]","filter[timeline.responded_at]","filter[timeline.planned_at]","filter[timeline.resolved_at]","filter[timeline.closed_at]","filter[sla.is_response_in_sla]","filter[sla.is_plan_in_sla]","filter[sla.is_resolution_in_sla]","filter[status.current]","filter[priority.current]","filter[impact]","filter[severity]","filter[record_created_at]","filter[record_updated_at]","sort","page_size","cursor"],
-    hasBody: false,
-    output: "list",
-    summary: "List Tickets",
-    description: "This endpoint retrieves a detailed list of tickets. The endpoint supports filtering and sorting based on various criteria.\r\n            \r\nA ticket is a service request or an issue raised by a client or an MSP, enriched with details about the requester, the client, issue summary, and other issue-related details."
-  },
-  {
-    methodName: "getServiceTicketsById",
-    method: "get",
-    path: "/core/v1/service/tickets/{id}",
-    action: "get",
-    commandPath: ["service","tickets"],
-    pathParams: ["id"],
-    queryParams: [],
-    hasBody: false,
-    output: "object",
-    summary: "Get Ticket",
-    description: "This endpoint retrieves a single ticket, identified by its unique ID.\r\n            \r\nA ticket is a service request or an issue raised by a client or an MSP, enriched with details about the requester, the client, issue summary, and other issue-related details."
-  }
-];