sk_api_schema 0.7.1 → 0.7.2
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.md +6 -0
- data/json/v1.0/attachment.json +5 -2
- data/json/v1.0/contact.json +7 -4
- data/json/v1.0/credit_note.json +2 -2
- data/json/v1.0/document.json +2 -2
- data/json/v1.0/estimate.json +2 -2
- data/json/v1.0/invoice.json +2 -2
- data/json/v1.0/order.json +2 -2
- data/json/v1.0/payment_reminder.json +1 -1
- data/lib/sk_api_schema/version.rb +1 -1
- metadata +3 -3
data/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
See [commit messages](https://github.com/salesking/sk_api_schema/commits/) for details.
|
|
4
4
|
Also signup to our [Developer Newsletter](http://www.salesking.eu/dev/newsletter/) to stay up-to-date !!!
|
|
5
5
|
|
|
6
|
+
##2013-04
|
|
7
|
+
|
|
8
|
+
* new attachments/{ID}/download url DEPRECATE attachment.url
|
|
9
|
+
* add lead_date to contact
|
|
10
|
+
* make contact.lead_ref + lead_source text fields
|
|
11
|
+
|
|
6
12
|
##2013-03
|
|
7
13
|
|
|
8
14
|
* add path method to schema: SK::Api::Schema.path
|
data/json/v1.0/attachment.json
CHANGED
|
@@ -24,13 +24,13 @@
|
|
|
24
24
|
"maxLength": 255
|
|
25
25
|
},
|
|
26
26
|
"url":{
|
|
27
|
-
"description": "
|
|
27
|
+
"description": "DEPRECATED use attachments/ID/download",
|
|
28
28
|
"readonly":true,
|
|
29
29
|
"type":"string",
|
|
30
30
|
"format": "uri"
|
|
31
31
|
},
|
|
32
32
|
"related_object_type":{
|
|
33
|
-
"description": "Object type of the attachment parent. Is the
|
|
33
|
+
"description": "Object type of the attachment parent. Is the camelCased base class name: Document for invoice, credit_note, contact, ..",
|
|
34
34
|
"required":true,
|
|
35
35
|
"type":"string"
|
|
36
36
|
},
|
|
@@ -73,6 +73,9 @@
|
|
|
73
73
|
{ "rel": "self",
|
|
74
74
|
"href": "attachments/{id}"
|
|
75
75
|
},
|
|
76
|
+
{ "rel": "download",
|
|
77
|
+
"href": "attachments/{id}/download"
|
|
78
|
+
},
|
|
76
79
|
{ "rel": "instances",
|
|
77
80
|
"href": "attachments",
|
|
78
81
|
"properties" : {
|
data/json/v1.0/contact.json
CHANGED
|
@@ -206,13 +206,16 @@
|
|
|
206
206
|
},
|
|
207
207
|
"lead_source":{
|
|
208
208
|
"description": "Lead source describing where a contact came from e.g. a campaign name, website, facebook, URL",
|
|
209
|
-
"type":"
|
|
210
|
-
"maxLength": 255
|
|
209
|
+
"type":"text"
|
|
211
210
|
},
|
|
212
211
|
"lead_ref":{
|
|
213
212
|
"description": "Lead reference e.g. a tracking id, web-url",
|
|
214
|
-
"type":"
|
|
215
|
-
|
|
213
|
+
"type":"text"
|
|
214
|
+
},
|
|
215
|
+
"lead_date":{
|
|
216
|
+
"description": "Lead date e.g. date of first contact with your company",
|
|
217
|
+
"format":"date",
|
|
218
|
+
"type":"string"
|
|
216
219
|
},
|
|
217
220
|
"converted_at":{
|
|
218
221
|
"description": "Date the contact converted from lead to client or any other contact type (supplier)",
|
data/json/v1.0/credit_note.json
CHANGED
|
@@ -86,7 +86,7 @@
|
|
|
86
86
|
"type":"number"
|
|
87
87
|
},
|
|
88
88
|
"gross_total_exchanged":{
|
|
89
|
-
"description": "
|
|
89
|
+
"description": "Exchanged gross total, in your company currency.",
|
|
90
90
|
"readonly":true,
|
|
91
91
|
"type":"number"
|
|
92
92
|
},
|
|
@@ -158,7 +158,7 @@
|
|
|
158
158
|
"type":"number"
|
|
159
159
|
},
|
|
160
160
|
"gross_total":{
|
|
161
|
-
"description": "Gross total of all line items, 2 decimals places",
|
|
161
|
+
"description": "Gross total of all line items, 2 decimals places in document currency.",
|
|
162
162
|
"readonly":true,
|
|
163
163
|
"type":"number"
|
|
164
164
|
},
|
data/json/v1.0/document.json
CHANGED
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
"type":"string"
|
|
97
97
|
},
|
|
98
98
|
"gross_total":{
|
|
99
|
-
"description": "Gross total of all line items, 2 decimals places",
|
|
99
|
+
"description": "Gross total of all line items, 2 decimals places in document currency.",
|
|
100
100
|
"readonly":true,
|
|
101
101
|
"type":"number"
|
|
102
102
|
},
|
|
@@ -127,7 +127,7 @@
|
|
|
127
127
|
"type":"number"
|
|
128
128
|
},
|
|
129
129
|
"gross_total_exchanged":{
|
|
130
|
-
"description": "
|
|
130
|
+
"description": "Exchanged gross total, in your company currency.",
|
|
131
131
|
"readonly":true,
|
|
132
132
|
"type":"number"
|
|
133
133
|
},
|
data/json/v1.0/estimate.json
CHANGED
|
@@ -81,7 +81,7 @@
|
|
|
81
81
|
"type":"number"
|
|
82
82
|
},
|
|
83
83
|
"gross_total_exchanged":{
|
|
84
|
-
"description": "
|
|
84
|
+
"description": "Exchanged gross total, in your company currency.",
|
|
85
85
|
"readonly":true,
|
|
86
86
|
"type":"number"
|
|
87
87
|
},
|
|
@@ -143,7 +143,7 @@
|
|
|
143
143
|
"type":"integer"
|
|
144
144
|
},
|
|
145
145
|
"gross_total":{
|
|
146
|
-
"description": "Gross total of all line items, 2 decimals places",
|
|
146
|
+
"description": "Gross total of all line items, 2 decimals places in document currency.",
|
|
147
147
|
"readonly":true,
|
|
148
148
|
"type":"number"
|
|
149
149
|
},
|
data/json/v1.0/invoice.json
CHANGED
|
@@ -86,7 +86,7 @@
|
|
|
86
86
|
"type":"number"
|
|
87
87
|
},
|
|
88
88
|
"gross_total_exchanged":{
|
|
89
|
-
"description": "
|
|
89
|
+
"description": "Exchanged gross total, in your company currency.",
|
|
90
90
|
"readonly":true,
|
|
91
91
|
"type":"number"
|
|
92
92
|
},
|
|
@@ -167,7 +167,7 @@
|
|
|
167
167
|
"type":"number"
|
|
168
168
|
},
|
|
169
169
|
"gross_total":{
|
|
170
|
-
"description": "Gross total of all line items, 2 decimals places",
|
|
170
|
+
"description": "Gross total of all line items, 2 decimals places in document currency.",
|
|
171
171
|
"readonly":true,
|
|
172
172
|
"type":"number"
|
|
173
173
|
},
|
data/json/v1.0/order.json
CHANGED
|
@@ -86,7 +86,7 @@
|
|
|
86
86
|
"type":"number"
|
|
87
87
|
},
|
|
88
88
|
"gross_total_exchanged":{
|
|
89
|
-
"description": "
|
|
89
|
+
"description": "Exchanged gross total, in your company currency.",
|
|
90
90
|
"readonly":true,
|
|
91
91
|
"type":"number"
|
|
92
92
|
},
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
"type":"integer"
|
|
149
149
|
},
|
|
150
150
|
"gross_total":{
|
|
151
|
-
"description": "Gross total of all line items, 2 decimals places",
|
|
151
|
+
"description": "Gross total of all line items, 2 decimals places in document currency.",
|
|
152
152
|
"readonly":true,
|
|
153
153
|
"type":"number"
|
|
154
154
|
},
|
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: 7
|
|
5
5
|
prerelease:
|
|
6
6
|
segments:
|
|
7
7
|
- 0
|
|
8
8
|
- 7
|
|
9
|
-
-
|
|
10
|
-
version: 0.7.
|
|
9
|
+
- 2
|
|
10
|
+
version: 0.7.2
|
|
11
11
|
platform: ruby
|
|
12
12
|
authors:
|
|
13
13
|
- Georg Leciejewski
|