scheduleRaw method

  1. @experimental
DynamiteRawResponse<TextToImageApiScheduleResponseApplicationJson, void> scheduleRaw({
  1. required String input,
  2. required String appId,
  3. String? identifier,
  4. int? numberOfImages,
  5. bool? oCSAPIRequest,
})

This endpoint allows scheduling a text to image task.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • input Input text.
  • appId ID of the app that will execute the task.
  • identifier An arbitrary identifier for the task. Defaults to ''.
  • numberOfImages The number of images to generate. Defaults to 8.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Task scheduled successfully
  • 412: Scheduling task is not possible
  • 500

See:

  • schedule for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<TextToImageApiScheduleResponseApplicationJson, void> scheduleRaw({
  required String input,
  required String appId,
  String? identifier,
  int? numberOfImages,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  final $input = _$jsonSerializers.serialize(input, specifiedType: const FullType(String));
  _parameters['input'] = $input;

  final $appId = _$jsonSerializers.serialize(appId, specifiedType: const FullType(String));
  _parameters['appId'] = $appId;

  var $identifier = _$jsonSerializers.serialize(identifier, specifiedType: const FullType(String));
  $identifier ??= '';
  _parameters['identifier'] = $identifier;

  var $numberOfImages = _$jsonSerializers.serialize(numberOfImages, specifiedType: const FullType(int));
  $numberOfImages ??= 8;
  _parameters['numberOfImages'] = $numberOfImages;

  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const _i2.HeaderEncoder().convert($oCSAPIRequest);

  final _path = _i3.UriTemplate('/ocs/v2.php/text2image/schedule{?input*,appId*,identifier*,numberOfImages*}')
      .expand(_parameters);
  return _i1.DynamiteRawResponse<TextToImageApiScheduleResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(TextToImageApiScheduleResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}