sk_api_schema 0.7.9 → 0.8.0

data/.travis.yml

@@ -1,5 +1,5 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
+  - 1.9.3
+  - 2.0.0
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -3,8 +3,14 @@
 See [commit messages](https://github.com/salesking/sk_api_schema/commits/) for details.
 Also signup to our [Developer Newsletter](http://www.salesking.eu/dev/newsletter/) to stay up-to-date !!!
 
+##2013-08
+
+* add items array to documents to be used instead of line_items
+* Deprecate line_items
+
 ##2013-06
-- add email filter "status" accepting sent,draft,in_progress strings, dropped sent/status filter
+
+* add email filter "status" accepting sent,draft,in_progress strings, dropped sent/status filter
 
 ##2013-05
 

data/json/v1.0/credit_note.json

@@ -81,7 +81,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
       "readonly":true,
       "type":"number"
     },
@@ -127,10 +127,19 @@
       "minLength":22
     },
     "line_items":{
-      "description": "Line items for the document",
+      "description": "DEPRECATED use items",
       "type":"array",
       "properties":{"$ref":"./line_item.json#properties"}
     },
+    "items":{
+      "description": "Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the items array is stronger.",
+      "type":"array",
+      "default": "any",
+      "minItems": 0,
+      "items": [{ "$ref": "./line_item.json#properties"},
+                { "$ref":  "./divider_item.json#properties"},
+                { "$ref": "./sub_total_item.json#properties"}]
+    },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards.",
       "format":"date-time",
@@ -148,12 +157,12 @@
       "type":"integer"
     },
     "price_total":{
-      "description": "Deprecated use net_total_base",
+      "description": "DEPRECATED: use net_total_base",
       "readonly":true,
       "type":"number"
     },
     "price_tax":{
-      "description": "Deprecated: use tax_total",
+      "description": "DEPRECATED: use tax_total",
       "readonly":true,
       "type":"number"
     },

data/json/v1.0/divider_item.json

@@ -21,6 +21,11 @@
       "type":"string",
       "maxLength": 50
     },
+    "type":{
+      "description": "The item type: DividerItem. Must be set when creating new items via document.items array",
+      "type":"string",
+      "maxLength": 20
+    },
    "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",

data/json/v1.0/document.json

@@ -122,7 +122,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
       "readonly":true,
       "type":"number"
     },

data/json/v1.0/estimate.json

@@ -76,7 +76,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
       "readonly":true,
       "type":"number"
     },
@@ -122,10 +122,19 @@
       "minLength":22
     },
     "line_items":{
-      "description": "Line items for the document",
+      "description": "DEPRECATED use items",
       "type":"array",
       "properties":{"$ref":"./line_item.json#properties"}
     },
+    "items":{
+      "description": "Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the items array is stronger.",
+      "type":"array",
+      "default": "any",
+      "minItems": 0,
+      "items": [{ "$ref": "./line_item.json#properties"},
+                { "$ref":  "./divider_item.json#properties"},
+                { "$ref": "./sub_total_item.json#properties"}]
+    },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards.",
       "format":"date-time",

data/json/v1.0/invoice.json

@@ -81,7 +81,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
       "readonly":true,
       "type":"number"
     },
@@ -127,12 +127,12 @@
       "minLength": 22
     },
     "line_items":{
-      "description": "Line items for the document",
+      "description": "DEPRECATED use items",
       "type":"array",
       "properties":{"$ref":"./line_item.json#properties"}
     },
     "items":{
-      "description": "Items for the document. Access items of all types including divider and sub_total items. Item creation is currently only supported through line_items array.",
+      "description": "Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the items array is stronger.",
       "type":"array",
       "default": "any",
       "minItems": 0,

data/json/v1.0/line_item.json

@@ -21,6 +21,11 @@
       "type":"string",
       "maxLength": 50
     },
+    "type":{
+      "description": "The item type: LineItem. Must be set when creating new items via document.items array",
+      "type":"string",
+      "maxLength": 20
+    },
     "external_ref":{
       "description": "Arbitrary number e.g. external product reference.",
       "type":"string",

data/json/v1.0/order.json

@@ -81,7 +81,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
       "readonly":true,
       "type":"number"
     },
@@ -127,10 +127,19 @@
       "minLength":22
     },
     "line_items":{
-      "description": "Line items for the document",
+      "description": "DEPRECATED use items",
       "type":"array",
       "properties":{"$ref":"./line_item.json#properties"}
     },
+    "items":{
+      "description": "Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the items array is stronger.",
+      "type":"array",
+      "default": "any",
+      "minItems": 0,
+      "items": [{ "$ref": "./line_item.json#properties"},
+                { "$ref":  "./divider_item.json#properties"},
+                { "$ref": "./sub_total_item.json#properties"}]
+    },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards.",
       "format":"date-time",

data/json/v1.0/payment.json

@@ -43,7 +43,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
       "readonly":true,
       "type":"number"
     },

data/json/v1.0/payment_reminder.json

@@ -1,7 +1,7 @@
 { "type":"object",
   "title": "payment_reminder",
   "name": "payment_reminder",
-  "description": "A payment reminder",
+  "description": "A payment reminder belongs to an invoice and inherits it's line items from the invoice total(first item) and late fee settings(second item).",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
@@ -79,7 +79,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). The rate is set on document open with the exchange rate based on the document date. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday).",
       "readonly":true,
       "type":"number"
     },
@@ -126,10 +126,17 @@
       "minLength":22
     },
     "line_items":{
-      "description": "Line items for the document. Defaults to invoice.gross_total and late fee values from settings",
+      "description": "DEPRECATED use items",
       "type":"array",
       "properties":{"$ref":"./line_item.json#properties"}
     },
+    "items":{
+      "description": "Items for the document. GOTCHAs: you should NOT create items manually since we create them. The first item contains the invoice total and the optional second one the late_fee.",
+      "type":"array",
+      "default": "any",
+      "minItems": 1,
+      "items": { "$ref": "./line_item.json#properties"}
+    },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards.",
       "format":"date-time",

data/json/v1.0/recurring.json

@@ -114,10 +114,19 @@
       "minLength":22
     },
     "line_items":{
-      "description": "Line items for the document",
+      "description": "DEPRECATED use items",
       "type":"array",
       "properties":{"$ref":"./line_item.json#properties"}
     },
+    "items":{
+      "description": "Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the items array is stronger.",
+      "type":"array",
+      "default": "any",
+      "minItems": 0,
+      "items": [{ "$ref": "./line_item.json#properties"},
+                { "$ref":  "./divider_item.json#properties"},
+                { "$ref": "./sub_total_item.json#properties"}]
+    },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards.",
       "format":"date-time",

data/json/v1.0/sub_total_item.json

@@ -21,6 +21,11 @@
       "type":"string",
       "maxLength": 50
     },
+    "type":{
+      "description": "The item type: SubTotalItem. Must be set when creating new items via document.items array",
+      "type":"string",
+      "maxLength": 20
+    },
     "net_total":{
       "description": "Net sub-total",
       "type":"number",

data/lib/sk_api_schema/version.rb

@@ -1,7 +1,7 @@
 module SK
   module Api
     class Schema
-      VERSION='0.7.9'
+      VERSION='0.8.0'
     end
   end
 end

data/spec/sk_api_schema_spec.rb

@@ -70,6 +70,7 @@ describe SK::Api::Schema do
 
       @item =  LineItem.new
       @item.id = 'some-uuid'
+      @item.type = 'LineItem'
       @item.name = 'Pork Chops'
       @item.description = 'Yummi Pork chopped by mexian emigrants'
       @item.position = 1
@@ -92,8 +93,8 @@ describe SK::Api::Schema do
       obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
       obj_hash["invoice"]['client']['client'].should == {"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}
       obj_hash["invoice"]["client"]['links'].should_not be_nil
-      obj_hash["invoice"]["line_items"].should == [ {"line_item"=>{"name"=>"Pork Chops", "position"=>1, \
-                                         "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}]
+      obj_hash["invoice"]["line_items"].should == [ {"line_item"=>{"name"=>"Pork Chops", "position"=>1, "type"=>"LineItem",
+                                                    "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}]
     end
 
     it "should parse object given fields" do
@@ -154,7 +155,7 @@ class Invoice
 end
 
 class LineItem
-  attr_accessor :id, :name, :description, :position, :price_single
+  attr_accessor :id, :name, :description, :position, :price_single, :type
 end
 
 class Client

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
-  - 9
-  version: 0.7.9
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-05 00:00:00 Z
+date: 2013-08-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime