sk_api_schema 0.0.12 → 0.0.13

data/README.rdoc

@@ -16,8 +16,8 @@ http://dev.blog.salesking.eu/api/
 The API-version, is kept in the folder-name and as long as there are no major
 changes(breaking backwards compatibility), the version number will remain.
 
-The gem has its own version, not reflecting the api version. It is used in
-SalesKing to deliver it's resources BUT changes might not be directly reflected.
+The gem has its own version number. It is used by SalesKing to deliver it's
+resources BUT changes might not be directly reflected.
 A new gem version indicates a change, but we first try it on our staging environment
 before any live instances are updated.
 

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.13

data/json/v1.0/email.json

@@ -1,6 +1,6 @@
 { "type":"object",
   "title": "email",
-  "description":"An email in SK must always be related to an object.",
+  "description":"An email in SK must always be related to an object. Receivers are limited to 5 per address field.",
   "properties": {
     "id": {
       "description": "uuid of the email",
@@ -94,16 +94,28 @@
         },
         "filter[q]":{
           "title" : "Search",
-          "description": "Search in text",
+          "description": "Search in body and subject",
           "type":"string"
         },
+        "filter[sent]":{
+          "title" : "Sent emails",
+          "description": "Show only sent emails"
+        },
+        "filter[draft]":{
+          "title" : "Draft emails",
+          "description": "Show only draft emails"
+        },
+        "filter[address]":{
+          "title" : "Search in address",
+          "description": "Searches in all address fields: bcc, cc, to, from"
+        },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date"
+          "description": "All objects updated on/after the date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date"
+          "description": "All objects updated on/before the date"
         },
         "sort_by":{
           "title" : "Sort by",

data/json/v1.0/payment.json

@@ -3,7 +3,7 @@
   "description":"An payment in SK must always be related to an object.",
   "properties": {
     "id": {
-      "description": "uuid of the adress.",
+      "description": "uuid of the object",
       "identity":true,
       "readonly":true,
       "type":"string"
@@ -29,12 +29,12 @@
       "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",
+      "description": "Object type of the payments parent. Is the camelcased base class name: Document for invoice, credit_note,.., Contact for client",
       "required":true,
       "type":"string"
     },
     "related_object_id": {
-      "description": "uuid of the comments parent object.",
+      "description": "uuid of the payments parent object.",
       "required":true,
       "type":"string"
     },
@@ -93,7 +93,15 @@
     },
     { "rel": "create",
       "href": "payments",
-      "method": "POST"
+      "method": "POST",
+      "properties" : {
+        "new_doc_status":{
+          "title" : "New status for document",
+          "description": "Convinience method to close a document with a payment.",
+          "enum": ['open','closed'],
+          "type":"string"
+        }
+      }
     }
   ]
 }

data/sk_api_schema.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.12"
+  s.version = "0.0.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 0
-  - 12
-  version: 0.0.12
+  - 13
+  version: 0.0.13
 platform: ruby
 authors: 
 - Georg Leciejewski