| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /billing/company/creditcard | Get saved credit card information for the company. | Get saved credit card information for the company. |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
abstract class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
// @DataMember(Order=1)
int? Skip;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
// @DataMember(Order=2)
int? Take;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
// @DataMember(Order=3)
String? OrderBy;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
// @DataMember(Order=4)
String? OrderByDesc;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
// @DataMember(Order=5)
String? Include;
// @DataMember(Order=6)
String? Fields;
// @DataMember(Order=7)
Map<String,String?>? Meta;
QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Skip = json['Skip'];
Take = json['Take'];
OrderBy = json['OrderBy'];
OrderByDesc = json['OrderByDesc'];
Include = json['Include'];
Fields = json['Fields'];
Meta = JsonConverters.toStringMap(json['Meta']);
return this;
}
Map<String, dynamic> toJson() => {
'Skip': Skip,
'Take': Take,
'OrderBy': OrderBy,
'OrderByDesc': OrderByDesc,
'Include': Include,
'Fields': Fields,
'Meta': Meta
};
getTypeName() => "QueryBase";
TypeContext? context = _ctx;
}
abstract class QueryDb2<From,Into> extends QueryBase
{
QueryDb2();
QueryDb2.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "QueryDb<$From,$Into>";
TypeContext? context = _ctx;
}
class CompanyCreditCardQueryResponse implements IConvertible
{
/**
* The credit card id
*/
// @ApiMember(Description="The credit card id")
int? Id;
/**
* The credit card name
*/
// @ApiMember(Description="The credit card name")
String? Name;
/**
* If the credit card is active
*/
// @ApiMember(Description="If the credit card is active")
bool? Active;
/**
* If the credit card is valid (active and not expired)
*/
// @ApiMember(Description="If the credit card is valid (active and not expired)")
bool? IsValid;
/**
* The credit card type
*/
// @ApiMember(Description="The credit card type")
String? Type;
/**
* The credit card expiration Year
*/
// @ApiMember(Description="The credit card expiration Year")
String? ExpYear;
/**
* The credit card expiration month
*/
// @ApiMember(Description="The credit card expiration month")
String? ExpMonth;
/**
* The credit card ticket name. This is secret information and won't be displayed
*/
// @ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")
String? TicketId;
/**
* The date when the credit card was saved.
*/
// @ApiMember(Description="The date when the credit card was saved.")
DateTime? Created;
/**
* The date when the credit card was updated.
*/
// @ApiMember(Description="The date when the credit card was updated.")
DateTime? Updated;
CompanyCreditCardQueryResponse({this.Id,this.Name,this.Active,this.IsValid,this.Type,this.ExpYear,this.ExpMonth,this.TicketId,this.Created,this.Updated});
CompanyCreditCardQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
Active = json['Active'];
IsValid = json['IsValid'];
Type = json['Type'];
ExpYear = json['ExpYear'];
ExpMonth = json['ExpMonth'];
TicketId = json['TicketId'];
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'Active': Active,
'IsValid': IsValid,
'Type': Type,
'ExpYear': ExpYear,
'ExpMonth': ExpMonth,
'TicketId': TicketId,
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'Updated': JsonConverters.toJson(Updated,'DateTime',context!)
};
getTypeName() => "CompanyCreditCardQueryResponse";
TypeContext? context = _ctx;
}
class BaseModel implements IConvertible
{
BaseModel();
BaseModel.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "BaseModel";
TypeContext? context = _ctx;
}
class CreditCard extends BaseModel implements IConvertible
{
// @Ignore()
bool? IsValid;
// @Required()
String? CompanyId;
int? Id;
// @Required()
String? Name;
// @Required()
bool? Active;
// @Required()
String? Type;
// @Required()
String? ExpYear;
// @Required()
String? ExpMonth;
// @Required()
String? TicketId;
DateTime? Updated;
DateTime? Created;
DateTime? ModifiedDate;
CreditCard({this.IsValid,this.CompanyId,this.Id,this.Name,this.Active,this.Type,this.ExpYear,this.ExpMonth,this.TicketId,this.Updated,this.Created,this.ModifiedDate});
CreditCard.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
IsValid = json['IsValid'];
CompanyId = json['CompanyId'];
Id = json['Id'];
Name = json['Name'];
Active = json['Active'];
Type = json['Type'];
ExpYear = json['ExpYear'];
ExpMonth = json['ExpMonth'];
TicketId = json['TicketId'];
Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'IsValid': IsValid,
'CompanyId': CompanyId,
'Id': Id,
'Name': Name,
'Active': Active,
'Type': Type,
'ExpYear': ExpYear,
'ExpMonth': ExpMonth,
'TicketId': TicketId,
'Updated': JsonConverters.toJson(Updated,'DateTime',context!),
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
});
getTypeName() => "CreditCard";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class CompanyCreditCardInformation extends QueryDb2<CreditCard,CompanyCreditCardQueryResponse> 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;
/**
* If you want to include only active credit cards
*/
// @ApiMember(DataType="boolean", Description="If you want to include only active credit cards", ParameterType="query")
bool? Active;
/**
* If you want to include only valid credit cards (not expired and valid)
*/
// @ApiMember(DataType="boolean", Description="If you want to include only valid credit cards (not expired and valid)", ParameterType="query")
bool? IsValid;
CompanyCreditCardInformation({this.CompanyId,this.Active,this.IsValid});
CompanyCreditCardInformation.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CompanyId = json['CompanyId'];
Active = json['Active'];
IsValid = json['IsValid'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CompanyId': CompanyId,
'Active': Active,
'IsValid': IsValid
});
getTypeName() => "CompanyCreditCardInformation";
TypeContext? context = _ctx;
}
class AccessKeyTypeResponse implements IConvertible
{
int? Id;
String? KeyType;
String? Description;
AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
KeyType = json['KeyType'];
Description = json['Description'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'KeyType': KeyType,
'Description': Description
};
getTypeName() => "AccessKeyTypeResponse";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<AccessKeyTypeResponse> implements IConvertible
{
// @DataMember(Order=1)
int? Offset;
// @DataMember(Order=2)
int? Total;
// @DataMember(Order=3)
List<AccessKeyTypeResponse>? Results;
// @DataMember(Order=4)
Map<String,String?>? Meta;
// @DataMember(Order=5)
ResponseStatus? ResponseStatus;
QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Offset = json['Offset'];
Total = json['Total'];
Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
Meta = JsonConverters.toStringMap(json['Meta']);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Offset': Offset,
'Total': Total,
'Results': JsonConverters.toJson(Results,'List<AccessKeyTypeResponse>',context!),
'Meta': Meta,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$AccessKeyTypeResponse>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'CompanyCreditCardQueryResponse': TypeInfo(TypeOf.Class, create:() => CompanyCreditCardQueryResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'CreditCard': TypeInfo(TypeOf.Class, create:() => CreditCard()),
'CompanyCreditCardInformation': TypeInfo(TypeOf.Class, create:() => CompanyCreditCardInformation()),
'List<CompanyCreditCardQueryResponse>': TypeInfo(TypeOf.Class, create:() => <CompanyCreditCardQueryResponse>[]),
'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
'QueryResponse<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => QueryResponse<AccessKeyTypeResponse>()),
});
Dart CompanyCreditCardInformation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /billing/company/creditcard HTTP/1.1 Host: api.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Active":false,"IsValid":false,"Type":"String","ExpYear":"String","ExpMonth":"String","TicketId":"String","Created":"0001-01-01T00:00:00","Updated":"0001-01-01T00:00:00"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}