sk_api_schema 0.4.3 → 0.5.0

data/CHANGELOG.rdoc

@@ -2,6 +2,12 @@
 
 A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
 
+2012-11
+
+  * add currency fields for documents, client, company and payment
+  * add PDF template resource
+  * drop 'method' from payment in favour of payment_method
+
 2012-07
 * maxLength for all string properties with limits
 * add "format":"text" to plain-text fields

data/json/v1.0/client.json

@@ -96,6 +96,12 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard(3-letter UPCASE: EUR, USD). If set the currency is taken for new documents.",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
     "payment_method":{
       "description": "Default payment method for used for new documemts",
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],

data/json/v1.0/company.json

@@ -20,6 +20,12 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
     "sub_domain":{
       "description": "Unique subdomain identifying the company's SalesKing account.",
       "type":"string",

data/json/v1.0/credit_note.json

@@ -73,6 +73,22 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
+    "exchange_rate":{
+      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). 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).",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total_exchanged":{
+      "description": "The exchanged gross total.",
+      "readonly":true,
+      "type":"number"
+    },
     "archived_pdf":{
       "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
       "readonly":true,

data/json/v1.0/document.json

@@ -1,6 +1,6 @@
 { "type":"object",
   "title": "document",
-  "description": "This resource is readonly and serves as a convenient way to query documents independent of their type(invoice, order,..). The specific document type is set in each object in the result-set.",
+  "description": "This resource is readonly and serves as a convenient way to query documents independent of their type(invoice, order,..). The specific document type is set in each object in the result-set. Internally Document is the base class for all types and special fields are defined in each child-class. Due to this some fields might be missing if you are using this meta-class in queries.",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
@@ -11,7 +11,7 @@
       "minLength": 22
     },
     "object_type":{
-      "description": "The specific type of the document",
+      "description": "The specific type of the document singular CamelCased: Invoice, PaymentReminder",
       "type":"string"
     },
     "number":{
@@ -99,7 +99,29 @@
       "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
+    },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard. 3-letter UPCASE: EUR, USD",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
+    "exchange_rate":{
+      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). 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).",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total_exchanged":{
+      "description": "The exchanged gross total.",
+      "readonly":true,
+      "type":"number"
+    },
+    "language":{
+      "description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
+      "type":"string",
+      "maxLength": 10
     }
+
   },
   "links":[
     { "rel": "self",

data/json/v1.0/email_template.json

@@ -29,7 +29,7 @@
       "format":"text"
     },
     "kind":{
-      "description": "Kind of object receiving the email.",
+      "description": "Kind of object the template can be used for.",
       "required":true,
       "enum": ["invoice", "estimate", "credit_note", "payment_reminder", "order", "client"],
       "type":"string"

data/json/v1.0/estimate.json

@@ -68,6 +68,22 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
+    "exchange_rate":{
+      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). 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).",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total_exchanged":{
+      "description": "The exchanged gross total.",
+      "readonly":true,
+      "type":"number"
+    },
     "archived_pdf":{
       "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
       "readonly":true,

data/json/v1.0/export_template.json

@@ -23,7 +23,7 @@
       "format":"text"
     },
     "kind":{
-      "description": "Kind of exported data.",
+      "description": "Kind of object the template can be used for.",
       "required":true,
       "enum": ["invoice", "estimate", "credit_note", "payment_reminder", "order", "client", "payment", "comment", "email", "history", "product","recurring"],
       "type":"string"

data/json/v1.0/invoice.json

@@ -73,6 +73,22 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
+    "exchange_rate":{
+      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). 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).",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total_exchanged":{
+      "description": "The exchanged gross total.",
+      "readonly":true,
+      "type":"number"
+    },
     "archived_pdf":{
       "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
       "readonly":true,

data/json/v1.0/order.json

@@ -73,6 +73,22 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
+    "exchange_rate":{
+      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). 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).",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total_exchanged":{
+      "description": "The exchanged gross total.",
+      "readonly":true,
+      "type":"number"
+    },
     "archived_pdf":{
       "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
       "readonly":true,

data/json/v1.0/payment.json

@@ -26,8 +26,21 @@
       "format":"date",
       "type":"string"
     },
-    "method":{
-      "description": "DEPRECATED use payment_method. Kicked at beginning of 08.2012"
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
+    "exchange_rate":{
+      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). 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).",
+      "readonly":true,
+      "type":"number"
+    },
+    "amount_exchanged":{
+      "description": "The exchanged amount.",
+      "readonly":true,
+      "type":"number"
     },
     "payment_method":{
       "description": "How the payment was made.",

data/json/v1.0/payment_reminder.json

@@ -65,6 +65,22 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
+    "exchange_rate":{
+      "description": "The exchange rate from the company currency(eg. EUR) to the document currency(USD). 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).",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total_exchanged":{
+      "description": "The exchanged gross total.",
+      "readonly":true,
+      "type":"number"
+    },
     "archived_pdf":{
       "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
       "readonly":true,

data/json/v1.0/pdf_template.json

@@ -0,0 +1,96 @@
+{ "type":"object",
+  "title": "pdf_template",
+  "description":"An PDF template. For now this is a read-only resource ONLY returning your own templates. It fits the most important use-case: A user can select a print template.",
+  "properties":{
+    "id":{
+      "description":"Unique identifier - UUID",
+      "identity":true,
+      "readonly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "name":{
+      "description": "Name of the template as shown to the user.",
+      "required":true,
+      "type":"string",
+      "maxLength": 50
+    },
+    "description":{
+      "description": "Additional information about the template.",
+      "type":"string",
+      "format":"text"
+    },
+    "kind":{
+      "description": "Kind of object the template can be used for.",
+      "required":true,
+      "enum": ["invoice", "estimate", "credit_note", "payment_reminder", "order"],
+      "type":"string"
+    },
+    "language":{
+      "description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. A multi-language template should belong to a parent. From then on just choose the parent-template and the localized child version is used for printing if the related object(order, invoice,..) has the appropriate language.",
+      "type":"string",
+      "maxLength": 10
+    },
+    "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"
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    }
+  },
+   "links":[
+    { "rel": "self",
+      "href": "pdf_templates/{id}"
+    },
+    { "rel": "instances",
+      "href": "pdf_templates",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "per_page":{
+          "title" : "Per page",
+          "description": "Results per page. Default is 10, max is 100",
+          "type":"number"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field",
+          "default":"name",
+          "enum":["created_at", "updated_at", "name", "kind"],
+          "type": "string"
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        },
+        "filter[q]":{
+          "title" : "Search wildcard",
+          "description": "Searches in name, description",
+          "type":"string"
+        },
+        "filter[kind]":{
+          "title" : "Search by kind",
+          "description": "Kind of object this template can be used for: invoice, order",
+          "type":"string"
+        }
+      }
+    }
+  ]
+}

data/json/v1.0/recurring.json

@@ -76,6 +76,12 @@
       "type":"string",
       "maxLength": 10
     },
+    "currency":{
+      "description": "Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)",
+      "type":"string",
+      "maxLength": 3,
+      "minLength": 3
+    },
     "client":{
       "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
       "readonly":true,

data/json/v1.0/text_template.json

@@ -23,7 +23,7 @@
       "format":"text"
     },
     "kind":{
-      "description": "Kind of object in which the text is used. If empty the snippet can be used global, but watch the available placeholders.",
+      "description": "Kind of object the template can be used for. If empty the snippet can be used global. In this case watch not all placeholders are available: a client has different fields than an invoice.",
       "required":true,
       "enum": ["","invoice", "estimate", "credit_note", "payment_reminder", "order", "client", "email"],
       "type":"string"

data/lib/sk_api_schema/version.rb

@@ -1,7 +1,7 @@
 module SK
   module Api
     class Schema
-      VERSION='0.4.3'
+      VERSION='0.5.0'
     end
   end
 end

data/sk_api_schema.gemspec

@@ -6,20 +6,20 @@ Gem::Specification.new do |s|
   s.version = SK::Api::Schema::VERSION
   s.date = %q{2012-07-27}
   s.name = %q{sk_api_schema}
-  s.summary = "SalesKing API - JSON Schema"
+  s.summary = 'SalesKing API - JSON Schema'
   s.description = %q{The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects.
 Besides ruby users can use a small lib with utility methods to load and test the schema files.}
-  s.authors = ["Georg Leciejewski"]
+  s.authors = ['Georg Leciejewski']
   s.email = %q{gl@salesking.eu}
   s.homepage = %q{http://github.com/salesking/sk_api_schema}
-  s.extra_rdoc_files = ["README.rdoc"]
+  s.extra_rdoc_files = ['README.rdoc']
   s.executables   = nil
   s.files         = `git ls-files`.split("\n").reject{|i| i[/^docs\//] }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.require_paths = ['lib']
+  s.rubygems_version = '1.8.24'
 
   s.add_runtime_dependency 'activesupport'
   s.add_development_dependency 'rdoc'

metadata

@@ -1,105 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sk_api_schema
-version: !ruby/object:Gem::Version 
-  hash: 9
+version: !ruby/object:Gem::Version
+  version: 0.5.0
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 3
-  version: 0.4.3
 platform: ruby
-authors: 
+authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id001
-  prerelease: false
+date: 2012-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rdoc
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id004
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: simplecov
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.2
-  version_requirements: *id005
+  type: :development
   prerelease: false
-  name: rake
-description: |-
-  The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects.
-  Besides ruby users can use a small lib with utility methods to load and test the schema files.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: ! 'The SalesKing JSON Schema describes our business API in terms of available
+  objects, their fields and links to url endpoints with related objects.
+
+  Besides ruby users can use a small lib with utility methods to load and test the
+  schema files.'
 email: gl@salesking.eu
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.rdoc
@@ -125,6 +127,7 @@ files:
 - json/v1.0/order.json
 - json/v1.0/payment.json
 - json/v1.0/payment_reminder.json
+- json/v1.0/pdf_template.json
 - json/v1.0/product.json
 - json/v1.0/recurring.json
 - json/v1.0/sub.json
@@ -138,36 +141,29 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/salesking/sk_api_schema
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 4021308870819249197
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SalesKing API - JSON Schema
 test_files: []
-