sk_api_schema 0.6.1 → 0.7.0

data/json/v1.0/payment_reminder.json

@@ -88,14 +88,27 @@
       "type":"object",
       "properties":{"$ref":"./attachment.json#properties"}
     },
-    "client":{
-      "description": "The client for the document. Is assigned throught the related invoice",
+   "client":{
+      "description": "DEPRECATED: use contact",
       "readonly":true,
       "type":"object",
       "properties":{"$ref":"./client.json#properties"}
     },
     "client_id":{
-      "description": "The clients uuid. Is assigned throught the related invoice.",
+      "description": "DEPRECATED: use contact_id",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "contact":{
+      "description": "The contact for the document. Is assigned through the related invoice.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./contact.json#properties"}
+    },
+    "contact_id":{
+      "description": "The contact uuid. Is assigned through the related invoice.",
+      "readonly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -184,7 +197,12 @@
         },
         "filter[client_ids]":{
           "title" : "Clients",
-          "description": "A single or a list of client uuids, comma separated",
+          "description": "DEPRECATED use contact_ids",
+          "type" : "string"
+        },
+        "filter[contact_ids]":{
+          "title" : "Contacts",
+          "description": "A single or a list of contact uuids, comma separated",
           "type" : "string"
         },
         "filter[ids]":{
@@ -195,13 +213,14 @@
         "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"],
+          "enum":["title", "number", "created_at", "updated_at", "price_total", "price_tax", "date", "due_date"],
           "type": "string"
         },
         "sort":{
           "title" : "Sort",
           "enum":["ASC","DESC"],
-          "description": "Sort the results in ASC or DESC"
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
         }
       }
     },

data/json/v1.0/pdf_template.json

@@ -78,8 +78,9 @@
         },
         "sort":{
           "title" : "Sort",
-          "enum":["ASC","DESC"],
-          "description": "Sort the results in ASC or DESC"
+          "description": "Sort the results in ASC or DESC",
+          "type":"string",
+          "enum":["ASC","DESC"]
         },
         "filter[q]":{
           "title" : "Search wildcard",
@@ -88,8 +89,9 @@
         },
         "filter[kind]":{
           "title" : "Search by kind",
-          "description": "Kind of object this template can be used for: invoice, credit_note (singular lowercase classname)",
-          "type":"string"
+          "description": "Kind of object this template can be used for: invoice, order",
+          "type":"string",
+          "enum":["invoice","estimate", "credit_note", "payment_reminder", "order"]
         }
       }
     }

data/json/v1.0/product.json

@@ -109,7 +109,8 @@
         "sort":{
           "title" : "Sort",
           "enum":["ASC","DESC"],
-          "description": "Sort the results in ASC or DESC"
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
         }
       }
     },

data/json/v1.0/recurring.json

@@ -84,13 +84,25 @@
       "minLength": 3
     },
     "client":{
-      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "description": "DEPRECATED: use contact",
       "readonly":true,
       "type":"object",
       "properties":{"$ref":"./client.json#properties"}
     },
     "client_id":{
-      "description": "The clients uuid. If a new client is assigned its language, address field, due days and cash discount are used if those fields are not set.",
+      "description": "DEPRECATED: use contact_id",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "contact":{
+      "description": "The contact for the document. Use contact_id field to set a contact.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./contact.json#properties"}
+    },
+    "contact_id":{
+      "description": "The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.",
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -201,7 +213,12 @@
         },
         "filter[client_ids]":{
           "title" : "Clients",
-          "description": "A single or a list of client uuids, comma separated",
+          "description": "DEPRECATED use contact_ids",
+          "type" : "string"
+        },
+        "filter[contact_ids]":{
+          "title" : "Contacts",
+          "description": "A single or a list of contact uuids, comma separated",
           "type" : "string"
         },
         "filter[ids]":{
@@ -217,13 +234,14 @@
         "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"],
+          "enum":["title", "number", "created_at", "updated_at", "price_total"],
           "type": "string"
         },
         "sort":{
           "title" : "Sort",
           "enum":["ASC","DESC"],
-          "description": "Sort the results in ASC or DESC"
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
         }
       }
     },
@@ -241,7 +259,7 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source document(excl. number,date) and returns a new draft document.",
+          "description": "Copies the source(excl. number,date) and returns a new draft document. Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
           "type" : "string"
         }
       }

data/json/v1.0/tag.json

@@ -59,7 +59,8 @@
         "sort":{
           "title" : "Sort",
           "enum":["ASC","DESC"],
-          "description": "Sort the results in ASC or DESC"
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
         }
       }
     },

data/json/v1.0/text_template.json

@@ -26,7 +26,7 @@
     "kind":{
       "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"],
+      "enum": ["","invoice", "estimate", "credit_note", "payment_reminder", "order", "contact", "email"],
       "type":"string"
     },
     "created_at":{
@@ -74,7 +74,8 @@
         "sort":{
           "title" : "Sort",
           "enum":["ASC","DESC"],
-          "description": "Sort the results in ASC or DESC"
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
         }
       }
     },

data/lib/sk_api_schema/version.rb

@@ -1,7 +1,7 @@
 module SK
   module Api
     class Schema
-      VERSION='0.6.1'
+      VERSION='0.7.0'
     end
   end
 end

data/spec/sk_api_schema_spec.rb

@@ -144,7 +144,9 @@ end
 ################################################################################
 # virtual classes used in test
 class Invoice
-  attr_accessor :id, :title, :description, :number, :date, :due_date, :line_items, :client, :archived_pdf, :items
+  attr_accessor :id, :title, :description, :number, :date, :due_date,
+                :line_items, :archived_pdf, :items,
+                :client, :contact
 end
 
 class LineItem

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -112,6 +112,7 @@ files:
 - json/v1.0/client.json
 - json/v1.0/comment.json
 - json/v1.0/company.json
+- json/v1.0/contact.json
 - json/v1.0/credit_note.json
 - json/v1.0/divider_item.json
 - json/v1.0/document.json