"use strict";
export class QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
skip;
/** @type {?number} */
take;
/** @type {string} */
orderBy;
/** @type {string} */
orderByDesc;
/** @type {string} */
include;
/** @type {string} */
fields;
/** @type {{ [index: string]: string; }} */
meta;
}
/** @typedef T {any} */
export class QueryData extends QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GithubUser {
/** @param {{id?:number,login?:string,avatar_Url?:string,url?:string,followers?:number,following?:number,type?:string,public_Gists?:number,location?:string,company?:string,html_Url?:string,public_Repos?:number,created_At?:string,blog?:string,email?:string,name?:string,hireable?:boolean,gravatar_Id?:string,bio?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
login;
/** @type {string} */
avatar_Url;
/** @type {string} */
url;
/** @type {?number} */
followers;
/** @type {?number} */
following;
/** @type {string} */
type;
/** @type {?number} */
public_Gists;
/** @type {string} */
location;
/** @type {string} */
company;
/** @type {string} */
html_Url;
/** @type {?number} */
public_Repos;
/** @type {?string} */
created_At;
/** @type {string} */
blog;
/** @type {string} */
email;
/** @type {string} */
name;
/** @type {?boolean} */
hireable;
/** @type {string} */
gravatar_Id;
/** @type {string} */
bio;
}
export class GithubRepo {
/** @param {{id?:number,name?:string,description?:string,homepage?:string,language?:string,watchers_Count?:number,stargazes_Count?:number,forks_Count?:number,open_Issues_Count?:number,size?:number,full_Name?:string,created_at?:string,pushed_At?:string,updated_At?:string,has_issues?:boolean,has_Downloads?:boolean,has_Wiki?:boolean,has_Pages?:boolean,fork?:boolean,owner?:GithubUser,svn_Url?:string,mirror_Url?:string,url?:string,ssh_Url?:string,html_Url?:string,clone_Url?:string,git_Url?:string,private?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
name;
/** @type {string} */
description;
/** @type {string} */
homepage;
/** @type {string} */
language;
/** @type {number} */
watchers_Count;
/** @type {number} */
stargazes_Count;
/** @type {number} */
forks_Count;
/** @type {number} */
open_Issues_Count;
/** @type {number} */
size;
/** @type {string} */
full_Name;
/** @type {string} */
created_at;
/** @type {?string} */
pushed_At;
/** @type {?string} */
updated_At;
/** @type {boolean} */
has_issues;
/** @type {boolean} */
has_Downloads;
/** @type {boolean} */
has_Wiki;
/** @type {boolean} */
has_Pages;
/** @type {boolean} */
fork;
/** @type {GithubUser} */
owner;
/** @type {string} */
svn_Url;
/** @type {string} */
mirror_Url;
/** @type {string} */
url;
/** @type {string} */
ssh_Url;
/** @type {string} */
html_Url;
/** @type {string} */
clone_Url;
/** @type {string} */
git_Url;
/** @type {boolean} */
private;
}
export class QueryGitHubRepos extends QueryData {
/** @param {{userName?:string,skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
userName;
}
export class Order {
/** @param {{orderId?:number,customerId?:string,orderDate?:string,total?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
orderId;
/** @type {string} */
customerId;
/** @type {string} */
orderDate;
/** @type {number} */
total;
}
export class Customer {
/** @param {{customerId?:string,companyName?:string,address?:string,city?:string,region?:string,postalCode?:string,country?:string,phone?:string,fax?:string,orders?:Order[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
customerId;
/** @type {string} */
companyName;
/** @type {string} */
address;
/** @type {string} */
city;
/** @type {string} */
region;
/** @type {string} */
postalCode;
/** @type {string} */
country;
/** @type {string} */
phone;
/** @type {string} */
fax;
/** @type {Order[]} */
orders;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index: string]: string; },responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
total;
/** @type {T[]} */
results;
/** @type {{ [index: string]: string; }} */
meta;
/** @type {ResponseStatus} */
responseStatus;
}
JavaScript QueryGitHubRepos DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/QueryGitHubRepos HTTP/1.1
Host: sharpscript.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"userName":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"offset":0,"total":0,"results":[{"id":0,"name":"String","description":"String","homepage":"String","language":"String","watchers_Count":0,"stargazes_Count":0,"forks_Count":0,"open_Issues_Count":0,"size":0,"full_Name":"String","created_at":"\/Date(-62135596800000-0000)\/","pushed_At":"\/Date(-62135596800000-0000)\/","updated_At":"\/Date(-62135596800000-0000)\/","has_issues":false,"has_Downloads":false,"has_Wiki":false,"has_Pages":false,"fork":false,"owner":{"id":0,"login":"String","avatar_Url":"String","url":"String","followers":0,"following":0,"type":"String","public_Gists":0,"location":"String","company":"String","html_Url":"String","public_Repos":0,"created_At":"\/Date(-62135596800000-0000)\/","blog":"String","email":"String","name":"String","hireable":false,"gravatar_Id":"String","bio":"String"},"svn_Url":"String","mirror_Url":"String","url":"String","ssh_Url":"String","html_Url":"String","clone_Url":"String","git_Url":"String","private":false}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}