simstudioai--sim/apps/sim/tools/sap_s4hana/update_business_partner.ts

import type { SapProxyResponse, UpdateBusinessPartnerParams } from '@/tools/sap_s4hana/types'
import {
  baseProxyBody,
  parseJsonInput,
  quoteOdataKey,
  SAP_PROXY_URL,
  transformSapProxyResponse,
} from '@/tools/sap_s4hana/utils'
import type { ToolConfig } from '@/tools/types'

export const updateBusinessPartnerTool: ToolConfig<UpdateBusinessPartnerParams, SapProxyResponse> =
  {
    id: 'sap_s4hana_update_business_partner',
    name: 'SAP S/4HANA Update Business Partner',
    description:
      'Update fields on an A_BusinessPartner entity in SAP S/4HANA Cloud (API_BUSINESS_PARTNER). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. If-Match defaults to a wildcard (unconditional) — for safe concurrent updates pass the ETag from a prior GET to avoid lost updates. Deep updates on nested associations (e.g. to_BusinessPartnerAddress) are not supported by SAP (KBA 2833338) — use the dedicated child endpoints.',
    version: '1.0.0',
    params: {
      subdomain: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description:
          'SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)',
      },
      region: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'BTP region (e.g. eu10, us10)',
      },
      clientId: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'OAuth client ID from the S/4HANA Communication Arrangement',
      },
      clientSecret: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'OAuth client secret from the S/4HANA Communication Arrangement',
      },
      deploymentType: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'Deployment type: cloud_public (default), cloud_private, or on_premise',
      },
      authType: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'Authentication type: oauth_client_credentials (default) or basic',
      },
      baseUrl: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'Base URL of the S/4HANA host (Cloud Private / On-Premise)',
      },
      tokenUrl: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'OAuth token URL (Cloud Private / On-Premise + OAuth)',
      },
      username: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'Username for HTTP Basic auth',
      },
      password: {
        type: 'string',
        required: false,
        visibility: 'user-only',
        description: 'Password for HTTP Basic auth',
      },
      businessPartner: {
        type: 'string',
        required: true,
        visibility: 'user-or-llm',
        description: 'BusinessPartner key to update (string, up to 10 characters)',
      },
      body: {
        type: 'json',
        required: true,
        visibility: 'user-or-llm',
        description:
          'JSON object with A_BusinessPartner fields to update (e.g., {"FirstName":"Jane","SearchTerm1":"VIP"})',
      },
      ifMatch: {
        type: 'string',
        required: false,
        visibility: 'user-or-llm',
        description: 'If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).',
      },
    },
    request: {
      url: SAP_PROXY_URL,
      method: 'POST',
      headers: () => ({ 'Content-Type': 'application/json' }),
      body: (params) => {
        const payload = parseJsonInput<Record<string, unknown>>(params.body, 'body')
        if (!payload || typeof payload !== 'object' || Array.isArray(payload)) {
          throw new Error('body must be a JSON object with the fields to update')
        }
        return {
          ...baseProxyBody(params),
          service: 'API_BUSINESS_PARTNER',
          path: `/A_BusinessPartner(${quoteOdataKey(params.businessPartner)})`,
          method: 'MERGE',
          query: { $format: 'json' },
          body: payload,
          ifMatch: params.ifMatch || '*',
        }
      },
    },
    transformResponse: transformSapProxyResponse,
    outputs: {
      status: { type: 'number', description: 'HTTP status code returned by SAP (204 on success)' },
      data: {
        type: 'json',
        description: 'Null on 204 success, or updated A_BusinessPartner entity if SAP returns one',
        properties: {
          BusinessPartner: {
            type: 'string',
            description: 'Business partner key',
            optional: true,
          },
          BusinessPartnerFullName: {
            type: 'string',
            description: 'Full name (concatenated first/last or organization name)',
            optional: true,
          },
          BusinessPartnerCategory: {
            type: 'string',
            description: '"1" Person, "2" Organization, "3" Group',
            optional: true,
          },
          BusinessPartnerGrouping: {
            type: 'string',
            description: 'Grouping / number range',
            optional: true,
          },
          FirstName: { type: 'string', description: 'First name (Person)', optional: true },
          LastName: { type: 'string', description: 'Last name (Person)', optional: true },
          OrganizationBPName1: {
            type: 'string',
            description: 'Organization name line 1',
            optional: true,
          },
          LastChangeDate: {
            type: 'string',
            description: 'Date of last change (OData /Date(...)/ literal)',
            optional: true,
          },
          LastChangedByUser: {
            type: 'string',
            description: 'User who last changed the business partner',
            optional: true,
          },
        },
      },
    },
  }