@salesforce/b2c-tooling-sdk / clients / buildScapiClient

Function: buildScapiClient()

buildScapiClient<P>(options, config, auth): Client<P>

Defined in: packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:101

Builds a typed openapi-fetch client for a SCAPI Admin API.

Type Parameters

P

P extends Record<string, any>

Parameters

options

BuildScapiClientOptions

Domain-specific URL/key/scopes/log-prefix

config

ScapiClientConfig

Caller-supplied shortCode, tenantId, optional overrides

auth

AuthStrategy

Auth strategy (scopes are merged via withScopes)

Returns

Client<P>

Example

export function createScapiJobsClient(config: ScapiClientConfig, auth: AuthStrategy): ScapiJobsClient {
  return buildScapiClient<paths>(
    {
      pathSegment: 'operation/jobs/v1',
      domainKey: 'scapi-jobs',
      defaultScopes: SCAPI_JOBS_RW_SCOPES,
      logPrefix: 'SCAPI-JOBS',
    },
    config,
    auth,
  );
}