sk_api_schema 0.2.6 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGELOG.rdoc +4 -0
- data/VERSION +1 -1
- data/json/v1.0/credit_note.json +0 -11
- data/json/v1.0/document.json +0 -6
- data/json/v1.0/estimate.json +0 -6
- data/json/v1.0/invoice.json +0 -11
- data/json/v1.0/order.json +1 -12
- data/json/v1.0/payment_reminder.json +0 -6
- data/json/v1.0/recurring.json +0 -11
- data/sk_api_schema.gemspec +8 -8
- metadata +6 -8
data/CHANGELOG.rdoc
CHANGED
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
|
|
4
4
|
|
|
5
|
+
2012-01
|
|
6
|
+
* add notes field for client
|
|
7
|
+
|
|
8
|
+
|
|
5
9
|
2011-10
|
|
6
10
|
* added created_at search filter to clients and documents
|
|
7
11
|
* added creator(user) search filter to clients and documents
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.
|
|
1
|
+
0.3.0
|
data/json/v1.0/credit_note.json
CHANGED
|
@@ -61,12 +61,6 @@
|
|
|
61
61
|
"description": "Space seperated list of tags.",
|
|
62
62
|
"type":"string"
|
|
63
63
|
},
|
|
64
|
-
"precision":{
|
|
65
|
-
"description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
|
|
66
|
-
"type":"number",
|
|
67
|
-
"enum": [2,3,4],
|
|
68
|
-
"default":2
|
|
69
|
-
},
|
|
70
64
|
"language":{
|
|
71
65
|
"description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
|
|
72
66
|
"type":"string",
|
|
@@ -139,11 +133,6 @@
|
|
|
139
133
|
"type":"number"
|
|
140
134
|
},
|
|
141
135
|
"net_total_base":{
|
|
142
|
-
"description": "Net total, decimals places as set in precision, default 2",
|
|
143
|
-
"readonly":true,
|
|
144
|
-
"type":"number"
|
|
145
|
-
},
|
|
146
|
-
"net_total_base_raw":{
|
|
147
136
|
"description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
|
|
148
137
|
"readonly":true,
|
|
149
138
|
"type":"number"
|
data/json/v1.0/document.json
CHANGED
|
@@ -45,12 +45,6 @@
|
|
|
45
45
|
"description": "Space separated list of tags.",
|
|
46
46
|
"type":"string"
|
|
47
47
|
},
|
|
48
|
-
"precision":{
|
|
49
|
-
"description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
|
|
50
|
-
"type":"number",
|
|
51
|
-
"enum": [2,3,4],
|
|
52
|
-
"default":2
|
|
53
|
-
},
|
|
54
48
|
"client_id":{
|
|
55
49
|
"description": "The clients uuid",
|
|
56
50
|
"type":"string",
|
data/json/v1.0/estimate.json
CHANGED
|
@@ -56,12 +56,6 @@
|
|
|
56
56
|
"description": "Space separated list of tags.",
|
|
57
57
|
"type":"string"
|
|
58
58
|
},
|
|
59
|
-
"precision":{
|
|
60
|
-
"description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
|
|
61
|
-
"type":"number",
|
|
62
|
-
"enum": [2,3,4],
|
|
63
|
-
"default":2
|
|
64
|
-
},
|
|
65
59
|
"language":{
|
|
66
60
|
"description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
|
|
67
61
|
"type":"string",
|
data/json/v1.0/invoice.json
CHANGED
|
@@ -61,12 +61,6 @@
|
|
|
61
61
|
"description": "Space separated list of tags.",
|
|
62
62
|
"type":"string"
|
|
63
63
|
},
|
|
64
|
-
"precision":{
|
|
65
|
-
"description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
|
|
66
|
-
"type":"number",
|
|
67
|
-
"enum": [2,3,4],
|
|
68
|
-
"default":2
|
|
69
|
-
},
|
|
70
64
|
"language":{
|
|
71
65
|
"description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
|
|
72
66
|
"type":"string",
|
|
@@ -139,11 +133,6 @@
|
|
|
139
133
|
"type":"number"
|
|
140
134
|
},
|
|
141
135
|
"net_total_base":{
|
|
142
|
-
"description": "Net total, decimals places as set in precision, default 2",
|
|
143
|
-
"readonly":true,
|
|
144
|
-
"type":"number"
|
|
145
|
-
},
|
|
146
|
-
"net_total_base_raw":{
|
|
147
136
|
"description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
|
|
148
137
|
"readonly":true,
|
|
149
138
|
"type":"number"
|
data/json/v1.0/order.json
CHANGED
|
@@ -47,12 +47,6 @@
|
|
|
47
47
|
"description": "Space separated list of tags.",
|
|
48
48
|
"type":"string"
|
|
49
49
|
},
|
|
50
|
-
"precision":{
|
|
51
|
-
"description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
|
|
52
|
-
"type":"number",
|
|
53
|
-
"enum": [2,3,4],
|
|
54
|
-
"default":2
|
|
55
|
-
},
|
|
56
50
|
"language":{
|
|
57
51
|
"description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
|
|
58
52
|
"type":"string",
|
|
@@ -115,12 +109,7 @@
|
|
|
115
109
|
"type":"number"
|
|
116
110
|
},
|
|
117
111
|
"net_total_base":{
|
|
118
|
-
"description": "Net total,
|
|
119
|
-
"readonly":true,
|
|
120
|
-
"type":"number"
|
|
121
|
-
},
|
|
122
|
-
"net_total_base_raw":{
|
|
123
|
-
"description": "Net total unrounded, 6 decimal places. Summed items net_total_base_raw (incl discount)",
|
|
112
|
+
"description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
|
|
124
113
|
"readonly":true,
|
|
125
114
|
"type":"number"
|
|
126
115
|
}
|
|
@@ -52,12 +52,6 @@
|
|
|
52
52
|
"description": "Space separated list of tags.",
|
|
53
53
|
"type":"string"
|
|
54
54
|
},
|
|
55
|
-
"precision":{
|
|
56
|
-
"description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
|
|
57
|
-
"type":"number",
|
|
58
|
-
"enum": [2,3,4],
|
|
59
|
-
"default":2
|
|
60
|
-
},
|
|
61
55
|
"language":{
|
|
62
56
|
"description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
|
|
63
57
|
"type":"string",
|
data/json/v1.0/recurring.json
CHANGED
|
@@ -64,12 +64,6 @@
|
|
|
64
64
|
"description": "Space separated list of tags.",
|
|
65
65
|
"type":"string"
|
|
66
66
|
},
|
|
67
|
-
"precision":{
|
|
68
|
-
"description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
|
|
69
|
-
"type":"number",
|
|
70
|
-
"enum": [2,3,4],
|
|
71
|
-
"default":2
|
|
72
|
-
},
|
|
73
67
|
"language":{
|
|
74
68
|
"description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
|
|
75
69
|
"type":"string",
|
|
@@ -126,11 +120,6 @@
|
|
|
126
120
|
"type":"number"
|
|
127
121
|
},
|
|
128
122
|
"net_total_base":{
|
|
129
|
-
"description": "Net total, decimals places as set in precision, default 2",
|
|
130
|
-
"readonly":true,
|
|
131
|
-
"type":"number"
|
|
132
|
-
},
|
|
133
|
-
"net_total_base_raw":{
|
|
134
123
|
"description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
|
|
135
124
|
"readonly":true,
|
|
136
125
|
"type":"number"
|
data/sk_api_schema.gemspec
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
# -*- encoding: utf-8 -*-
|
|
5
5
|
|
|
6
6
|
Gem::Specification.new do |s|
|
|
7
|
-
s.name =
|
|
8
|
-
s.version = "0.
|
|
7
|
+
s.name = "sk_api_schema"
|
|
8
|
+
s.version = "0.3.0"
|
|
9
9
|
|
|
10
10
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
|
11
11
|
s.authors = ["Georg Leciejewski"]
|
|
12
|
-
s.date =
|
|
13
|
-
s.description =
|
|
14
|
-
s.email =
|
|
12
|
+
s.date = "2012-01-24"
|
|
13
|
+
s.description = "The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects. Besides ruby users can use a smal lib with utility methods to load and test the schema files."
|
|
14
|
+
s.email = "gl@salesking.eu"
|
|
15
15
|
s.extra_rdoc_files = [
|
|
16
16
|
"README.rdoc"
|
|
17
17
|
]
|
|
@@ -51,10 +51,10 @@ Gem::Specification.new do |s|
|
|
|
51
51
|
"spec/sk_api_schema_spec.rb",
|
|
52
52
|
"spec/spec_helper.rb"
|
|
53
53
|
]
|
|
54
|
-
s.homepage =
|
|
54
|
+
s.homepage = "http://github.com/salesking/sk_api_schema"
|
|
55
55
|
s.require_paths = ["lib"]
|
|
56
|
-
s.rubygems_version =
|
|
57
|
-
s.summary =
|
|
56
|
+
s.rubygems_version = "1.8.15"
|
|
57
|
+
s.summary = "SalesKing API JSON Schema"
|
|
58
58
|
|
|
59
59
|
if s.respond_to? :specification_version then
|
|
60
60
|
s.specification_version = 3
|
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sk_api_schema
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
hash:
|
|
4
|
+
hash: 19
|
|
5
5
|
prerelease:
|
|
6
6
|
segments:
|
|
7
7
|
- 0
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
version: 0.
|
|
8
|
+
- 3
|
|
9
|
+
- 0
|
|
10
|
+
version: 0.3.0
|
|
11
11
|
platform: ruby
|
|
12
12
|
authors:
|
|
13
13
|
- Georg Leciejewski
|
|
@@ -15,8 +15,7 @@ autorequire:
|
|
|
15
15
|
bindir: bin
|
|
16
16
|
cert_chain: []
|
|
17
17
|
|
|
18
|
-
date: 2012-01-
|
|
19
|
-
default_executable:
|
|
18
|
+
date: 2012-01-24 00:00:00 Z
|
|
20
19
|
dependencies:
|
|
21
20
|
- !ruby/object:Gem::Dependency
|
|
22
21
|
name: activesupport
|
|
@@ -103,7 +102,6 @@ files:
|
|
|
103
102
|
- sk_api_schema.gemspec
|
|
104
103
|
- spec/sk_api_schema_spec.rb
|
|
105
104
|
- spec/spec_helper.rb
|
|
106
|
-
has_rdoc: true
|
|
107
105
|
homepage: http://github.com/salesking/sk_api_schema
|
|
108
106
|
licenses: []
|
|
109
107
|
|
|
@@ -133,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
133
131
|
requirements: []
|
|
134
132
|
|
|
135
133
|
rubyforge_project:
|
|
136
|
-
rubygems_version: 1.
|
|
134
|
+
rubygems_version: 1.8.15
|
|
137
135
|
signing_key:
|
|
138
136
|
specification_version: 3
|
|
139
137
|
summary: SalesKing API JSON Schema
|