postGuideStepsByIdStartWithHttpInfo method

Future<Response> postGuideStepsByIdStartWithHttpInfo(
  1. String id
)

Marks one step of the caller org's journey in progress and returns the refreshed journey.

Marks one step of the caller org's journey in progress and returns the refreshed journey. Dependency-GATED: a step whose prerequisites are unfinished is refused 409 carrying {error, step, blockedBy}, where blockedBy names the exact steps in the way — enough to render the reason without asking again.

Note: This method returns the HTTP Response.

Parameters:

  • String id (required): ID is the step's id, as it appears in the journey (e.g. "gsuite").

Implementation

Future<Response> postGuideStepsByIdStartWithHttpInfo(String id,) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/guide/steps/{id}/start'
    .replaceAll('{id}', id);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'POST',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}