BokaMera.API.Host

BumpWidgetConfigurationVersion

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/widget/configuration/{Id}/bumpversion	Bump the homepage default widget configuration to the next schema version	Moves the homepage default configuration's SchemaVersion to SchemaVersion + 1. Returns 400 if the next version's schema does not exist yet, if UseFactoryDefaults is true and the next version has no DefaultConfiguration authored, or if the target configuration is not the homepage default.

import 'package:servicestack/servicestack.dart';

class WidgetConfigurationResponse implements IConvertible
{
    String Id = "";
    String CompanyId = "";
    String Name = "";
    String? Slug;
    String? Description;
    String Configuration = "";
    int SchemaVersion = 0;
    bool IsHomepageDefault;
    DateTime CreatedDate = DateTime(0);
    DateTime? UpdatedDate;
    ResponseStatus ResponseStatus;

    WidgetConfigurationResponse({this.Id,this.CompanyId,this.Name,this.Slug,this.Description,this.Configuration,this.SchemaVersion,this.IsHomepageDefault,this.CreatedDate,this.UpdatedDate,this.ResponseStatus});
    WidgetConfigurationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        CompanyId = json['CompanyId'];
        Name = json['Name'];
        Slug = json['Slug'];
        Description = json['Description'];
        Configuration = json['Configuration'];
        SchemaVersion = json['SchemaVersion'];
        IsHomepageDefault = json['IsHomepageDefault'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        UpdatedDate = JsonConverters.fromJson(json['UpdatedDate'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'CompanyId': CompanyId,
        'Name': Name,
        'Slug': Slug,
        'Description': Description,
        'Configuration': Configuration,
        'SchemaVersion': SchemaVersion,
        'IsHomepageDefault': IsHomepageDefault,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'UpdatedDate': JsonConverters.toJson(UpdatedDate,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "WidgetConfigurationResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="Not the homepage default, next schema version doesn't exist, or (when UseFactoryDefaults) the next version has no factory default authored yet", StatusCode=400)
// @ApiResponse(Description="Returned if the configuration was not found", StatusCode=404)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class BumpWidgetConfigurationVersion implements ICompany, IConvertible
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    String? CompanyId;

    /**
    * The widget configuration id (6-character NanoID).
    */
    // @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
    String Id = "";

    /**
    * When true, overwrites Configuration with the next schema version's factory-default JSON. When false, only SchemaVersion is moved and the existing Configuration is preserved unvalidated against the new schema.
    */
    // @ApiMember(Description="When true, overwrites Configuration with the next schema version's factory-default JSON. When false, only SchemaVersion is moved and the existing Configuration is preserved unvalidated against the new schema.", IsRequired=true)
    bool UseFactoryDefaults;

    BumpWidgetConfigurationVersion({this.CompanyId,this.Id,this.UseFactoryDefaults});
    BumpWidgetConfigurationVersion.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        UseFactoryDefaults = json['UseFactoryDefaults'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id,
        'UseFactoryDefaults': UseFactoryDefaults
    };

    getTypeName() => "BumpWidgetConfigurationVersion";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
    'WidgetConfigurationResponse': TypeInfo(TypeOf.Class, create:() => WidgetConfigurationResponse()),
    'BumpWidgetConfigurationVersion': TypeInfo(TypeOf.Class, create:() => BumpWidgetConfigurationVersion()),
});

Dart BumpWidgetConfigurationVersion DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /widget/configuration/{Id}/bumpversion HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: String,
	UseFactoryDefaults: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Name: String,
	Slug: String,
	Description: String,
	Configuration: String,
	SchemaVersion: 0,
	IsHomepageDefault: False,
	UpdatedDate: 0001-01-01T00:00:00.0000000+00:00,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}