SDK: onboarding

The onboarding area has 4 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

onboardingAdvance

Advance onboarding one step

• Request: POST on /v1/tenants/{tenantId}/onboarding/advance

onboardingAdvance(args: { tenantId: string; body: AdvanceRequest }, options?: CallOptions): Promise<AdvanceResponse>

onboardingFunnel

Time from sign-up to the first reviewed agent change, for admins

• Request: GET on /v1/tenants/{tenantId}/onboarding/funnel

onboardingFunnel(args: { tenantId: string }, options?: CallOptions): Promise<FunnelReport>

onboardingGet

Onboarding state for the team

• Request: GET on /v1/tenants/{tenantId}/onboarding

onboardingGet(args: { tenantId: string }, options?: CallOptions): Promise<OnboardingProgress>

onboardingReview

The first AI review of onboarding

• Request: GET on /v1/tenants/{tenantId}/onboarding/first-review

onboardingReview(args: { tenantId: string }, options?: CallOptions): Promise<FirstReview>