sk_api_schema 0.0.7 → 0.0.8

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/json/v1.0/attachment.json

@@ -48,6 +48,10 @@
       "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"
     }
     
   }

data/json/v1.0/comment.json

@@ -34,6 +34,10 @@
       "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"
     }
   },
    "links":[

data/json/v1.0/email.json

@@ -74,6 +74,10 @@
       "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"
     }
   },
    "links":[

data/json/v1.0/export.json

@@ -0,0 +1,125 @@
+{ "type":"object",
+  "title": "export",
+  "description":"An export in SK",
+  "properties": {
+    "id": {
+      "description": "uuid of the export",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "collection_type": {
+      "description": "The type of data to export. Lower-case plural name of the export data's class",
+      "required":true,
+      "enum": ['text', 'archived_pdf', 'attachments', 'dtaus_lk', 'dtaus_gk', 'allinone_pdf'],
+      "type":"string"
+    },
+    "collection_ids": {
+      "description": "Comma separated uuid's of the export objects. The backend uses a mysql text-column limited to ~64kb. 100 uuids are ~2.5kb",
+      "required":true,
+      "type":"string"
+    },
+    "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'],
+      "type":"string"
+    },
+    "template_id":{
+      "description": "A export template uuid. Only needed for text exports.",
+      "type":"string"
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
+    "status": {
+      "description": "The export status",
+      "readonly":true,
+      "enum": ['pending', 'in_progress', 'failed', 'success'],
+      "type":"string"
+    },
+    "log": {
+      "description": "Errors and warnings, can contain html markup f.ex. links to clients with invalid back accounts when doing dtaus export",
+      "readonly":true,
+      "type":"string"
+    },
+    "attachments":{
+      "description": "The exported data as attachment.",
+      "readonly":true,
+      "type":"array",
+      "properties":{"$ref":"./attachment.json#properties"}
+    },
+    "started_at": {
+      "description": "Date the was started",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "finished_at": {
+      "description": "Date the was finished",
+      "format":"date-time",
+      "readonly":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": "exports/{id}"
+    },
+    { "rel": "instances",
+      "href": "exports",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+       
+        "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": "exports/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "exports/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "exports",
+      "method": "POST"
+    }
+  ]
+}

data/json/v1.0/product.json

@@ -9,7 +9,7 @@
       "type":"string"
     },
     "number":{
-      "description": "Unique number assigned by you or if emtpy SK product number schema.",
+      "description": "Unique number assigned by you or if empty SK product number schema.",
       "type":"string"
     },
     "name":{
@@ -44,6 +44,10 @@
       "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"
     }
   }
 }

data/lib/sk_api_schema.rb

@@ -38,8 +38,9 @@ module SK
           schemas
         end
 
-        # Create a Hash with the available (api)object attributes defined in
-        # schema properties.
+        # Create a Hash with the available (api)object attributes defined in the
+        # according schema properties. This is the meat of the object-to-api
+        # workflow
         #
         # === Example
         #  obj = Invoice.new(:title =>'hello world', :number=>'4711')

data/sk_api_schema.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "json/v1.0/credit_note.json",
     "json/v1.0/email.json",
     "json/v1.0/estimate.json",
+    "json/v1.0/export.json",
     "json/v1.0/invoice.json",
     "json/v1.0/line_item.json",
     "json/v1.0/order.json",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -65,6 +65,7 @@ files:
 - json/v1.0/credit_note.json
 - json/v1.0/email.json
 - json/v1.0/estimate.json
+- json/v1.0/export.json
 - json/v1.0/invoice.json
 - json/v1.0/line_item.json
 - json/v1.0/order.json