sk_api_schema 0.3.0 → 0.3.1

data/CHANGELOG.rdoc

@@ -5,6 +5,11 @@ A more detailed view of the changes can be found in the {commit messages}[https:
 2012-01
 * add notes field for client
 
+2012-05
+
+* add missing payment method to order
+* fix date & date-time type definitions
+* add empty links section to address, line item
 
 2011-10
 * added created_at search filter to clients and documents
@@ -25,7 +30,7 @@ A more detailed view of the changes can be found in the {commit messages}[https:
 * added filter[client_ids] to documents, to search by one or multiple clients
 * added filter[ids] for documents, to find multiple specific documents
 * changed _delete property to _destroy for address, line_item
-* removed client_id requirement for documents 
+* removed client_id requirement for documents
 
 2011-05
 * new hash_clean method for ruby schema reader class
@@ -36,7 +41,7 @@ A more detailed view of the changes can be found in the {commit messages}[https:
 * reduced default objects in list to 10, max is 100
 * added field parameter to limit returned fields in ruby to_hash_from_schema & SK
 * added created_at & number filtering to client
-* added _delete field to line_item & address, to be able to destroy them since both are transfered within their parent object 
+* added _delete field to line_item & address, to be able to destroy them since both are transfered within their parent object
 
 2011-03
 * added subscriptions

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/json/v1.0/address.json

@@ -55,7 +55,7 @@
       "format":"date-time",
       "readonly":true,
       "type":"string"
-    },   
+    },
     "address_type": {
       "description": "Type of the address, as seen by vCard definition. There can only be one type. Inside of SK you can use placeholders like client.parcel_address.city to access the first parcel adr(Same for work_ / home_). <br/>Besides the placeholder default_address, always returns the first address found. Sorting is done by the order(if set) else by date, newest first.",
       "enum":["work","home", "parcel"],
@@ -66,7 +66,7 @@
       "type":"integer"
     },
     "lat": {
-      "description": "Geolocation latitude",      
+      "description": "Geolocation latitude",
       "type":"string"
     },
     "long": {
@@ -77,5 +77,6 @@
       "description": "When set an existing address will be deleted. This switch is only used when addresses are passed-in nested inside their parent object(a contact).",
       "type":"boolean"
     }
-  }
+  },
+  "links":[]
 }

data/json/v1.0/attachment.json

@@ -57,7 +57,7 @@
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
       "type":"string"
     }
-    
+
   },
   "links":[
     { "rel": "self",
@@ -84,12 +84,14 @@
         "filter[from]":{
           "title" : "From date",
           "description": "All objects created at and after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "All objects created at and before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "sort_by":{
           "title" : "Sort by",

data/json/v1.0/client.json

@@ -57,7 +57,7 @@
       "description": "VAT number, for a company or person paying value added taxes.",
       "type":"string",
       "maxLength": 30
-    },   
+    },
     "email": {
       "description": "Email address of the contact.",
       "type":"string",
@@ -75,7 +75,7 @@
     "tag_list": {
       "description": "Space separated list of tags.",
       "type":"string"
-    },   
+    },
     "created_at": {
       "description": "Date the record was created in SK. Never changes afterwards.",
       "format":"date-time",
@@ -205,22 +205,26 @@
         "filter[created_at_from]":{
           "title" : "From date",
           "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[created_at_to]":{
           "title" : "To date",
           "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[birthday_from]":{
           "title" : "From birthday date",
           "description": "Contacts with a birthday after and on the date. Leave the birthday-to date blank to only search on this day.",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[birthday_to]":{
           "title" : "To birthday date",
           "description": "Contacts with a birthday date before and on the date.",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[creator_ids]":{
           "title" : "Creator",
@@ -230,7 +234,7 @@
         "filter[number]":{
           "title" : "By number",
           "description": "Search by number where the number is matched from the start: %number",
-          "type" : "date"
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",

data/json/v1.0/comment.json

@@ -12,7 +12,7 @@
       "description": "The comment himself.",
       "required":true,
       "type":"string"
-    },   
+    },
     "related_object_type": {
       "description": "Object type of the comments parent. Is the camelcased base class name: Document for invoice, credit_note,.., Contact for client",
       "required":true,
@@ -65,12 +65,14 @@
         "filter[from]":{
           "title" : "From date",
           "description": "All objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "All objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "sort_by":{
           "title" : "Sort by",

data/json/v1.0/credit_note.json

@@ -183,12 +183,14 @@
         "filter[created_at_from]":{
           "title" : "From date",
           "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[created_at_to]":{
           "title" : "To date",
           "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",

data/json/v1.0/document.json

@@ -132,22 +132,26 @@
         "filter[from]":{
           "title" : "From date",
           "description": "Objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "Objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[created_at_from]":{
           "title" : "From date",
           "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[created_at_to]":{
           "title" : "To date",
           "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",

data/json/v1.0/email.json

@@ -117,12 +117,14 @@
         "filter[from]":{
           "title" : "From date",
           "description": "All objects updated on/after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "All objects updated on/before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "sort_by":{
           "title" : "Sort by",

data/json/v1.0/estimate.json

@@ -163,22 +163,26 @@
         "filter[from]":{
           "title" : "From date",
           "description": "Objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "Objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[created_at_from]":{
           "title" : "From date",
           "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[created_at_to]":{
           "title" : "To date",
           "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",

data/json/v1.0/export.json

@@ -93,12 +93,14 @@
         "filter[from]":{
           "title" : "From date",
           "description": "All objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "All objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "sort_by":{
           "title" : "Sort by",

data/json/v1.0/invoice.json

@@ -1,6 +1,6 @@
 { "type":"object",
   "title": "invoice",
-  "description": "An invoice",  
+  "description": "An invoice",
   "properties":{
     "id":{
       "description": "UUID assigned by SK",
@@ -41,7 +41,7 @@
       "type":"string"
     },
     "payment_method":{
-      "description": "How the invoce is beeing payed. Used in new payments.",
+      "description": "How the document is beeing payed. Used in new payments.",
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
@@ -173,12 +173,14 @@
         "filter[from]":{
           "title" : "From date",
           "description": "Objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "Objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",

data/json/v1.0/line_item.json

@@ -67,5 +67,6 @@
       "description": "When set an existing item will be deleted. This switch is used for items passed-in nested inside their parent object(a document), which is default as long as there is no line item endpoint available.",
       "type":"boolean"
     }
-  }
+  },
+  "links":[]
 }

data/json/v1.0/order.json

@@ -31,6 +31,11 @@
       "description": "Some external reference, whatever this may be.",
       "type":"string"
     },
+    "payment_method":{
+      "description": "How the document is beeing payed. Used in new payments.",
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
+      "type":"string"
+    },
     "title":{
       "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your order [number]'",
       "type":"string"
@@ -149,22 +154,26 @@
         "filter[from]":{
           "title" : "From date",
           "description": "Objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "Objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[created_at_from]":{
           "title" : "From date",
           "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[created_at_to]":{
           "title" : "To date",
           "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",

data/json/v1.0/payment.json

@@ -12,7 +12,7 @@
       "description": "The payment amount",
       "required":true,
       "type":"number"
-    },   
+    },
     "external_ref":{
       "description": "Reference number f.ex. issued by the bank.",
       "type":"string"
@@ -74,13 +74,15 @@
         "filter[from]":{
           "title" : "From date",
           "description": "All objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
 
         },
         "filter[to]":{
           "title" : "To date",
           "description": "All objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "sort_by":{
           "title" : "Sort by",

data/json/v1.0/payment_reminder.json

@@ -99,10 +99,10 @@
       "type":"integer"
     },
     "gross_total":{
-      "description": "Gross total of all line items, 2 decimals places",
+      "description": "DEPRECATED use net_total bcs there are no taxes applied",
       "readonly":true,
       "type":"number"
-    },    
+    },
     "net_total":{
       "description": "Net total, 2 decimals places",
       "readonly":true,
@@ -139,12 +139,14 @@
         "filter[from]":{
           "title" : "From date",
           "description": "All objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "All objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",

data/json/v1.0/recurring.json

@@ -40,7 +40,7 @@
       "required":true
     },
     "payment_method":{
-      "description": "How the invoce is beeing payed. Used in new payments.",
+      "description": "How the document is beeing payed. Used in new payments.",
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
@@ -155,22 +155,26 @@
         "filter[from]":{
           "title" : "From date",
           "description": "Objects with a date after the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
           "description": "Objects with date before the date",
-          "type" : "date"
+          "format" : "date",
+          "type" : "string"
         },
         "filter[created_at_from]":{
           "title" : "From date",
           "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[created_at_to]":{
           "title" : "To date",
           "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "type" : "date-time"
+          "format" : "date-time",
+          "type" : "string"
         },
         "filter[languages]":{
           "title" : "Languages",
@@ -230,7 +234,7 @@
     },
     { "rel": "attachments",
       "href": "recurrings/{id}/attachments"
-    },    
+    },
     { "rel": "comments",
       "href": "recurrings/{id}/comments"
     }

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sk_api_schema"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = "2012-01-24"
+  s.date = "2012-05-31"
   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."
   s.email = "gl@salesking.eu"
   s.extra_rdoc_files = [
@@ -53,7 +53,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/salesking/sk_api_schema"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.24"
   s.summary = "SalesKing API JSON Schema"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,73 +1,73 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sk_api_schema
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.3.1
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-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.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
 email: gl@salesking.eu
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - CHANGELOG.rdoc
 - README.rdoc
 - Rakefile
@@ -104,36 +104,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/salesking/sk_api_schema
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SalesKing API JSON Schema
 test_files: []
-