sk_api_schema 0.0.5 → 0.0.6

data/README.rdoc

@@ -8,14 +8,20 @@ besides the schema. Other languages can take advantage of the raw json files.
 To get a fully working ruby client take a look at http://github.com/salesking/sk-api
 which will be replaced soon by a new gem at http://github.com/salesking/sk_api_activeresource
 
+== Notice:
 
-Notice: This gem is still evolving and will be used actively by salesking to deliver the api soon. 
-Atm the JSON files are the most interesting stuff in here.
+This gem is used actively by SalesKing to deliver it's api resources BUT commits
+and changes in here might not be directly reflected.
+The gem version does not reflect the api version. The version, for now, is keept
+in the folder-name and as long as there are no major changes(breaking backwards
+compatibility), the version number will remain.
+
+Especially within the next couple of weeks (until beginning of march) you will
+see some more resources made available. Links within each resource, will
+also be available but still need some cleanup.
 
 == Install
 
     gem install sk_api_schema
 
-== Usage
-
 Copyright (c) 2010 Georg Leciejewski, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/json/v1.0/client.json

@@ -134,6 +134,93 @@
       "description": "A client can have many addresses, sorted by date descending(new first). Default address is the most recent one.",
       "type":"array",
       "properties" : {"$ref":"./addresses.json#properties"}
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "clients/{id}"
+    },
+    { "rel": "instances",
+      "href": "clients",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in first, last_name, organisation, email, number",
+          "type":"string"
+        },
+        "filter[tags]":{
+          "title" : "Tags",
+          "description": "Filter by a space delimited list of tags",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['organisation', 'number','email','first_name','last_name', 'created_at', 'updated_at'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "clients/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "clients/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "clients",
+      "method": "POST"
+    },
+    { "rel": "attachments",
+      "href": "clients/{id}/attachments"
+    },
+    { "rel": "invoices",
+      "href": "clients/{id}/invoices"
+    },
+    { "rel": "estimates",
+      "href": "clients/{id}/estimates"
+    },
+    { "rel": "orders",
+      "href": "clients/{id}/orders"
+    },
+    { "rel": "credit_notes",
+      "href": "clients/{id}/credit_notes"
+    },
+    { "rel": "recurrings",
+      "href": "clients/{id}/recurrings"
+    },
+    { "rel": "payment_reminders",
+      "href": "clients/{id}/payment_reminders"
+    },
+    { "rel": "comments",
+      "href": "clients/{id}/comments"
+    },
+    { "rel": "emails",
+      "href": "clients/{id}/emails"
     }
-  }
+  ]
 }

data/json/v1.0/comment.json

@@ -0,0 +1,90 @@
+{ "type":"object",
+  "title": "comment",
+  "description":"An comment in SK must always be related to an object.",
+  "properties": {
+    "id": {
+      "description": "uuid of the adress.",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "text": {
+      "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,
+      "type":"string"
+    },
+    "related_object_id": {
+      "description": "uuid of the comments parent object.",
+      "required":true,
+      "type":"string"
+    },
+    "created_at": {
+      "description": "Date the object was created in SK. Never changes afterwards",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at": {
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    }
+  },
+   "links":[
+    { "rel": "self",
+      "href": "comments/{id}"
+    },
+    { "rel": "instances",
+      "href": "comments",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in text",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['created_at', 'updated_at'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "comments/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "comments/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "comments",
+      "method": "POST"
+    }
+  ]
+}

data/json/v1.0/credit_note.json

@@ -127,5 +127,85 @@
       "readonly":true,
       "type":"number"
     }
-  }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "credit_notes/{id}"
+    },
+    { "rel": "instances",
+      "href": "credit_notes",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in title, number, addressfield",
+          "type":"string"
+        },
+        "filter[tags]":{
+          "title" : "Tags",
+          "description": "Filter by a space delimited list of tags",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['title', 'number', 'created_at', 'updated_at', 'client_id', 'price_total', 'price_tax', 'date', 'due_date'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "credit_notes/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "credit_notes/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "credit_notes",
+      "method": "POST"
+    },
+    { "rel": "attachments",
+      "href": "credit_notes/{id}/attachments"
+    },
+    { "rel": "comments",
+      "href": "credit_notes/{id}/comments"
+    },
+    { "rel": "emails",
+      "href": "credit_notes/{id}/emails"
+    },
+    { "rel": "print",
+      "href": "credit_notes/{id}/print",
+      "method": "POST",
+      "properties" : {
+        "template_id" : {
+          "title" : "PDF template used for printing",
+          "description": "UUID of a pdf template used to print the document. MUST be present",
+          "required":true
+        },
+        "base64" : {
+          "title" : "Return the created pdf base64 encoded",
+          "description": "If set the new pdf is returned inside the attachment JSON within 'base64' key. Leave empty to save traffic."
+        }
+      }
+    }
+  ]
 }

data/json/v1.0/estimate.json

@@ -185,6 +185,12 @@
     { "rel": "attachments",
       "href": "estimates/{id}/attachments"
     },
+    { "rel": "comments",
+      "href": "estimates/{id}/comments"
+    },
+    { "rel": "emails",
+      "href": "estimates/{id}/emails"
+    },
     { "rel": "print",
       "href": "estimates/{id}/print",
       "method": "POST",

data/json/v1.0/invoice.json

@@ -200,6 +200,15 @@
     { "rel": "attachments",
       "href": "invoices/{id}/attachments"
     },
+    { "rel": "payment_reminders",
+      "href": "invoices/{id}/payment_reminders"
+    },
+    { "rel": "comments",
+      "href": "invoices/{id}/comments"
+    },
+    { "rel": "emails",
+      "href": "invoices/{id}/emails"
+    },
     { "rel": "print",
       "href": "invoices/{id}/print",
       "method": "POST",

data/json/v1.0/order.json

@@ -175,6 +175,12 @@
     { "rel": "attachments",
       "href": "orders/{id}/attachments"
     },
+    { "rel": "comments",
+      "href": "orders/{id}/comments"
+    },
+    { "rel": "emails",
+      "href": "orders/{id}/emails"
+    },
     { "rel": "print",
       "href": "orders/{id}/print",
       "method": "POST",

data/json/v1.0/payment.json

@@ -0,0 +1,90 @@
+{ "type":"object",
+  "title": "payment",
+  "description":"An payment in SK must always be related to an object.",
+  "properties": {
+    "id": {
+      "description": "uuid of the adress.",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "amount": {
+      "description": "The payment amount",
+      "required":true,
+      "type":"number"
+    },   
+    "external_ref":{
+      "description": "Reference number f.ex. issued by the bank.",
+      "format":"date",
+      "type":"string"
+    },
+    "date":{
+      "description": "Date the payment was made.",
+      "required":true,
+      "format":"date",
+      "type":"string"
+    },
+    "method":{
+      "description": "How the payment was made.",
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "type":"string"
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
+    "created_at": {
+      "description": "Date the object was created in SK. Never changes afterwards",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    }
+  },
+   "links":[
+    { "rel": "self",
+      "href": "payments/{id}"
+    },
+    { "rel": "instances",
+      "href": "payments",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in title, number, addressfield",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['amount','created_at', 'updated_at'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "payments/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "create",
+      "href": "payments",
+      "method": "POST"
+    }
+  ]
+}

data/json/v1.0/payment_reminder.json

@@ -1,6 +1,6 @@
 { "type":"object",
   "title": "payment_reminder",
-  "description": "An payment_reminder",
+  "description": "A payment reminder",
   "properties":{
     "id":{
       "description": "UUID assigned by SK",
@@ -8,17 +8,21 @@
       "readonly":true,
       "type":"string"
     },
+    "invoice_id":{
+      "description": "The invoice for the reminder. If set assumes all other fields are set to custom values, instead of filling them from the invoice. POSTing to invoices/:id/payment_reminders, automatically set this and all other fields.",
+      "type":"string"
+    },
     "address_field":{
-      "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.",
+      "description": "Receiver address, shown in envelope window. Defaults to invoice.client.address_field if created from invoice.",
       "type":"string"
     },
     "date":{
-      "description": "Date the payment_reminder is issued. Automatically set when payment_reminder is opened. Required for non-draft documents.",
+      "description": "Date the payment_reminder is issued. Automatically set when created from invoice. Defaults to today.",
       "format":"date",
       "type":"string"
     },
     "due_days":{
-      "description": "Used to calculate the due date of the payment_reminder. Useless if date and due date are present.",
+      "description": "Used to calculate the due date of the payment_reminder. Useless if date and due date are present. Taken from settings when created from invoice",
       "type":"integer"
     },
     "due_date":{
@@ -27,15 +31,15 @@
       "type":"string"
     },
     "title":{
-      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your payment_reminder [number]'",
+      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your payment_reminder [number]'. Defaults to values from settings",
       "type":"string"
     },
     "notes_before":{
-      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
+      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used. Defaults to values from settings",
       "type":"string"
     },
     "notes_after":{
-      "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
+      "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used. Defaults to values from settings",
       "type":"string"
     },
     "tag_list": {
@@ -62,15 +66,14 @@
     },
     "client_id":{
       "description": "The clients uuid. New payment_reminders take the clients address field, due days and cash discount if those fields are not set.",
-      "type":"string",
-      "required":true
+      "type":"string"
     },
     "team_id":{
-      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "description": "A team uuid. If set, only the team and its parent teams can see the record. Defaults to team id from invoice",
       "type":"string"
     },
     "line_items":{
-      "description": "Line items for the document",
+      "description": "Line items for the document. Defaults to invoice.gross_total and late fee values from settings",
       "type":"array",
       "properties":{"$ref":"./address.json#properties"}
     },
@@ -160,6 +163,9 @@
     { "rel": "attachments",
       "href": "payment_reminders/{id}/attachments"
     },
+    { "rel": "emails",
+      "href": "payment_reminders/{id}/emails"
+    },
     { "rel": "print",
       "href": "payment_reminders/{id}/print",
       "method": "POST",

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-01-16}
+  s.date = %q{2011-01-17}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -22,11 +22,13 @@ Gem::Specification.new do |s|
     "json/v1.0/address.json",
     "json/v1.0/attachment.json",
     "json/v1.0/client.json",
+    "json/v1.0/comment.json",
     "json/v1.0/credit_note.json",
     "json/v1.0/estimate.json",
     "json/v1.0/invoice.json",
     "json/v1.0/line_item.json",
     "json/v1.0/order.json",
+    "json/v1.0/payment.json",
     "json/v1.0/payment_reminder.json",
     "json/v1.0/product.json",
     "json/v1.0/user.json",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-16 00:00:00 +01:00
+date: 2011-01-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,11 +61,13 @@ files:
 - json/v1.0/address.json
 - json/v1.0/attachment.json
 - json/v1.0/client.json
+- json/v1.0/comment.json
 - json/v1.0/credit_note.json
 - json/v1.0/estimate.json
 - json/v1.0/invoice.json
 - json/v1.0/line_item.json
 - json/v1.0/order.json
+- json/v1.0/payment.json
 - json/v1.0/payment_reminder.json
 - json/v1.0/product.json
 - json/v1.0/user.json