sk_api_schema 0.0.15 → 0.0.16

data/README.rdoc

@@ -13,13 +13,13 @@ http://dev.blog.salesking.eu/api/
 
 == Versioning
 
-The API-version, is kept in the folder-name and as long as there are no major
+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 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.
+before any live instances are updated and the schema becomes public available.
 
 You can get the current schema at your SalesKing api url:
   my.salesking.eu/api/schema
@@ -41,4 +41,4 @@ see bugfixes since more resources where made available.
 
     gem install sk_api_schema
 
-Copyright (c) 2010 Georg Leciejewski, released under the MIT license
+Copyright (c) 2010-2011 Georg Leciejewski, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.0.15
+0.0.16

data/json/v1.0/auth_permission.json

@@ -0,0 +1,61 @@
+{"type":"object",
+  "title": "auth_permission",
+  "description": "A Permission authorises someone to execute actions(grants privileges) in the scope of a context. The context is a resource f.ex: clients, and the privileges a group of actions like: index, show, edit, update. A permission to read invoices has the context: invoices and as privileges: index,show.",
+  "properties": {
+    "id": {
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "full_name": {
+      "description": "Context_name and name localized: API Clients read - API Kunden anzeigen",
+      "type":"string"
+    },
+    "name": {
+      "description": "Name for the permission. Since a permission groups multiple privileges the name reflects what someone is allowed to do: read, update, delete. With 'read' granting acccess to the 'index' and 'show' actions of a resource.",
+      "type":"string"
+    },
+    "context_name":{
+      "description": "The context for the permission, beeing a resource: clients, emails",
+      "readonly":true,
+      "type":"string"
+    },
+    "privilege_list": {
+      "description": "A permission has many privileges which define the actions someone can execute. Such actions are resource methods like index, update, edit, show",
+      "type":"string",
+      "readonly":true
+    }
+  },
+
+  "links":[
+    { "rel": "instances",
+      "href": "auth_permissions",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in name and context names",
+          "type":"string"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":["auth_permission.name", "auth_context.name"],
+          "type": "string"
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "self",
+      "href": "auth_permissions/{id}"
+    }
+  ]
+}

data/json/v1.0/client.json

@@ -75,7 +75,7 @@
     },    
     "payment_method":{
       "description": "Default payment method for used for new documemts",
-      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
     "bank_name": {
@@ -178,8 +178,8 @@
         "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'
+          "enum":["organisation", "number","email","first_name","last_name", "created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/comment.json

@@ -68,8 +68,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/credit_note.json

@@ -42,7 +42,7 @@
     },
     "payment_method":{
       "description": "How the document is beeing payed. Used in new payments.",
-      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
     "title":{
@@ -177,8 +177,8 @@
         "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'
+          "enum":["title", "number", "created_at", "updated_at", "client_id", "price_total", "price_tax", "date", "due_date"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",
@@ -206,7 +206,7 @@
         "cancel" : {
           "title" : "Cancel an credit note",
           "description": "Cancelling a document negates its line item values. A source id must be set.",
-          "dependencies": ['source']
+          "dependencies": ["source"]
         }
       }
     },

data/json/v1.0/email.json

@@ -120,8 +120,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/email_template.json

@@ -26,7 +26,7 @@
     "kind": {
       "description": "Kind of object receiving the email.",
       "required":true,
-      "enum": ['invoice', 'estimate', 'credit_note', 'payment_reminder', 'order', 'client'],
+      "enum": ["invoice", "estimate", "credit_note", "payment_reminder", "order", "client"],
       "type":"string"
     },
     "created_at": {
@@ -61,8 +61,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/estimate.json

@@ -163,8 +163,8 @@
         "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'
+          "enum":["title", "number", "created_at", "updated_at", "client_id", "price_total", "price_tax", "date", "due_date"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/export.json

@@ -20,7 +20,7 @@
     "kind": {
       "description": "The export type. text: uses an export template defined by a template_id. archived_pdf: zip with archived PDF(documents only). allinone_pdf: All archived PDF(Documents) in one big PDF. attachments: All attachments of the given objects as zip. dtaus: German bank format, relies on valid bank information in your company and for each client of the exported documents. dtaus_lk Lastschrift. dtaus_gk: Gutschrift.",
       "required":true,
-      "enum": ['text', 'archived_pdf', 'attachments', 'dtaus_lk', 'dtaus_gk', 'allinone_pdf'],
+      "enum": ["text", "archived_pdf", "attachments", "dtaus_lk", "dtaus_gk", "allinone_pdf"],
       "type":"string"
     },
     "template_id":{
@@ -34,7 +34,7 @@
     "status": {
       "description": "The export status",
       "readonly":true,
-      "enum": ['pending', 'in_progress', 'failed', 'success'],
+      "enum": ["pending", "in_progress", "failed", "success"],
       "type":"string"
     },
     "log": {
@@ -97,8 +97,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/export_template.json

@@ -21,7 +21,7 @@
     "kind": {
       "description": "Kind of exported data.",
       "required":true,
-      "enum": ['invoice', 'estimate', 'credit_note', 'payment_reminder', 'order', 'client', 'payment', 'comment', 'email', 'history', 'product','recurring'],
+      "enum": ["invoice", "estimate", "credit_note", "payment_reminder", "order", "client", "payment", "comment", "email", "history", "product","recurring"],
       "type":"string"
     },
     "filename": {
@@ -60,8 +60,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/invoice.json

@@ -42,7 +42,7 @@
     },
     "payment_method":{
       "description": "How the invoce is beeing payed. Used in new payments.",
-      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
     "title":{
@@ -178,8 +178,8 @@
         "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'
+          "enum":["title", "number", "created_at", "updated_at", "client_id", "price_total", "price_tax", "date", "due_date"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",
@@ -207,7 +207,7 @@
         "cancel" : {
           "title" : "Cancel an invoice",
           "description": "Cancelling a document negates its line item values. A source id must be set.",
-          "dependencies": ['source']
+          "dependencies": ["source"]
         }
       }
     },

data/json/v1.0/order.json

@@ -153,8 +153,8 @@
         "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'
+          "enum":["title", "number", "created_at", "updated_at", "client_id", "price_total", "price_tax", "date", "due_date"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/payment.json

@@ -25,7 +25,7 @@
     },
     "method":{
       "description": "How the payment was made.",
-      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
     "related_object_type": {
@@ -77,8 +77,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['amount','created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["amount","created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",
@@ -98,7 +98,7 @@
         "new_doc_status":{
           "title" : "New status for document",
           "description": "Convinience method to close a document with a payment.",
-          "enum": ['open','closed'],
+          "enum": ["open","closed"],
           "type":"string"
         }
       }

data/json/v1.0/payment_reminder.json

@@ -143,8 +143,8 @@
         "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'
+          "enum":["title", "number", "created_at", "updated_at", "client_id", "price_total", "price_tax", "date", "due_date"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/product.json

@@ -74,8 +74,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['name','number','price', 'created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["name","number","price", "created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/json/v1.0/recurring.json

@@ -35,13 +35,13 @@
     },
     "frequency":{
       "description": "Recurring frequency",
-      "enum":['yearly', 'monthly', 'weekly', 'quarterly', 'biweekly', 'sixmonthly'],
+      "enum":["yearly", "monthly", "weekly", "quarterly", "biweekly", "sixmonthly"],
       "type":"string",
       "required":true
     },
     "payment_method":{
       "description": "How the invoce is beeing payed. Used in new payments.",
-      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
     "external_ref":{
@@ -165,8 +165,8 @@
         "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'],
-          "type": 'string'
+          "enum":["title", "number", "created_at", "updated_at", "client_id", "price_total"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",
@@ -194,7 +194,7 @@
         "cancel" : {
           "title" : "Cancel an recurring",
           "description": "Cancelling a document negates its line item values. A source id must be set.",
-          "dependencies": ['source']
+          "dependencies": ["source"]
         }
       }
     },

data/json/v1.0/text_template.json

@@ -14,14 +14,14 @@
       "type":"string"
     },
     "text": {
-      "description": "Subject containing placeholders, replaced when the template is used.",
+      "description": "Text which may contain placeholders, replaced when the template is used.",
       "required":true,
       "type":"string"
     },   
     "kind": {
       "description": "Kind of object in which the text is used. If empty the snippet can be used globally, but watch those placeholder.",
       "required":true,
-      "enum": ['','invoice', 'estimate', 'credit_note', 'payment_reminder', 'order', 'client', 'email'],
+      "enum": ["","invoice", "estimate", "credit_note", "payment_reminder", "order", "client", "email"],
       "type":"string"
     },
     "created_at": {
@@ -56,8 +56,8 @@
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
-          "enum":['created_at', 'updated_at'],
-          "type": 'string'
+          "enum":["created_at", "updated_at"],
+          "type": "string"
         },
         "sort":{
           "title" : "Sort",

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.15"
+  s.version = "0.0.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-02-03}
+  s.date = %q{2011-02-14}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "json/v1.0/address.json",
     "json/v1.0/attachment.json",
+    "json/v1.0/auth_permission.json",
     "json/v1.0/client.json",
     "json/v1.0/comment.json",
     "json/v1.0/company.json",
@@ -46,7 +47,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/salesking/sk_api_schema}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.1}
+  s.rubygems_version = %q{1.5.2}
   s.summary = %q{SalesKing API JSON Schema}
   s.test_files = [
     "spec/sk_api_schema_spec.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: 
   segments: 
   - 0
   - 0
-  - 15
-  version: 0.0.15
+  - 16
+  version: 0.0.16
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 +01:00
+date: 2011-02-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - VERSION
 - json/v1.0/address.json
 - json/v1.0/attachment.json
+- json/v1.0/auth_permission.json
 - json/v1.0/client.json
 - json/v1.0/comment.json
 - json/v1.0/company.json
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: SalesKing API JSON Schema