sk_api_schema 0.0.8 → 0.0.9
Sign up to get free protection for your applications and to get access to all the features.
- data/VERSION +1 -1
- data/json/v1.0/email_template.json +87 -0
- data/json/v1.0/export.json +2 -4
- data/json/v1.0/export_template.json +86 -0
- data/json/v1.0/text_template.json +82 -0
- data/sk_api_schema.gemspec +5 -2
- metadata +7 -4
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.0.
|
|
1
|
+
0.0.9
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
{ "type":"object",
|
|
2
|
+
"title": "email_template",
|
|
3
|
+
"description":"An email_template in SK",
|
|
4
|
+
"properties": {
|
|
5
|
+
"id": {
|
|
6
|
+
"description": "uuid of the email template",
|
|
7
|
+
"identity":true,
|
|
8
|
+
"readonly":true,
|
|
9
|
+
"type":"string"
|
|
10
|
+
},
|
|
11
|
+
"name": {
|
|
12
|
+
"description": "A meaningful name.",
|
|
13
|
+
"required":true,
|
|
14
|
+
"type":"string"
|
|
15
|
+
},
|
|
16
|
+
"subject": {
|
|
17
|
+
"description": "Subject containing placeholders, replaced when the template is used.",
|
|
18
|
+
"required":true,
|
|
19
|
+
"type":"string"
|
|
20
|
+
},
|
|
21
|
+
"body": {
|
|
22
|
+
"description": "Body with placeholders, replaced when the template is used.",
|
|
23
|
+
"required":true,
|
|
24
|
+
"type":"string"
|
|
25
|
+
},
|
|
26
|
+
"kind": {
|
|
27
|
+
"description": "Kind of object receiving the email.",
|
|
28
|
+
"required":true,
|
|
29
|
+
"enum": ['invoice', 'estimate', 'credit_note', 'payment_reminder', 'order', 'client'],
|
|
30
|
+
"type":"string"
|
|
31
|
+
},
|
|
32
|
+
"created_at": {
|
|
33
|
+
"description": "Date the object was created in SK. Never changes afterwards",
|
|
34
|
+
"format":"date-time",
|
|
35
|
+
"readonly":true,
|
|
36
|
+
"type":"string"
|
|
37
|
+
},
|
|
38
|
+
"updated_at": {
|
|
39
|
+
"description": "Date the object was edited in SK.",
|
|
40
|
+
"format":"date-time",
|
|
41
|
+
"readonly":true,
|
|
42
|
+
"type":"string"
|
|
43
|
+
},
|
|
44
|
+
"team_id":{
|
|
45
|
+
"description": "A team uuid. If set only the team and its parent teams can see the record.",
|
|
46
|
+
"type":"string"
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"links":[
|
|
50
|
+
{ "rel": "self",
|
|
51
|
+
"href": "email_templates/{id}"
|
|
52
|
+
},
|
|
53
|
+
{ "rel": "instances",
|
|
54
|
+
"href": "email_templates",
|
|
55
|
+
"properties" : {
|
|
56
|
+
"page":{
|
|
57
|
+
"title" : "Page",
|
|
58
|
+
"description": "In paginated results set the page to look for",
|
|
59
|
+
"type":"number"
|
|
60
|
+
},
|
|
61
|
+
"sort_by":{
|
|
62
|
+
"title" : "Sort by",
|
|
63
|
+
"description": "Sort the results by the given field => number",
|
|
64
|
+
"enum":['created_at', 'updated_at'],
|
|
65
|
+
"type": 'string'
|
|
66
|
+
},
|
|
67
|
+
"sort":{
|
|
68
|
+
"title" : "Sort",
|
|
69
|
+
"enum":["ASC","DESC"],
|
|
70
|
+
"description": "Sort the results in ASC or DESC"
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
{ "rel": "destroy",
|
|
75
|
+
"href": "email_templates/{id}",
|
|
76
|
+
"method": "DELETE"
|
|
77
|
+
},
|
|
78
|
+
{ "rel": "update",
|
|
79
|
+
"href": "email_templates/{id}",
|
|
80
|
+
"method": "PUT"
|
|
81
|
+
},
|
|
82
|
+
{ "rel": "create",
|
|
83
|
+
"href": "email_templates",
|
|
84
|
+
"method": "POST"
|
|
85
|
+
}
|
|
86
|
+
]
|
|
87
|
+
}
|
data/json/v1.0/export.json
CHANGED
|
@@ -9,9 +9,7 @@
|
|
|
9
9
|
"type":"string"
|
|
10
10
|
},
|
|
11
11
|
"collection_type": {
|
|
12
|
-
"description": "The type of data to export. Lower-case
|
|
13
|
-
"required":true,
|
|
14
|
-
"enum": ['text', 'archived_pdf', 'attachments', 'dtaus_lk', 'dtaus_gk', 'allinone_pdf'],
|
|
12
|
+
"description": "The type of data to export. Lower-case singular name of the export data's class(invoice,client ..), see available classes in json schema. Does not need to be set for text-exports as its set from the export tempaltes type.",
|
|
15
13
|
"type":"string"
|
|
16
14
|
},
|
|
17
15
|
"collection_ids": {
|
|
@@ -26,7 +24,7 @@
|
|
|
26
24
|
"type":"string"
|
|
27
25
|
},
|
|
28
26
|
"template_id":{
|
|
29
|
-
"description": "A export template uuid.
|
|
27
|
+
"description": "A export template uuid. Required for text exports. collection_type can be empty as is forced to the templates type",
|
|
30
28
|
"type":"string"
|
|
31
29
|
},
|
|
32
30
|
"team_id":{
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
{ "type":"object",
|
|
2
|
+
"title": "export_template",
|
|
3
|
+
"description":"An export_template in SK",
|
|
4
|
+
"properties": {
|
|
5
|
+
"id": {
|
|
6
|
+
"description": "uuid of the export_template",
|
|
7
|
+
"identity":true,
|
|
8
|
+
"readonly":true,
|
|
9
|
+
"type":"string"
|
|
10
|
+
},
|
|
11
|
+
"name": {
|
|
12
|
+
"description": "A meaningful name.",
|
|
13
|
+
"required":true,
|
|
14
|
+
"type":"string"
|
|
15
|
+
},
|
|
16
|
+
"text": {
|
|
17
|
+
"description": "Text with placeholders, replaced when the template is used.",
|
|
18
|
+
"required":true,
|
|
19
|
+
"type":"string"
|
|
20
|
+
},
|
|
21
|
+
"kind": {
|
|
22
|
+
"description": "Kind of exported data.",
|
|
23
|
+
"required":true,
|
|
24
|
+
"enum": ['invoice', 'estimate', 'credit_note', 'payment_reminder', 'order', 'client', 'payment', 'comment', 'email', 'history', 'product','recurring'],
|
|
25
|
+
"type":"string"
|
|
26
|
+
},
|
|
27
|
+
"filename": {
|
|
28
|
+
"description": "Name of the created export file. Date placeholders can be used: %y-%m-%d_%H-%M_clients.csv",
|
|
29
|
+
"type":"string"
|
|
30
|
+
},
|
|
31
|
+
"created_at": {
|
|
32
|
+
"description": "Date the object was created in SK. Never changes afterwards",
|
|
33
|
+
"format":"date-time",
|
|
34
|
+
"readonly":true,
|
|
35
|
+
"type":"string"
|
|
36
|
+
},
|
|
37
|
+
"updated_at": {
|
|
38
|
+
"description": "Date the object was edited in SK.",
|
|
39
|
+
"format":"date-time",
|
|
40
|
+
"readonly":true,
|
|
41
|
+
"type":"string"
|
|
42
|
+
},
|
|
43
|
+
"team_id":{
|
|
44
|
+
"description": "A team uuid. If set only the team and its parent teams can see the record.",
|
|
45
|
+
"type":"string"
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"links":[
|
|
49
|
+
{ "rel": "self",
|
|
50
|
+
"href": "export_templates/{id}"
|
|
51
|
+
},
|
|
52
|
+
{ "rel": "instances",
|
|
53
|
+
"href": "export_templates",
|
|
54
|
+
"properties" : {
|
|
55
|
+
"page":{
|
|
56
|
+
"title" : "Page",
|
|
57
|
+
"description": "In paginated results set the page to look for",
|
|
58
|
+
"type":"number"
|
|
59
|
+
},
|
|
60
|
+
"sort_by":{
|
|
61
|
+
"title" : "Sort by",
|
|
62
|
+
"description": "Sort the results by the given field => number",
|
|
63
|
+
"enum":['created_at', 'updated_at'],
|
|
64
|
+
"type": 'string'
|
|
65
|
+
},
|
|
66
|
+
"sort":{
|
|
67
|
+
"title" : "Sort",
|
|
68
|
+
"enum":["ASC","DESC"],
|
|
69
|
+
"description": "Sort the results in ASC or DESC"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
{ "rel": "destroy",
|
|
74
|
+
"href": "export_templates/{id}",
|
|
75
|
+
"method": "DELETE"
|
|
76
|
+
},
|
|
77
|
+
{ "rel": "update",
|
|
78
|
+
"href": "export_templates/{id}",
|
|
79
|
+
"method": "PUT"
|
|
80
|
+
},
|
|
81
|
+
{ "rel": "create",
|
|
82
|
+
"href": "export_templates",
|
|
83
|
+
"method": "POST"
|
|
84
|
+
}
|
|
85
|
+
]
|
|
86
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
{ "type":"object",
|
|
2
|
+
"title": "text_template",
|
|
3
|
+
"description":"An text_template in SK",
|
|
4
|
+
"properties": {
|
|
5
|
+
"id": {
|
|
6
|
+
"description": "uuid of the text template",
|
|
7
|
+
"identity":true,
|
|
8
|
+
"readonly":true,
|
|
9
|
+
"type":"string"
|
|
10
|
+
},
|
|
11
|
+
"name": {
|
|
12
|
+
"description": "A meaningful name.",
|
|
13
|
+
"required":true,
|
|
14
|
+
"type":"string"
|
|
15
|
+
},
|
|
16
|
+
"text": {
|
|
17
|
+
"description": "Subject containing placeholders, replaced when the template is used.",
|
|
18
|
+
"required":true,
|
|
19
|
+
"type":"string"
|
|
20
|
+
},
|
|
21
|
+
"kind": {
|
|
22
|
+
"description": "Kind of object in which the text is used. If empty the snippet can be used globally, but watch those placeholder.",
|
|
23
|
+
"required":true,
|
|
24
|
+
"enum": ['','invoice', 'estimate', 'credit_note', 'payment_reminder', 'order', 'client', 'email'],
|
|
25
|
+
"type":"string"
|
|
26
|
+
},
|
|
27
|
+
"created_at": {
|
|
28
|
+
"description": "Date the object was created in SK. Never changes afterwards",
|
|
29
|
+
"format":"date-time",
|
|
30
|
+
"readonly":true,
|
|
31
|
+
"type":"string"
|
|
32
|
+
},
|
|
33
|
+
"updated_at": {
|
|
34
|
+
"description": "Date the object was edited in SK.",
|
|
35
|
+
"format":"date-time",
|
|
36
|
+
"readonly":true,
|
|
37
|
+
"type":"string"
|
|
38
|
+
},
|
|
39
|
+
"team_id":{
|
|
40
|
+
"description": "A team uuid. If set only the team and its parent teams can see the record.",
|
|
41
|
+
"type":"string"
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"links":[
|
|
45
|
+
{ "rel": "self",
|
|
46
|
+
"href": "text_templates/{id}"
|
|
47
|
+
},
|
|
48
|
+
{ "rel": "instances",
|
|
49
|
+
"href": "text_templates",
|
|
50
|
+
"properties" : {
|
|
51
|
+
"page":{
|
|
52
|
+
"title" : "Page",
|
|
53
|
+
"description": "In paginated results set the page to look for",
|
|
54
|
+
"type":"number"
|
|
55
|
+
},
|
|
56
|
+
"sort_by":{
|
|
57
|
+
"title" : "Sort by",
|
|
58
|
+
"description": "Sort the results by the given field => number",
|
|
59
|
+
"enum":['created_at', 'updated_at'],
|
|
60
|
+
"type": 'string'
|
|
61
|
+
},
|
|
62
|
+
"sort":{
|
|
63
|
+
"title" : "Sort",
|
|
64
|
+
"enum":["ASC","DESC"],
|
|
65
|
+
"description": "Sort the results in ASC or DESC"
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
{ "rel": "destroy",
|
|
70
|
+
"href": "text_templates/{id}",
|
|
71
|
+
"method": "DELETE"
|
|
72
|
+
},
|
|
73
|
+
{ "rel": "update",
|
|
74
|
+
"href": "text_templates/{id}",
|
|
75
|
+
"method": "PUT"
|
|
76
|
+
},
|
|
77
|
+
{ "rel": "create",
|
|
78
|
+
"href": "text_templates",
|
|
79
|
+
"method": "POST"
|
|
80
|
+
}
|
|
81
|
+
]
|
|
82
|
+
}
|
data/sk_api_schema.gemspec
CHANGED
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
|
|
6
6
|
Gem::Specification.new do |s|
|
|
7
7
|
s.name = %q{sk_api_schema}
|
|
8
|
-
s.version = "0.0.
|
|
8
|
+
s.version = "0.0.9"
|
|
9
9
|
|
|
10
10
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
|
11
11
|
s.authors = ["Georg Leciejewski"]
|
|
12
|
-
s.date = %q{2011-01-
|
|
12
|
+
s.date = %q{2011-01-24}
|
|
13
13
|
s.description = %q{SalesKing API JSON schema and utility methods}
|
|
14
14
|
s.email = %q{gl@salesking.eu}
|
|
15
15
|
s.extra_rdoc_files = [
|
|
@@ -25,14 +25,17 @@ Gem::Specification.new do |s|
|
|
|
25
25
|
"json/v1.0/comment.json",
|
|
26
26
|
"json/v1.0/credit_note.json",
|
|
27
27
|
"json/v1.0/email.json",
|
|
28
|
+
"json/v1.0/email_template.json",
|
|
28
29
|
"json/v1.0/estimate.json",
|
|
29
30
|
"json/v1.0/export.json",
|
|
31
|
+
"json/v1.0/export_template.json",
|
|
30
32
|
"json/v1.0/invoice.json",
|
|
31
33
|
"json/v1.0/line_item.json",
|
|
32
34
|
"json/v1.0/order.json",
|
|
33
35
|
"json/v1.0/payment.json",
|
|
34
36
|
"json/v1.0/payment_reminder.json",
|
|
35
37
|
"json/v1.0/product.json",
|
|
38
|
+
"json/v1.0/text_template.json",
|
|
36
39
|
"json/v1.0/user.json",
|
|
37
40
|
"lib/sk_api_schema.rb",
|
|
38
41
|
"sk_api_schema.gemspec",
|
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sk_api_schema
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
hash:
|
|
4
|
+
hash: 13
|
|
5
5
|
prerelease:
|
|
6
6
|
segments:
|
|
7
7
|
- 0
|
|
8
8
|
- 0
|
|
9
|
-
-
|
|
10
|
-
version: 0.0.
|
|
9
|
+
- 9
|
|
10
|
+
version: 0.0.9
|
|
11
11
|
platform: ruby
|
|
12
12
|
authors:
|
|
13
13
|
- Georg Leciejewski
|
|
@@ -15,7 +15,7 @@ autorequire:
|
|
|
15
15
|
bindir: bin
|
|
16
16
|
cert_chain: []
|
|
17
17
|
|
|
18
|
-
date: 2011-01-
|
|
18
|
+
date: 2011-01-24 00:00:00 +01:00
|
|
19
19
|
default_executable:
|
|
20
20
|
dependencies:
|
|
21
21
|
- !ruby/object:Gem::Dependency
|
|
@@ -64,14 +64,17 @@ files:
|
|
|
64
64
|
- json/v1.0/comment.json
|
|
65
65
|
- json/v1.0/credit_note.json
|
|
66
66
|
- json/v1.0/email.json
|
|
67
|
+
- json/v1.0/email_template.json
|
|
67
68
|
- json/v1.0/estimate.json
|
|
68
69
|
- json/v1.0/export.json
|
|
70
|
+
- json/v1.0/export_template.json
|
|
69
71
|
- json/v1.0/invoice.json
|
|
70
72
|
- json/v1.0/line_item.json
|
|
71
73
|
- json/v1.0/order.json
|
|
72
74
|
- json/v1.0/payment.json
|
|
73
75
|
- json/v1.0/payment_reminder.json
|
|
74
76
|
- json/v1.0/product.json
|
|
77
|
+
- json/v1.0/text_template.json
|
|
75
78
|
- json/v1.0/user.json
|
|
76
79
|
- lib/sk_api_schema.rb
|
|
77
80
|
- sk_api_schema.gemspec
|