sk_api_schema 0.10.6 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abde1b5b42fecd8924f6807b99891be589fd17a0
-  data.tar.gz: 397c6504cd713e94ced42ac68b45951fe9fdeea3
+  metadata.gz: 247a46ed65c67e561a7d45d0835084f1b992822e
+  data.tar.gz: 9232c88e6b95a53dda08d2a93b01fc6760120f93
 SHA512:
-  metadata.gz: 25bfc2130cb635266c2e9775797881bfb68c2b4e61c72babaab55405441507545746e3598a35c6f20dbf8b83a7d2b1639ada0e8281825f90b2804334f2131df2
-  data.tar.gz: e6e78e2f97eace77224d1f552155912ab29f7355338fe0502b5b0322c7f847a249f477a6b9de858902347ddd843bd0ea9b3471ed2f0f97ba785614dc283e972f
+  metadata.gz: 698ad34b2abf8280e66eb9f5773ac17136c2b682bf99b6a7a38841232316c90ad30b4b83136f66a3df04a8ff304592ed9a9757a13cf8d7c46e357331e35df208
+  data.tar.gz: 936f38495f7dc5afa7ea7fb606d618c85fda15c43e25bd500b49a97ab7868ecad3dcf5b7b3ebf20416bf5591c456cbc6e05a4a2cbf888e7680d31076d0e5d4bf

data/.travis.yml

@@ -1,5 +1,9 @@
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.2
 gemfile:
-  - Gemfile
+  - Gemfile
+
+# fix undefined spec error in ruby 1.9.3 due to outdated bundler
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 See [commit messages](https://github.com/salesking/sk_api_schema/commits/) for details.
 Also sign up to our [Developer Newsletter](http://www.salesking.eu/dev/newsletter/) to stay up-to-date!
 
+##2017-05
+
+* Product remove lock_version
+
 ##2015-10
 
 * Update description to clarify number field decimal places length

data/README.rdoc

@@ -163,4 +163,4 @@ course you can run them too. Install required gems with bundler and go for it:
 
 == ToDo:
 
-Copyright (c) 2010-2014 Georg Leciejewski, released under the MIT license
+Copyright (c) 2010-2016 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -2,17 +2,7 @@
 require 'bundler/gem_tasks'
 require 'rspec'
 require 'rspec/core/rake_task'
-require 'rdoc/task'
 
 desc "Run specs"
 RSpec::Core::RakeTask.new
 task :default => :spec
-
-desc 'Generate documentation.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SalesKing-Api JSON Schema'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/json/v1.0/account.json

@@ -46,6 +46,19 @@
       "type":"string",
       "maxLength": 30
     },
+    "billing_fee_name":{
+       "description": "Name for a billing fee line item. The item is added to the resulting document upon each account_billing creation, if billing_fee_price_single is set.",
+       "type":"string",
+       "maxLength": 255
+     },
+     "billing_fee_tax":{
+       "description": "Tax value for a billing fee line item. The item is added to the resulting document upon each account_billing creation.",
+       "type":"number"
+     },
+     "billing_fee_price_single":{
+       "description": "Price of a billing fee line item. This field serves as a trigger of whether to add the item. The item is added to the resulting document upon each account_billing creation.",
+       "type":"number"
+     },
     "hide_fields":{
       "description": "A list of account entry field names. The fields are hidden on account entry lists and forms so one can focus on the important inputs. For example hide: tax,description,billed_at",
       "type":"string",

data/json/v1.0/contact.json

@@ -186,7 +186,7 @@
       "type":"number"
     },
     "due_days":{
-      "description": "Default due days for new invoices.",
+      "description": "Default due days for new documents.",
       "type":"integer"
     },
     "address_field":{
@@ -235,6 +235,12 @@
       "description": "Product of the probability and sales potential. e.g how much of the sales_potential can we get?",
       "readonly":true,
       "type":"number"
+    },
+    "tax_exemption_id":{
+      "description": "ID of a tax exemption. New documents inherit the tax exemption and will be created without any taxes.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     }
   },
   "links":[

data/json/v1.0/credit_note.json

@@ -201,6 +201,12 @@
       "description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
       "readonly":true,
       "type":"number"
+    },
+    "tax_exemption_id":{
+      "description": "ID of a tax exemption. When set all item taxes are omitted.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     }
   },
   "links":[

data/json/v1.0/invoice.json

@@ -223,6 +223,12 @@
       "type":"string",
       "maxLength": 22,
       "minLength": 22
+    },
+    "tax_exemption_id":{
+      "description": "ID of a tax exemption. When set all item taxes are omitted.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     }
   },
   "links":[

data/json/v1.0/order.json

@@ -198,6 +198,12 @@
       "description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
       "readonly":true,
       "type":"number"
+    },
+    "tax_exemption_id":{
+      "description": "ID of a tax exemption. When set all item taxes are omitted.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     }
   },
   "links":[

data/json/v1.0/product.json

@@ -71,10 +71,6 @@
       "type":"string",
       "maxLength": 22,
       "minLength":22
-    },
-    "lock_version":{
-      "description": "Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.",
-      "type":"integer"
     }
   },
   "links":[

data/json/v1.0/recurring.json

@@ -211,6 +211,12 @@
       "default": null,
       "type": "string",
       "enum":["email"]
+    },
+    "tax_exemption_id":{
+      "description": "ID of a tax exemption. When set all item taxes are omitted.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     }
   },
   "links":[

data/json/v2.0/README.md

@@ -0,0 +1,28 @@
+# V2.0 SalesKing API Schema
+
+The new version is not live yet! We put it here so one can follow the changes.
+
+The following todo's are some of the things we are going to tackle.
+
+## TODO
+
+- [x] remove all deprecations
+- [x] move required attributes markup to top level object definition
+- [x] add schema validation to specs
+- [x] revise schema definitions for nested objects
+- [x] use anyOf definitions for nested line items
+- [x] add type to nested objects reflecting the class
+- [x] add company_id to all resources
+- [ ] revise filter methods
+- [ ] remove nested url's in favour of filter links instead e.g /emails?filter[contact_ids]=ID
+- [ ] change to/from filters to to_date/from_date
+- [ ] add /teams
+- [x] move collection info to header
+- [ ] define error object
+- ..
+
+## Server Side TODO
+
+- [ ] remove prefixed nesting
+- [ ] be more strict about validations e.g field length, strings vs number
+- [ ] remove links in returned objects

data/json/v2.0/account.json

@@ -1,12 +1,21 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "account",
-  "name": "account",
-  "description": "BETA An account to track times, expenses, projects, usages, etc. Those are single entry accounts, opposed to double entry accounting in bookkeeping accounts.",
+  "description": "An account to track times, expenses, projects, usages, etc. Those are single entry accounts, opposed to double entry accounting in bookkeeping accounts.",
+  "required": ["name"],
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -19,19 +28,17 @@
     "name":{
       "description": "The name of the account",
       "type":"string",
-      "required":true,
       "maxLength": 100
     },
     "description":{
       "description": "Account description",
       "type":"string",
-      "format":"text",
       "maxLength": 255
     },
     "balance":{
       "description": "The account balance is the sum of all entries, also those from sub-accounts.",
       "type":"number",
-      "readonly":true
+      "readOnly":true
     },
     "budget":{
       "description": "If an account is used to track budgetary things f.ex. projects, this fields can be used to perform calculations like: Are we still inside the allowed budget?",
@@ -46,11 +53,23 @@
       "type":"string",
       "maxLength": 30
     },
-    "hide_fields":{
-      "description": "A list of account entry field names. The fields are hidden on account entry lists and forms so one can focus on the important inputs. For example hide: tax,description,billed_at",
+    "default_tax":{
+      "description": "The default tax for new account entries, if tax is empty on create.",
+      "type":"number"
+    },
+    "billing_fee_name":{
+      "description": "Name for a billing fee line item. The item is added to the resulting document upon each account_billing creation, if billing_fee_price_single is set.",
       "type":"string",
       "maxLength": 255
     },
+    "billing_fee_tax":{
+      "description": "Tax value for a billing fee line item. The item is added to the resulting document upon each account_billing creation.",
+      "type":"number"
+    },
+    "billing_fee_price_single":{
+      "description": "Price of a billing fee line item. This field serves as a trigger of whether to add the item. The item is added to the resulting document upon each account_billing creation.",
+      "type":"number"
+    },
     "contact_id":{
       "description": "The contacts uuid to which the account is related.",
       "type":"string",
@@ -66,13 +85,13 @@
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Date the object was edited in SK.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "team_id":{
@@ -86,7 +105,7 @@
       "type":"string",
       "maxLength": 22,
       "minLength":22,
-      "readonly":true
+      "readOnly":true
     }
   },
   "links":[
@@ -161,12 +180,6 @@
     { "rel": "create",
       "href": "accounts",
       "method": "POST"
-    },
-    { "rel": "account_entries",
-      "href": "accounts/{id}/account_entries"
-    },
-    { "rel": "account_billings",
-      "href": "accounts/{id}/account_billings"
     }
   ]
 }

data/json/v2.0/account_billing.json

@@ -1,12 +1,21 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "account_billing",
-  "name": "account_billing",
   "description": "BETA An account billing serves as the glue between an account a document and their related account entries and line items. It also lets one keep track of who billed what and when. A billing is created from billable account entries, which are turned into line items for a document.",
+  "required": ["account_id"],
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -19,7 +28,6 @@
     "account_id":{
       "description": "The related account. Must be set for entries to be found.",
       "type":"string",
-      "required":true,
       "maxLength": 22,
       "minLength":22
     },
@@ -42,14 +50,14 @@
     "document_id":{
       "description": "The document created by the billing.",
       "type":"string",
-      "readonly": true,
+      "readOnly": true,
       "maxLength": 22,
       "minLength":22
     },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "team_id":{
@@ -63,7 +71,7 @@
       "type":"string",
       "maxLength": 22,
       "minLength":22,
-      "readonly":true
+      "readOnly":true
     }
   },
   "links":[

data/json/v2.0/account_entry.json

@@ -1,33 +1,41 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "account_entry",
-  "name": "account_entry",
   "description": "A entry for an account",
+  "required": ["account_id", "price_single"],
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "account_id":{
       "description":"Account the entry belongs to.",
-      "required":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "document_id":{
       "description":"Document the entry is related to. This relation is set by an account billing.",
-      "readonly":true,
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "item_id":{
       "description":"Line item on the document the entry is related to. This relation is set by an account billing or when a document is booked onto an account.",
-      "readonly":true,
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -40,16 +48,15 @@
     "description":{
       "description": "Entry description",
       "type":"string",
-      "format": "text"
+      "format": "string"
     },
     "price_single":{
       "description": "Net price of a single entry. If a product id is given, price_single is taken from the product if not set.",
-      "type":"number",
-      "required" : true
+      "type":"number"
     },
     "net_total":{
       "description": "Net price of a single entry. Calculated from price_single * quantity",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "tax":{
@@ -84,18 +91,14 @@
     "created_at":{
       "description": "Date the object was created. Never changes afterwards",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Date the object was edited.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
-    },
-    "_destroy":{
-      "description": "When set an existing entry will be deleted. This switch is used for entries passed during batch operations.",
-      "type":"boolean"
     }
   },
   "links":[