Skip to content

Commit a1c48ee

Browse files
deploy: 66d7413
1 parent 846ac18 commit a1c48ee

2 files changed

Lines changed: 111 additions & 3 deletions

File tree

docs/sitemap.xml.gz

0 Bytes
Binary file not shown.

docs/swagger/collections.yaml

Lines changed: 111 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1134,8 +1134,8 @@ paths:
11341134

11351135
/import/subscribers/logs:
11361136
get:
1137-
description: returns import statistics
1138-
operationId: getImportSubscriberStats
1137+
description: returns import logs from an ongoing import
1138+
operationId: getImportSubscriberLogs
11391139
tags:
11401140
- Import
11411141
responses:
@@ -1769,6 +1769,28 @@ paths:
17691769
type: array
17701770
items:
17711771
$ref: "#/components/schemas/Template"
1772+
post:
1773+
description: handles template creation
1774+
operationId: createTemplate
1775+
tags:
1776+
- Templates
1777+
requestBody:
1778+
description: new template info
1779+
required: true
1780+
content:
1781+
application/json:
1782+
schema:
1783+
$ref: "#/components/schemas/NewTemplate"
1784+
responses:
1785+
"200":
1786+
description: response
1787+
content:
1788+
application/json:
1789+
schema:
1790+
type: object
1791+
properties:
1792+
data:
1793+
$ref: "#/components/schemas/Template"
17721794

17731795
"/templates/{id}":
17741796
get:
@@ -1799,7 +1821,35 @@ paths:
17991821
properties:
18001822
data:
18011823
$ref: "#/components/schemas/Template"
1802-
1824+
put:
1825+
description: handles template modification
1826+
operationId: updateTemplateById
1827+
tags:
1828+
- Templates
1829+
parameters:
1830+
- in: path
1831+
name: id
1832+
required: true
1833+
description: The id value of the template you want to update.
1834+
schema:
1835+
type: integer
1836+
requestBody:
1837+
description: updated template info
1838+
required: true
1839+
content:
1840+
application/json:
1841+
schema:
1842+
$ref: "#/components/schemas/UpdateTemplate"
1843+
responses:
1844+
"200":
1845+
description: response
1846+
content:
1847+
application/json:
1848+
schema:
1849+
type: object
1850+
properties:
1851+
data:
1852+
$ref: "#/components/schemas/Template"
18031853
delete:
18041854
description: handles deletion of templates
18051855
operationId: deleteTemplateById
@@ -4033,10 +4083,20 @@ components:
40334083
type: string
40344084
filename:
40354085
type: string
4086+
content_type:
4087+
type: string
40364088
created_at:
40374089
type: string
40384090
thumb_url:
40394091
type: string
4092+
thumb_uri:
4093+
type: string
4094+
provider:
4095+
type: string
4096+
meta:
4097+
type: object
4098+
url:
4099+
type: string
40404100
uri:
40414101
type: string
40424102

@@ -4053,11 +4113,59 @@ components:
40534113
type: string
40544114
body:
40554115
type: string
4116+
body_source:
4117+
type: string
4118+
subject:
4119+
type: string
40564120
type:
40574121
type: string
40584122
is_default:
40594123
type: boolean
40604124

4125+
NewTemplate:
4126+
type: object
4127+
required:
4128+
- name
4129+
- type
4130+
- body
4131+
properties:
4132+
name:
4133+
type: string
4134+
description: Name of the template
4135+
type:
4136+
type: string
4137+
enum: [campaign, campaign_visual, tx]
4138+
description: Type of the template
4139+
subject:
4140+
type: string
4141+
description: Subject line for the template (only for tx)
4142+
body_source:
4143+
type: string
4144+
description: JSON source for the email-builder template (only for campaign_visual)
4145+
body:
4146+
type: string
4147+
description: HTML body of the template
4148+
4149+
UpdateTemplate:
4150+
type: object
4151+
properties:
4152+
name:
4153+
type: string
4154+
description: Name of the template
4155+
type:
4156+
type: string
4157+
enum: [campaign, campaign_visual, tx]
4158+
description: Type of the template
4159+
subject:
4160+
type: string
4161+
description: Subject line for the template (only for tx)
4162+
body_source:
4163+
type: string
4164+
description: JSON source for the email-builder template (only for campaign_visual)
4165+
body:
4166+
type: string
4167+
description: HTML body of the template
4168+
40614169
TransactionalMessage:
40624170
type: object
40634171
properties:

0 commit comments

Comments
 (0)