sk_api_schema 0.8.4 → 0.8.5

data/CHANGELOG.md

@@ -1,21 +1,20 @@
 # SalesKing API Changelog
 
 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 !!!
+Also sign up to our [Developer Newsletter](http://www.salesking.eu/dev/newsletter/) to stay up-to-date !!!
 
 ##2013-08
 
+* fix docs for POST invoices/ID/payments to create payments
+* add auto_send setting for recurring, opens invoice,creates pdf, sends email
 * add recurring_id for invoices referencing the recurring from which the invoice was created
-* add filter\[recurring_ids] to invoices, recurring links to all invoices
+* add filter\[recurring_ids] to invoices
+* add link to all invoices in recurring
 * add filter\[status] to all documents
 * add log field for emails, keeping potential error log
 * add BCC, CC, FROM fields for email templates
 * add items array to documents to be used instead of line_items
-* Deprecate line_items
-
-** doc.items vs doc.line_items **
-
-ONLY use ONE as long as both items and line_items are present!
+* Deprecate line_items **! doc.items vs doc.line_items !** ONLY use ONE as long as both items and line_items are present!
 When updating objects we cannot figure out which array changed. In this case we
 prefer line_items for backwards compatibility.
 When using items: make sure to remove line_items before submitting an updated

data/json/v1.0/credit_note.json

@@ -81,7 +81,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "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).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
       "readonly":true,
       "type":"number"
     },
@@ -294,7 +294,7 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source(excl. number,date) and returns a new draft document. Fields passed with the object(e.g. notes, title, address_field) are not overwritten."
+          "description": "Copies the source(excl. number,date) and returns a new draft document. You can pass any document type(e.g. invoice, order). Fields passed with the object(e.g. notes, title, address_field) are not overwritten."
         },
         "cancel" : {
           "title" : "Cancel an credit note",
@@ -336,6 +336,10 @@
         }
       }
     },
+    { "rel": "payment create",
+      "href": "invoices/{id}/payments",
+      "method": "POST"
+    },
     { "rel": "print",
       "href": "credit_notes/{id}/print",
       "method": "POST",

data/json/v1.0/document.json

@@ -122,7 +122,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "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).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
       "readonly":true,
       "type":"number"
     },

data/json/v1.0/estimate.json

@@ -76,7 +76,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "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).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
       "readonly":true,
       "type":"number"
     },
@@ -286,7 +286,7 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source(excl. number,date) and returns a new draft document. Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
+          "description": "Copies the source(excl. number,date) and returns a new draft document. You can pass any document type(e.g. invoice, order). Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
           "type" : "string"
         }
       }

data/json/v1.0/invoice.json

@@ -81,7 +81,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "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).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
       "readonly":true,
       "type":"number"
     },
@@ -301,7 +301,7 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source(excl. number,date) and returns a new draft document. Fields passed with the object(e.g. notes, title, address_field) are not overwritten. If the source is an Estimate or Order only line_items, contact & tags are copied.",
+          "description": "Copies the source(excl. number,date) and returns a new draft document. You can pass any document type(e.g. invoice, order). Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
           "type" : "string"
         },
         "cancel" : {
@@ -348,6 +348,10 @@
         }
       }
     },
+    { "rel": "payment create",
+      "href": "invoices/{id}/payments",
+      "method": "POST"
+    },
     { "rel": "print",
       "href": "invoices/{id}/print",
       "method": "POST",

data/json/v1.0/order.json

@@ -81,7 +81,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "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).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
       "readonly":true,
       "type":"number"
     },
@@ -291,7 +291,7 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source(excl. number,date) and returns a new draft document. Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
+          "description": "Copies the source(excl. number,date) and returns a new draft document. You can pass any document type(e.g. invoice, order). Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
           "type" : "string"
         }
       }

data/json/v1.0/payment.json

@@ -1,7 +1,7 @@
 { "type":"object",
   "title": "payment",
   "name": "payment",
-  "description":"An payment in SK must always be related to an document.",
+  "description":"An payment must always be related to an document, so you must use the nested URL e.g. POST invoices/ID/payments. In this case the related_object_id/type are automatically set.",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
@@ -43,7 +43,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "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).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
       "readonly":true,
       "type":"number"
     },
@@ -62,12 +62,12 @@
       "type":"number"
     },
     "related_object_type":{
-      "description": "Object type of the payments parent. Is the camel-cased base class name: Document for invoice, credit_note",
+      "description": "Object type of the payments parent. Is the camel-cased base class name: Document for invoice, credit_note. Is auto-set when using the nested URL POST invoices/ID/payments",
       "required":true,
       "type":"string"
     },
     "related_object_id":{
-      "description": "uuid of the payments parent object.",
+      "description": "uuid of the payments parent object. Is auto-set when using the nested URL POST invoices/ID/payments",
       "required":true,
       "type":"string",
       "maxLength": 22,

data/json/v1.0/payment_reminder.json

@@ -79,7 +79,7 @@
       "minLength": 3
     },
     "exchange_rate":{
-      "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).",
+      "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
       "readonly":true,
       "type":"number"
     },

data/json/v1.0/recurring.json

@@ -162,6 +162,24 @@
       "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
+    },
+    "pdf_template_id":{
+      "description": "The PDF template used for printing the invoice when auto sending. Required when auto_send'ing is enabled.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "email_template_id":{
+      "description": "The Email template used for the email in auto sending. Required when auto_send'ing is enabled.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "auto_send":{
+      "description": "Enable automatic sending of new invoices created from the recurring. Opens the invoice, creates a PDF and sends an email to the contact. GOTCHA's: check PDF-, Email-Template, SMTP Settings and of course the contacts email address! Since new recurrings which start today directly create new invoices, they are also SEND if auto_send is true!! If something fails, we'll send an error-email to the user who created the recurring. For success infos you can add yourself to the BCC of the email template or",
+      "default": null,
+      "type": "string",
+      "enum":["email"]
     }
   },
   "links":[
@@ -268,7 +286,7 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source(excl. number,date) and returns a new draft document. Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
+          "description": "Copies the source(excl. number,date) and returns a new draft document. You can pass any document type(e.g. invoice, order). Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
           "type" : "string"
         }
       }

data/lib/sk_api_schema/version.rb

@@ -1,7 +1,7 @@
 module SK
   module Api
     class Schema
-      VERSION='0.8.4'
+      VERSION='0.8.5'
     end
   end
 end

data/sk_api_schema.gemspec

@@ -11,11 +11,11 @@ Besides ruby users can use a small lib with utility methods to load and test the
   s.authors     = ['Georg Leciejewski']
   s.email       = %q{gl@salesking.eu}
   s.homepage    = %q{http://github.com/salesking/sk_api_schema}
+  s.license = 'MIT'
 
   s.files       = `git ls-files`.split("\n").reject{|i| i[/^docs\//] }
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.extra_rdoc_files = ['README.rdoc']
-
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'activesupport'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 0
   - 8
-  - 4
-  version: 0.8.4
+  - 5
+  version: 0.8.5
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-16 00:00:00 Z
+date: 2013-08-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -141,8 +141,8 @@ files:
 - spec/sk_api_schema_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/salesking/sk_api_schema
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []