Methods
(async, inner) getOnboardingRecommendedContent(onboardingId) → {Promise.<OnboardingRecommendationResponse>}
- Description:
- Fetches recommended content for onboarding based on the specified brand.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onboardingId |
number | The ID of the onboarding process. |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves with the recommended content.
- Type
- Promise.<OnboardingRecommendationResponse>
(async, inner) startOnboarding(params) → {Promise.<Onboarding>}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
StartOnboardingParams | The parameters for starting the onboarding process. |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the onboarding process is started.
- Type
- Promise.<Onboarding>
(async, inner) updateOnboarding(params) → {Promise.<Onboarding>}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
UpdateOnboardingParams | The parameters for updating the onboarding process. |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the onboarding process is updated.
- Type
- Promise.<Onboarding>
(async, inner) userOnboardingForBrand(brand) → {Promise.<Onboarding>}
- Description:
- Fetches the onboardings for the current user and specified brand.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
brand |
string | The brand identifier. |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves with the onboarding data.
- Type
- Promise.<Onboarding>