sdk/lib/model/storefront_result.dart

//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.18

// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars

part of hanzoai.cloud;

class StorefrontResult {
  /// Returns a new [StorefrontResult] instance.
  StorefrontResult({
    this.imageUrl,
    this.slug,
    this.status,
    this.store,
  });
  /// ImageURL is the absolute URL the listing's headerImage now points at. The image is REFERENCED, not copied — it stays in the org's studio output bucket, so removing it there empties the storefront tile.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? imageUrl;

  /// Slug is the product handle the image was attached to. It IS the asset's `design` field — that equality is the whole join between the studio and the catalog, which is why an asset with no design produces no storefront result at all.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? slug;

  /// Status is one of \"published\" (the product image was set), \"not_configured\" (no commerce edge, no store provisioned for the org, or a token that is not admin on the store — a fail-closed no-op) or \"failed\" (commerce answered and errored). None of the three fails the transition that produced it.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? status;

  /// Store is the commerce store id the image landed in, resolved for the org mid-call. Present only on \"published\": a result that never got that far carries none.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? store;

  @override
  bool operator ==(Object other) => identical(this, other) || other is StorefrontResult &&
    other.imageUrl == imageUrl &&
    other.slug == slug &&
    other.status == status &&
    other.store == store;

  @override
  int get hashCode =>
    // ignore: unnecessary_parenthesis
    (imageUrl == null ? 0 : imageUrl!.hashCode) +
    (slug == null ? 0 : slug!.hashCode) +
    (status == null ? 0 : status!.hashCode) +
    (store == null ? 0 : store!.hashCode);

  @override
  String toString() => 'StorefrontResult[imageUrl=$imageUrl, slug=$slug, status=$status, store=$store]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
    if (this.imageUrl != null) {
      json[r'imageUrl'] = this.imageUrl;
    } else {
      json[r'imageUrl'] = null;
    }
    if (this.slug != null) {
      json[r'slug'] = this.slug;
    } else {
      json[r'slug'] = null;
    }
    if (this.status != null) {
      json[r'status'] = this.status;
    } else {
      json[r'status'] = null;
    }
    if (this.store != null) {
      json[r'store'] = this.store;
    } else {
      json[r'store'] = null;
    }
    return json;
  }

  /// Returns a new [StorefrontResult] instance and imports its values from
  /// [value] if it's a [Map], null otherwise.
  // ignore: prefer_constructors_over_static_methods
  static StorefrontResult? fromJson(dynamic value) {
    if (value is Map) {
      final json = value.cast<String, dynamic>();

      // Ensure that the map contains the required keys.
      // Note 1: the values aren't checked for validity beyond being non-null.
      // Note 2: this code is stripped in release mode!
      assert(() {
        requiredKeys.forEach((key) {
          assert(json.containsKey(key), 'Required key "StorefrontResult[$key]" is missing from JSON.');
          assert(json[key] != null, 'Required key "StorefrontResult[$key]" has a null value in JSON.');
        });
        return true;
      }());

      return StorefrontResult(
        imageUrl: mapValueOfType<String>(json, r'imageUrl'),
        slug: mapValueOfType<String>(json, r'slug'),
        status: mapValueOfType<String>(json, r'status'),
        store: mapValueOfType<String>(json, r'store'),
      );
    }
    return null;
  }

  static List<StorefrontResult> listFromJson(dynamic json, {bool growable = false,}) {
    final result = <StorefrontResult>[];
    if (json is List && json.isNotEmpty) {
      for (final row in json) {
        final value = StorefrontResult.fromJson(row);
        if (value != null) {
          result.add(value);
        }
      }
    }
    return result.toList(growable: growable);
  }

  static Map<String, StorefrontResult> mapFromJson(dynamic json) {
    final map = <String, StorefrontResult>{};
    if (json is Map && json.isNotEmpty) {
      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
      for (final entry in json.entries) {
        final value = StorefrontResult.fromJson(entry.value);
        if (value != null) {
          map[entry.key] = value;
        }
      }
    }
    return map;
  }

  // maps a json object with a list of StorefrontResult-objects as value to a dart map
  static Map<String, List<StorefrontResult>> mapListFromJson(dynamic json, {bool growable = false,}) {
    final map = <String, List<StorefrontResult>>{};
    if (json is Map && json.isNotEmpty) {
      // ignore: parameter_assignments
      json = json.cast<String, dynamic>();
      for (final entry in json.entries) {
        map[entry.key] = StorefrontResult.listFromJson(entry.value, growable: growable,);
      }
    }
    return map;
  }

  /// The list of required keys that must be present in a JSON.
  static const requiredKeys = <String>{
  };
}