Skip to content

Commit c291530

Browse files
detaindetain
committed
update
1 parent 9e76aea commit c291530

48 files changed

Lines changed: 2504 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎data/functions/api_change_floating_ips_ip.json‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"serverargv": "{$_SERVER[\"argv\"][0]}",
3+
"name": "api_change_floating_ips_ip",
4+
"params": "",
5+
"description": "Changes the IP of a floating IP order",
6+
"function": {
7+
"name": "api_change_floating_ips_ip",
8+
"desc": "Changes the IP of a floating IP order",
9+
"input": {
10+
"sid": {
11+
"name": "sid",
12+
"type": "string",
13+
"description": "the *Session ID* you get from the [login](#login) call",
14+
"example": "5f20dad4a74142bf03686e70b8027b5c"
15+
},
16+
"id": {
17+
"name": "id",
18+
"type": "int",
19+
"description": "",
20+
"example": 10000
21+
},
22+
"ip": {
23+
"name": "ip",
24+
"type": "string",
25+
"description": "",
26+
"example": "66.45.228.200"
27+
}
28+
},
29+
"output": {
30+
"return": {
31+
"name": "return",
32+
"type": "bool",
33+
"description": ""
34+
}
35+
},
36+
"example": true
37+
},
38+
"input_comment": "* @param sid string the *Session ID* you get from the [login](#login) call\n* @param id int \n* @param ip string \n",
39+
"output_comment": "",
40+
"use_sid": true,
41+
"hide_comment": true
42+
}

‎data/functions/api_floating_ips_cancel_service.json‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"serverargv": "{$_SERVER[\"argv\"][0]}",
3+
"name": "api_floating_ips_cancel_service",
4+
"params": "",
5+
"description": "This Function Applies to the Floating IPs services.\n* Cancels a service for the passed module matching the passed id. Canceling a\n* service will also cancel any addons for that service at the same time.",
6+
"function": {
7+
"name": "api_floating_ips_cancel_service",
8+
"desc": "This Function Applies to the Floating IPs services.\nCancels a service for the passed module matching the passed id. Canceling a service will also cancel any addons for that service at the same time.",
9+
"input": {
10+
"sid": {
11+
"name": "sid",
12+
"type": "string",
13+
"description": "the *Session ID* you get from the [login](#login) call",
14+
"example": "5f20dad4a74142bf03686e70b8027b5c"
15+
},
16+
"id": {
17+
"name": "id",
18+
"type": "int",
19+
"description": "ID \/ Service ID you wish to cancel",
20+
"example": 10000
21+
}
22+
},
23+
"output": {
24+
"return": {
25+
"name": "return",
26+
"type": "bool",
27+
"description": ""
28+
}
29+
},
30+
"example": false
31+
},
32+
"input_comment": "* @param sid string the *Session ID* you get from the [login](#login) call\n* @param id int ID \/ Service ID you wish to cancel\n",
33+
"output_comment": "",
34+
"use_sid": true,
35+
"hide_comment": true
36+
}

‎data/functions/api_floating_ips_get_client_invoices.json‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"serverargv": "{$_SERVER[\"argv\"][0]}",
3+
"name": "api_floating_ips_get_client_invoices",
4+
"params": "",
5+
"description": "This Function Applies to the Floating IPs services.\n* Gets a list of all the invoices.",
6+
"function": {
7+
"name": "api_floating_ips_get_client_invoices",
8+
"desc": "This Function Applies to the Floating IPs services.\nGets a list of all the invoices.",
9+
"input": {
10+
"sid": {
11+
"name": "sid",
12+
"type": "string",
13+
"description": "the *Session ID* you get from the [login](#login) call",
14+
"example": "5f20dad4a74142bf03686e70b8027b5c"
15+
}
16+
},
17+
"output": [
18+
{
19+
"name": "invoices_id",
20+
"type": "int",
21+
"description": "ID of the Invoice used for referencing"
22+
},
23+
{
24+
"name": "invoices_description",
25+
"type": "string",
26+
"description": "Description of what the Invoice was for"
27+
},
28+
{
29+
"name": "invoices_amount",
30+
"type": "float",
31+
"description": "Cost of the Invoice"
32+
},
33+
{
34+
"name": "invoices_custid",
35+
"type": "int",
36+
"description": "ID of the Customer this Invoice is for"
37+
},
38+
{
39+
"name": "invoices_type",
40+
"type": "int",
41+
"description": "The Type of Invoice (1 = charge, 10+ are payment types)"
42+
},
43+
{
44+
"name": "invoices_date",
45+
"type": "string",
46+
"description": "Date the Invoice was Created"
47+
},
48+
{
49+
"name": "invoices_group",
50+
"type": "int",
51+
"description": "Billing Group the Invoice falls under, Not currently used"
52+
},
53+
{
54+
"name": "invoices_extra",
55+
"type": "int",
56+
"description": "If type 1 invoice this points to the repeat invoice id, otherwise points to the id of the charge invoice its a payment for."
57+
},
58+
{
59+
"name": "invoices_paid",
60+
"type": "int",
61+
"description": "Whether or not the Invoice was paid (if applicable)"
62+
},
63+
{
64+
"name": "invoices_module",
65+
"type": "string",
66+
"description": "Module the Invoice was for. You can use [get_modules](#get-modules) to get a list of available modules."
67+
},
68+
{
69+
"name": "invoices_due_date",
70+
"type": "string",
71+
"description": "Date the Invoice is Due"
72+
},
73+
{
74+
"name": "invoices_service",
75+
"type": "int",
76+
"description": "ID of the Service\/Order this Invoice is for such as 1000 if the order was vps1000 and the module was vps"
77+
},
78+
{
79+
"name": "invoices_deleted",
80+
"type": "int",
81+
"description": "Deleted Flag"
82+
},
83+
{
84+
"name": "invoices_currency",
85+
"type": "string",
86+
"description": ""
87+
}
88+
],
89+
"example": []
90+
},
91+
"input_comment": "* @param sid string the *Session ID* you get from the [login](#login) call\n",
92+
"output_comment": "",
93+
"use_sid": true,
94+
"hide_comment": true
95+
}

‎data/functions/api_floating_ips_get_client_unpaid_invoices.json‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"serverargv": "{$_SERVER[\"argv\"][0]}",
3+
"name": "api_floating_ips_get_client_unpaid_invoices",
4+
"params": "",
5+
"description": "This Function Applies to the Floating IPs services.\n* This function returns a list of all the unpaid invoices matching the module\n* passed..",
6+
"function": {
7+
"name": "api_floating_ips_get_client_unpaid_invoices",
8+
"desc": "This Function Applies to the Floating IPs services.\nThis function returns a list of all the unpaid invoices matching the module passed..",
9+
"input": {
10+
"sid": {
11+
"name": "sid",
12+
"type": "string",
13+
"description": "the *Session ID* you get from the [login](#login) call",
14+
"example": "5f20dad4a74142bf03686e70b8027b5c"
15+
}
16+
},
17+
"output": [
18+
{
19+
"name": "invoices_id",
20+
"type": "int",
21+
"description": "ID of the Invoice used for referencing"
22+
},
23+
{
24+
"name": "invoices_description",
25+
"type": "string",
26+
"description": "Description of what the Invoice was for"
27+
},
28+
{
29+
"name": "invoices_amount",
30+
"type": "float",
31+
"description": "Cost of the Invoice"
32+
},
33+
{
34+
"name": "invoices_custid",
35+
"type": "int",
36+
"description": "ID of the Customer this Invoice is for"
37+
},
38+
{
39+
"name": "invoices_type",
40+
"type": "int",
41+
"description": "The Type of Invoice (1 = charge, 10+ are payment types)"
42+
},
43+
{
44+
"name": "invoices_date",
45+
"type": "string",
46+
"description": "Date the Invoice was Created"
47+
},
48+
{
49+
"name": "invoices_group",
50+
"type": "int",
51+
"description": "Billing Group the Invoice falls under, Not currently used"
52+
},
53+
{
54+
"name": "invoices_extra",
55+
"type": "int",
56+
"description": "If type 1 invoice this points to the repeat invoice id, otherwise points to the id of the charge invoice its a payment for."
57+
},
58+
{
59+
"name": "invoices_paid",
60+
"type": "int",
61+
"description": "Whether or not the Invoice was paid (if applicable)"
62+
},
63+
{
64+
"name": "invoices_module",
65+
"type": "string",
66+
"description": "Module the Invoice was for. You can use [get_modules](#get-modules) to get a list of available modules."
67+
},
68+
{
69+
"name": "invoices_due_date",
70+
"type": "string",
71+
"description": "Date the Invoice is Due"
72+
},
73+
{
74+
"name": "invoices_service",
75+
"type": "int",
76+
"description": "ID of the Service\/Order this Invoice is for such as 1000 if the order was vps1000 and the module was vps"
77+
},
78+
{
79+
"name": "invoices_deleted",
80+
"type": "int",
81+
"description": "Deleted Flag"
82+
},
83+
{
84+
"name": "invoices_currency",
85+
"type": "string",
86+
"description": ""
87+
}
88+
],
89+
"example": []
90+
},
91+
"input_comment": "* @param sid string the *Session ID* you get from the [login](#login) call\n",
92+
"output_comment": "",
93+
"use_sid": true,
94+
"hide_comment": true
95+
}

‎data/functions/api_floating_ips_get_service.json‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
{
2+
"serverargv": "{$_SERVER[\"argv\"][0]}",
3+
"name": "api_floating_ips_get_service",
4+
"params": "",
5+
"description": "This Function Applies to the Floating IPs services.\n* Gets service info for the given ID in the given Module. An example of this\n* would be in the \"vps\" module have order id",
6+
"function": {
7+
"name": "api_floating_ips_get_service",
8+
"desc": "This Function Applies to the Floating IPs services.\nGets service info for the given ID in the given Module. An example of this would be in the \"vps\" module have order id",
9+
"input": {
10+
"sid": {
11+
"name": "sid",
12+
"type": "string",
13+
"description": "the *Session ID* you get from the [login](#login) call",
14+
"example": "5f20dad4a74142bf03686e70b8027b5c"
15+
},
16+
"id": {
17+
"name": "id",
18+
"type": "int",
19+
"description": "",
20+
"example": 10000
21+
}
22+
},
23+
"output": [
24+
{
25+
"name": "floating_ip_id",
26+
"type": "int",
27+
"description": "Service ID"
28+
},
29+
{
30+
"name": "floating_ip_type",
31+
"type": "int",
32+
"description": "Package ID"
33+
},
34+
{
35+
"name": "floating_ip_currency",
36+
"type": "string",
37+
"description": "Currency"
38+
},
39+
{
40+
"name": "floating_ip_order_date",
41+
"type": "string",
42+
"description": "Date the Order was Placed"
43+
},
44+
{
45+
"name": "floating_ip_custid",
46+
"type": "int",
47+
"description": "Customer ID"
48+
},
49+
{
50+
"name": "floating_ip_quota",
51+
"type": "int",
52+
"description": "Disk Quota"
53+
},
54+
{
55+
"name": "floating_ip_ip",
56+
"type": "string",
57+
"description": "IP Address of floating ips"
58+
},
59+
{
60+
"name": "floating_ip_target_ip",
61+
"type": "string",
62+
"description": ""
63+
},
64+
{
65+
"name": "floating_ip_status",
66+
"type": "string",
67+
"description": "Billing Status"
68+
},
69+
{
70+
"name": "floating_ip_invoice",
71+
"type": "int",
72+
"description": "Invoice ID"
73+
},
74+
{
75+
"name": "floating_ip_coupon",
76+
"type": "int",
77+
"description": "Coupon ID"
78+
},
79+
{
80+
"name": "floating_ip_extra",
81+
"type": "string",
82+
"description": "Additional floating ips Information"
83+
},
84+
{
85+
"name": "floating_ip_server_status",
86+
"type": "string",
87+
"description": "Server-Side status of this website"
88+
},
89+
{
90+
"name": "floating_ip_comment",
91+
"type": "string",
92+
"description": "Comments"
93+
}
94+
]
95+
},
96+
"input_comment": "* @param sid string the *Session ID* you get from the [login](#login) call\n* @param id int \n",
97+
"output_comment": "",
98+
"use_sid": true,
99+
"hide_comment": true
100+
}

0 commit comments

Comments
 (0)