sk_api_schema 0.6.0 → 0.6.1

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
 
 2013-01
+* add external_ref for line item
+* email "send" parameter can be set to false or 0 to prevent sending
+* email "from_addr" is not required
 * add new item types: devider_item, sub_total_item
 * add items for documents containing all items by type
 * add filter\[tags] to products, mark price as required

data/README.rdoc

@@ -6,7 +6,7 @@ Our API (objects,resources) is described with JSON Schema (http://json-schema.or
 Each Object has its own description, with those top-level keys:
 
   {
-    "title": "client",      // object type
+    "name": "client",      // object type
     "properties": { .. },   // field descriptions
     "links": [ .. ]         // CRUD actions, relationships to other resources
   }

data/json/v1.0/email.json

@@ -22,8 +22,7 @@
       "format":"text"
     },
     "from_addr":{
-      "description": "From address",
-      "required":true,
+      "description": "From address. If empty the email of the current user is taken.",
       "type":"string",
       "maxLength": 255
     },
@@ -176,7 +175,7 @@
         },
         "send":{
           "title" : "Send email",
-          "description": "If present(any val) email is scheduled for sending."
+          "description": "Schedule email for sending. Omit this parameter or set value to 0 or false(String or Integer) to keep email as draft."
         },
         "archived_pdf":{
           "title" : "Attach archived pdf",

data/json/v1.0/invoice.json

@@ -120,7 +120,7 @@
       "properties":{"$ref":"./line_item.json#properties"}
     },
     "items":{
-      "description": "Items for the document. Access items of all types including divider and sub_total 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.",
       "type":"array",
       "default": "any",
       "minItems": 0,

data/json/v1.0/line_item.json

@@ -21,6 +21,11 @@
       "type":"string",
       "maxLength": 50
     },
+    "external_ref":{
+      "description": "Arbitrary number e.g. external product reference.",
+      "type":"string",
+      "maxLength": 255
+    },
     "description":{
       "description": "Item description",
       "type":"string",

data/lib/sk_api_schema/version.rb

@@ -1,7 +1,7 @@
 module SK
   module Api
     class Schema
-      VERSION='0.6.0'
+      VERSION='0.6.1'
     end
   end
 end

metadata

@@ -1,107 +1,105 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: sk_api_schema
-version: !ruby/object:Gem::Version
-  version: 0.6.0
+version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 1
+  version: 0.6.1
 platform: ruby
-authors:
+authors: 
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+
+date: 2012-07-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: activesupport
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  prerelease: false
   name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  prerelease: false
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  prerelease: false
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
         version: 0.9.2
-  type: :development
+  version_requirements: *id005
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-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 small lib with utility methods to load and test the
-  schema files.'
+  name: rake
+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 small 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: 
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
@@ -143,29 +141,36 @@ 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
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -3277987017950227307
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SalesKing API - JSON Schema
 test_files: []
+