sk_api_schema 0.2.4 → 0.2.5

data/CHANGELOG.rdoc

@@ -2,6 +2,10 @@
 
 A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
 
+2011-10
+* added created_at search filter to clients and documents
+* added creator(user) search filter to clients and documents
+
 2011-9
 * search documents by number
 * maxLength information for client and address properties

data/README.rdoc

@@ -1,11 +1,20 @@
 = SalesKing API Schema
 
-Our API definition is using JSON Schema(http://json-schema.org/). A schema
-describes a resource in terms of available fields, CRUD actions and
-relationships with other resources.
+Our API is described with JSON Schema's (http://json-schema.org). A schema
+describes a resource(object) in a readable JSON format:
+
+  { 
+    "title": "client",
+    "properties": { ...},
+    "links": [ .. ]    
+  }
+The properties-section defines the fields. CRUD actions and
+relationships with other resources are found in the link-section.
+
+Look into the /json/ folder for the resources schema-files - https://github.com/salesking/sk_api_schema/tree/master/json/v1.0
 
 For ruby pirates this project is available as gem. It provides some utility
-functions to read the schema files and convert objects to their schema notation.
+methods to read the schema files and convert objects to their schema notation.
 See {/lib/sk_api_schema.rb}[https://github.com/salesking/sk_api_schema/blob/master/lib/sk_api_schema.rb]
 
 Other languages should take advantage of the raw json files.
@@ -48,14 +57,14 @@ parameter:
 
 Please try to only request the fields you really need, to save computing power!
 
-== Object Structure
+== Object Structure Basic's
 
-The primary object types in SK are:
+Primary object types in SK are:
 * Documents
 * Contacts
 * Products
 
-Secondary objects cannot exist without a primary(related) object
+Secondary objects are always tied to a primary(related) object
 * Attachments
 * Comments
 * Messages
@@ -67,6 +76,8 @@ The third kind are supportive objects
 * Exports
 * Templates
 
+== Enpoints & Links
+
 Following list gives you a quick overview of relations with nested urls an how
 parameters work. You can find those in detail when looking at the link section
 of each schema.

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/json/v1.0/client.json

@@ -199,14 +199,29 @@
         },
         "filter[created_at_from]":{
           "title" : "From date",
-          "description": "All objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
           "type" : "date-time"
         },
         "filter[created_at_to]":{
           "title" : "To date",
-          "description": "All objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
           "type" : "date-time"
         },
+        "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.",
+          "type" : "date"
+        },
+        "filter[birthday_to]":{
+          "title" : "To birthday date",
+          "description": "Contacts with a birthday date before and on the date.",
+          "type" : "date"
+        },
+        "filter[creator_ids]":{
+          "title" : "Creator",
+          "description": "Objects created by the given users uuids, comma separated",
+          "type" : "string"
+        },
         "filter[number]":{
           "title" : "By number",
           "description": "Search by number where the number is matched from the start: %number",

data/json/v1.0/credit_note.json

@@ -183,14 +183,24 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "Objects with a date on and after the date",
           "type" :"date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "Objects with date before and on the date",
           "type" :"date"
         },
+        "filter[created_at_from]":{
+          "title" : "From date",
+          "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
+        "filter[created_at_to]":{
+          "title" : "To date",
+          "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
         "filter[languages]":{
           "title" : "Languages",
           "description": "A list of language codes, comma separated",
@@ -206,6 +216,11 @@
           "description": "A single or a list of document uuids, comma separated",
           "type" : "string"
         },
+        "filter[creator_ids]":{
+          "title" : "Creator",
+          "description": "Objects created by the given users uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/document.json

@@ -137,14 +137,24 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "Objects with a date after the date",
           "type" : "date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "Objects with date before the date",
           "type" : "date"
         },
+        "filter[created_at_from]":{
+          "title" : "From date",
+          "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
+        "filter[created_at_to]":{
+          "title" : "To date",
+          "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
         "filter[languages]":{
           "title" : "Languages",
           "description": "A list of language codes, comma separated",
@@ -160,6 +170,11 @@
           "description": "A single or a list of document uuids, comma separated",
           "type" : "string"
         },
+        "filter[creator_ids]":{
+          "title" : "Creator",
+          "description": "Objects created by the given users uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/estimate.json

@@ -168,14 +168,24 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "Objects with a date after the date",
           "type" : "date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "Objects with date before the date",
           "type" : "date"
         },
+        "filter[created_at_from]":{
+          "title" : "From date",
+          "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
+        "filter[created_at_to]":{
+          "title" : "To date",
+          "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
         "filter[languages]":{
           "title" : "Languages",
           "description": "A list of language codes, comma separated",
@@ -191,6 +201,11 @@
           "description": "A single or a list of document uuids, comma separated",
           "type" : "string"
         },
+        "filter[creator_ids]":{
+          "title" : "Creator",
+          "description": "Objects created by the given users uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/invoice.json

@@ -183,12 +183,12 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "Objects with a date after the date",
           "type" : "date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "Objects with date before the date",
           "type" : "date"
         },
         "filter[languages]":{
@@ -206,6 +206,11 @@
           "description": "A single or a list of document uuids, comma separated",
           "type" : "string"
         },
+        "filter[creator_ids]":{
+          "title" : "Creator",
+          "description": "Objects created by the given users uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/order.json

@@ -159,14 +159,24 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "Objects with a date after the date",
           "type" : "date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "Objects with date before the date",
           "type" : "date"
         },
+        "filter[created_at_from]":{
+          "title" : "From date",
+          "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
+        "filter[created_at_to]":{
+          "title" : "To date",
+          "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
         "filter[languages]":{
           "title" : "Languages",
           "description": "A list of language codes, comma separated",
@@ -182,6 +192,11 @@
           "description": "A single or a list of document uuids, comma separated",
           "type" : "string"
         },
+        "filter[creator_ids]":{
+          "title" : "Creator",
+          "description": "Objects created by the given users uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/recurring.json

@@ -165,14 +165,24 @@
         },
         "filter[from]":{
           "title" : "From date",
-          "description": "All objects with a date after the date",
+          "description": "Objects with a date after the date",
           "type" : "date"
         },
         "filter[to]":{
           "title" : "To date",
-          "description": "All objects with date before the date",
+          "description": "Objects with date before the date",
           "type" : "date"
         },
+        "filter[created_at_from]":{
+          "title" : "From date",
+          "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
+        "filter[created_at_to]":{
+          "title" : "To date",
+          "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+          "type" : "date-time"
+        },
         "filter[languages]":{
           "title" : "Languages",
           "description": "A list of language codes, comma separated",
@@ -188,6 +198,11 @@
           "description": "A single or a list of document uuids, comma separated",
           "type" : "string"
         },
+        "filter[creator_ids]":{
+          "title" : "Creator",
+          "description": "Objects created by the given users uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/lib/sk_api_schema.rb

@@ -124,7 +124,7 @@ module SK
                 data[field] = to_hash_from_schema(rel_obj, version)
               end
             else # a simple field is only added if the object knows it
-              data[field] = obj.send(field) if obj.respond_to?(field.to_sym)
+              data[field] = obj.send(field) if obj.respond_to?(field)
             end
           end
           hsh = { "#{class_name}" => data }

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-10-03}
+  s.date = %q{2011-10-29}
   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 smal lib with utility methods to load and test the schema files.}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 +02:00
+date: 2011-10-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency