sk_api_schema 0.8.0 → 0.8.1

data/CHANGELOG.md

@@ -5,9 +5,18 @@ Also signup to our [Developer Newsletter](http://www.salesking.eu/dev/newsletter
 
 ##2013-08
 
+* 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!
+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
+document!
+
 ##2013-06
 
 * add email filter "status" accepting sent,draft,in_progress strings, dropped sent/status filter

data/json/v1.0/attachment.json

@@ -102,14 +102,13 @@
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects created at and before the date",
+          "description": "All objects created at and before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[related_object_type]":{
           "title" : "Related object type",
           "description": "All objects belonging to the given object type. The singular base class name like: Document, Contact, Export, Message",
-          "format" : "date",
           "type" : "string"
         },
         "sort_by":{

data/json/v1.0/client.json

@@ -73,6 +73,7 @@
       "maxLength": 255
     },
     "birthday":{
+      "description": "The birthday. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -233,13 +234,13 @@
         },
         "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.",
+          "description": "Contacts with a birthday after and on the date. Leave the birthday-to date blank to only search on this day. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[birthday_to]":{
           "title" : "To birthday date",
-          "description": "Contacts with a birthday date before and on the date.",
+          "description": "Contacts with a birthday date before and on the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/comment.json

@@ -71,13 +71,13 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "All objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "All objects with date before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/contact.json

@@ -91,6 +91,7 @@
       "maxLength": 255
     },
     "birthday":{
+      "description": "The birthday. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -213,7 +214,7 @@
       "type":"text"
     },
     "lead_date":{
-      "description": "Lead date e.g. date of first contact with your company",
+      "description": "Lead date e.g. date of first contact with your company. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -269,13 +270,13 @@
         },
         "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.",
+          "description": "Contacts with a birthday after and on the date. Leave the birthday-to date blank to only search on this day. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[birthday_to]":{
           "title" : "To birthday date",
-          "description": "Contacts with a birthday date before and on the date.",
+          "description": "Contacts with a birthday date before and on the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/credit_note.json

@@ -21,7 +21,7 @@
       "type":"string"
     },
     "date":{
-      "description": "Date the credit note is issued. Automatically set when document is opened. Required unless doc status is draft.",
+      "description": "Date the credit note is issued. Automatically set when document is opened. Required unless doc status is draft. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -30,7 +30,7 @@
       "type":"integer"
     },
     "due_date":{
-      "description": "Auto-calculated from date + due days if empty and the document is opened.",
+      "description": "Auto-calculated from date + due days if empty and the document is opened. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -132,7 +132,7 @@
       "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.",
+      "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 line_items array is stronger for backward compat.",
       "type":"array",
       "default": "any",
       "minItems": 0,
@@ -221,12 +221,12 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "Objects with a date on and after the date",
+          "description": "Objects with a date on and after the date. YYYY-MM-DD",
           "type" :"date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "Objects with date before and on the date",
+          "description": "Objects with date before and on the date. YYYY-MM-DD",
           "type" :"date"
         },
         "filter[created_at_from]":{

data/json/v1.0/document.json

@@ -25,7 +25,7 @@
       "type":"string"
     },
     "date":{
-      "description": "Date the document is issued. Automatically set when document is opened. Required for non-draft documents.",
+      "description": "Date the document is issued. Automatically set when document is opened. Required for non-draft documents. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -172,13 +172,13 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "Objects with a date after the date",
+          "description": "Objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "Objects with date before the date",
+          "description": "Objects with date before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/email.json

@@ -125,13 +125,13 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects updated on/after the date",
+          "description": "All objects updated on/after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects updated on/before the date",
+          "description": "All objects updated on/before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/email_template.json

@@ -1,7 +1,7 @@
 { "type":"object",
   "title": "email_template",
   "name": "email_template",
-  "description":"An email_template in SK",
+  "description":"An email_template is used to simplify the creation of emails. When creating a new email just pass template id and all fields from the template are copied to the new email. The fields are NOT merged with present values in a new email object!",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
@@ -29,6 +29,21 @@
       "type":"string",
       "format":"text"
     },
+    "from_addr":{
+      "description": "Default from address. A valid email address. Make sure your server(if custom SMPT settings for the API user) allows sending with this address.",
+      "type":"string",
+      "maxLength": 255
+    },
+    "cc_addr":{
+      "description": "Default copy receivers comma separated valid email addresses.",
+      "type":"string",
+      "maxLength": 255
+    },
+    "bcc_addr":{
+      "description": "Default blind copy receivers comma separated valid email addresses. ",
+      "type":"string",
+      "maxLength": 255
+    },
     "kind":{
       "description": "Kind of object the template can be used for.",
       "required":true,

data/json/v1.0/estimate.json

@@ -21,7 +21,7 @@
       "type":"string"
     },
     "date":{
-      "description": "Date the estimate is issued. Automatically set when estimate is opened. Required for non-draft documents.",
+      "description": "Date the estimate is issued. Automatically set when estimate is opened. Required for non-draft documents. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -30,7 +30,7 @@
       "type":"integer"
     },
     "due_date":{
-      "description": "Auto-calculated from date + due days if empty and the estimate is opened.",
+      "description": "Auto-calculated from date + due days if empty and the estimate is opened. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -127,7 +127,7 @@
       "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.",
+      "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 line_items array is stronger for backward compat.",
       "type":"array",
       "default": "any",
       "minItems": 0,
@@ -206,13 +206,13 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "Objects with a date after the date",
+          "description": "Objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "Objects with date before the date",
+          "description": "Objects with date before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/invoice.json

@@ -21,7 +21,7 @@
       "type":"string"
     },
     "date":{
-      "description": "Date the invoice is issued. Automatically set when invoice is opened. Required for non-draft documents.",
+      "description": "Date the invoice is issued. Automatically set when invoice is opened. Required for non-draft documents. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -30,7 +30,7 @@
       "type":"integer"
     },
     "due_date":{
-      "description": "Auto-calculated from date + due days if empty and the document is opened.",
+      "description": "Auto-calculated from date + due days if empty and the document is opened. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -132,7 +132,7 @@
       "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.",
+      "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 line_items array is stronger for backward compat.",
       "type":"array",
       "default": "any",
       "minItems": 0,
@@ -157,12 +157,12 @@
       "type":"integer"
     },
     "price_total":{
-      "description": "Deprecated use net_total_base_raw",
+      "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"
     },
@@ -221,13 +221,13 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "Objects with a date after the date",
+          "description": "Objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "Objects with date before the date",
+          "description": "Objects with date before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/order.json

@@ -21,7 +21,7 @@
       "type":"string"
     },
     "date":{
-      "description": "Date the order is issued. Automatically set when order is opened. Required for non-draft documents.",
+      "description": "Date the order is issued. Automatically set when order is opened. Required for non-draft documents. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -30,7 +30,7 @@
       "type":"integer"
     },
     "due_date":{
-      "description": "Auto-calculated from date + due days if empty and the document is opened.",
+      "description": "Auto-calculated from date + due days if empty and the document is opened. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -132,7 +132,7 @@
       "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.",
+      "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 line_items array is stronger for backward compat.",
       "type":"array",
       "default": "any",
       "minItems": 0,
@@ -211,13 +211,13 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "Objects with a date after the date",
+          "description": "Objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "Objects with date before the date",
+          "description": "Objects with date before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/payment.json

@@ -31,7 +31,7 @@
       "maxLength": 255
     },
     "date":{
-      "description": "Date the payment was made.",
+      "description": "Date the payment was made. YYYY-MM-DD",
       "required":true,
       "format":"date",
       "type":"string"
@@ -110,14 +110,14 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "All objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
 
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "All objects with date before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/payment_reminder.json

@@ -23,7 +23,7 @@
       "type":"string"
     },
     "date":{
-      "description": "Date the payment_reminder is issued. Automatically set when created from invoice. Defaults to today.",
+      "description": "Date the payment_reminder is issued. Automatically set when created from invoice. Defaults to today. YYYY-MM-DD",
       "format":"date",
       "required": true,
       "type":"string"
@@ -33,7 +33,7 @@
       "type":"integer"
     },
     "due_date":{
-      "description": "Auto-calculated from date + due days if empty and the payment_reminder is opened.",
+      "description": "Auto-calculated from date + due days if empty and the payment_reminder is opened. YYYY-MM-DD",
       "format":"date",
       "type":"string"
     },
@@ -193,13 +193,13 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "All objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "All objects with date before the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/json/v1.0/recurring.json

@@ -22,7 +22,7 @@
       "type":"string"
     },
     "date":{
-      "description": "First date the recurring is issued. Not allowed to be in the past.",
+      "description": "First date the recurring is issued. Not allowed to be in the past. YYYY-MM-DD",
       "format":"date",
       "type":"string",
       "required":true
@@ -32,7 +32,7 @@
       "type":"integer"
     },
     "final_date":{
-      "description": "The last date the recurring is executed.",
+      "description": "The last date the recurring is executed. YYYY-MM-DD",
       "format":"date",
       "type":"string",
       "required":true
@@ -119,7 +119,7 @@
       "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.",
+      "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 line_items array is stronger for backward compat.",
       "type":"array",
       "default": "any",
       "minItems": 0,
@@ -193,7 +193,7 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "Objects with a date after the date",
+          "description": "Objects with a date after the date. YYYY-MM-DD",
           "format" : "date",
           "type" : "string"
         },

data/lib/sk_api_schema/version.rb

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

metadata

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