Billhighway Cloud API

IntegrationPartnerGetRq

The following routes are available for this service:
GET	/signup/api/integration/partner/{name}

import 'package:servicestack/servicestack.dart';

class OAuthAppRedirects implements IConvertible
{
    String? Scope;
    String? RedirectTemplate;
    bool? AllowAnonymous;

    OAuthAppRedirects({this.Scope,this.RedirectTemplate,this.AllowAnonymous});
    OAuthAppRedirects.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Scope = json['Scope'];
        RedirectTemplate = json['RedirectTemplate'];
        AllowAnonymous = json['AllowAnonymous'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Scope': Scope,
        'RedirectTemplate': RedirectTemplate,
        'AllowAnonymous': AllowAnonymous
    };

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

class IntegrationPartnerOAuthSettings implements IConvertible
{
    int? NatId;
    int? ChapId;
    String? AuthorizeUrl;
    String? AuthorizeRedirectUri;
    String? TokenUrl;
    String? UserInfoUrl;
    String? ConsumerKey;
    String? ConsumerSecret;
    String? Username;
    String? Password;
    String? SecurityToken;
    List<OAuthAppRedirects>? AppRedirects;

    IntegrationPartnerOAuthSettings({this.NatId,this.ChapId,this.AuthorizeUrl,this.AuthorizeRedirectUri,this.TokenUrl,this.UserInfoUrl,this.ConsumerKey,this.ConsumerSecret,this.Username,this.Password,this.SecurityToken,this.AppRedirects});
    IntegrationPartnerOAuthSettings.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NatId = json['NatId'];
        ChapId = json['ChapId'];
        AuthorizeUrl = json['AuthorizeUrl'];
        AuthorizeRedirectUri = json['AuthorizeRedirectUri'];
        TokenUrl = json['TokenUrl'];
        UserInfoUrl = json['UserInfoUrl'];
        ConsumerKey = json['ConsumerKey'];
        ConsumerSecret = json['ConsumerSecret'];
        Username = json['Username'];
        Password = json['Password'];
        SecurityToken = json['SecurityToken'];
        AppRedirects = JsonConverters.fromJson(json['AppRedirects'],'List<OAuthAppRedirects>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NatId': NatId,
        'ChapId': ChapId,
        'AuthorizeUrl': AuthorizeUrl,
        'AuthorizeRedirectUri': AuthorizeRedirectUri,
        'TokenUrl': TokenUrl,
        'UserInfoUrl': UserInfoUrl,
        'ConsumerKey': ConsumerKey,
        'ConsumerSecret': ConsumerSecret,
        'Username': Username,
        'Password': Password,
        'SecurityToken': SecurityToken,
        'AppRedirects': JsonConverters.toJson(AppRedirects,'List<OAuthAppRedirects>',context!)
    };

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

class DestinationUriType
{
    static const DestinationUriType None = const DestinationUriType._(0);
    static const DestinationUriType Absolute = const DestinationUriType._(1);
    static const DestinationUriType Relative = const DestinationUriType._(2);

    final int _value;
    const DestinationUriType._(this._value);
    int get value => _value;
    static List<DestinationUriType> get values => const [None,Absolute,Relative];
}

class IntegrationDestinationConfig implements IConvertible
{
    String? Type;
    DestinationUriType? UriType;
    String? Uri;
    String? AuthenticationKey;

    IntegrationDestinationConfig({this.Type,this.UriType,this.Uri,this.AuthenticationKey});
    IntegrationDestinationConfig.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Type = json['Type'];
        UriType = JsonConverters.fromJson(json['UriType'],'DestinationUriType',context!);
        Uri = json['Uri'];
        AuthenticationKey = json['AuthenticationKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Type': Type,
        'UriType': JsonConverters.toJson(UriType,'DestinationUriType',context!),
        'Uri': Uri,
        'AuthenticationKey': AuthenticationKey
    };

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

class IntegrationPartner implements IConvertible
{
    int? IntegrationPartnerId;
    String? Name;
    String? Description;
    String? Uri;
    String? Username;
    String? Password;
    String? ApiKey;
    IntegrationPartnerOAuthSettings? OAuthSettings;
    List<IntegrationDestinationConfig>? DetinationConfigurations;
    String? Scope;

    IntegrationPartner({this.IntegrationPartnerId,this.Name,this.Description,this.Uri,this.Username,this.Password,this.ApiKey,this.OAuthSettings,this.DetinationConfigurations,this.Scope});
    IntegrationPartner.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IntegrationPartnerId = json['IntegrationPartnerId'];
        Name = json['Name'];
        Description = json['Description'];
        Uri = json['Uri'];
        Username = json['Username'];
        Password = json['Password'];
        ApiKey = json['ApiKey'];
        OAuthSettings = JsonConverters.fromJson(json['OAuthSettings'],'IntegrationPartnerOAuthSettings',context!);
        DetinationConfigurations = JsonConverters.fromJson(json['DetinationConfigurations'],'List<IntegrationDestinationConfig>',context!);
        Scope = json['Scope'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IntegrationPartnerId': IntegrationPartnerId,
        'Name': Name,
        'Description': Description,
        'Uri': Uri,
        'Username': Username,
        'Password': Password,
        'ApiKey': ApiKey,
        'OAuthSettings': JsonConverters.toJson(OAuthSettings,'IntegrationPartnerOAuthSettings',context!),
        'DetinationConfigurations': JsonConverters.toJson(DetinationConfigurations,'List<IntegrationDestinationConfig>',context!),
        'Scope': Scope
    };

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

class IntegrationPartnerRs implements IApiResponse, IConvertible
{
    IntegrationPartner? Partner;

    IntegrationPartnerRs({this.Partner});
    IntegrationPartnerRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Partner = JsonConverters.fromJson(json['Partner'],'IntegrationPartner',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Partner': JsonConverters.toJson(Partner,'IntegrationPartner',context!)
    };

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

class IntegrationPartnerGetRq implements IApiRequest, IConvertible
{
    String? Name;

    IntegrationPartnerGetRq({this.Name});
    IntegrationPartnerGetRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Name': Name
    };

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

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'OAuthAppRedirects': TypeInfo(TypeOf.Class, create:() => OAuthAppRedirects()),
    'IntegrationPartnerOAuthSettings': TypeInfo(TypeOf.Class, create:() => IntegrationPartnerOAuthSettings()),
    'List<OAuthAppRedirects>': TypeInfo(TypeOf.Class, create:() => <OAuthAppRedirects>[]),
    'DestinationUriType': TypeInfo(TypeOf.Enum, enumValues:DestinationUriType.values),
    'IntegrationDestinationConfig': TypeInfo(TypeOf.Class, create:() => IntegrationDestinationConfig()),
    'IntegrationPartner': TypeInfo(TypeOf.Class, create:() => IntegrationPartner()),
    'List<IntegrationDestinationConfig>': TypeInfo(TypeOf.Class, create:() => <IntegrationDestinationConfig>[]),
    'IntegrationPartnerRs': TypeInfo(TypeOf.Class, create:() => IntegrationPartnerRs()),
    'IntegrationPartnerGetRq': TypeInfo(TypeOf.Class, create:() => IntegrationPartnerGetRq()),
});

Dart IntegrationPartnerGetRq DTOs

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

HTTP + CSV

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

GET /signup/api/integration/partner/{name} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv

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

{"Partner":{"IntegrationPartnerId":0,"Name":"String","Description":"String","Uri":"String","Username":"String","Password":"String","ApiKey":"String","OAuthSettings":{"NatId":0,"ChapId":0,"AuthorizeUrl":"String","AuthorizeRedirectUri":"String","TokenUrl":"String","UserInfoUrl":"String","ConsumerKey":"String","ConsumerSecret":"String","Username":"String","Password":"String","SecurityToken":"String","AppRedirects":[{"Scope":"String","RedirectTemplate":"String","AllowAnonymous":false}]},"DetinationConfigurations":[{"Type":"String","UriType":0,"Uri":"String","AuthenticationKey":"String"}],"Scope":"String"}}