@epilot/email-template-client
Advanced tools
Comparing version 1.7.0-internal to 1.7.0
@@ -1,1 +0,1 @@ | ||
(()=>{"use strict";var e={914:function(e,t,a){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var p=o(a(240));t.default=p.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/email-template/templates":{"post":{"operationId":"saveTemplate","requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates/{id}":{"get":{"operationId":"getTemplateDetail","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/email-template/templates:replace":{"post":{"operationId":"replaceVariables","requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates:replaceAsync":{"post":{"operationId":"replaceVariablesAsync","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates:bulkSendMessage":{"post":{"operationId":"bulkSendMessage","requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates:revert":{"post":{"operationId":"revertToOriginalTemplate","requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates/system":{"post":{"operationId":"createSystemTemplates"}},"/v1/email-template/templates/system/names":{"post":{"operationId":"createSystemTemplatesByNames","requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/email-template/templates/system/feature":{"post":{"operationId":"createFeatureSystemTemplates","requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://email-template.sls.epilot.io"}]}')}},t={},a=function a(o){var p=t[o];if(void 0!==p)return p.exports;var s=t[o]={exports:{}};return e[o].call(s.exports,s,s.exports,a),s.exports}(914),o=exports;for(var p in a)o[p]=a[p];a.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})(); | ||
(()=>{"use strict";var e={914:function(e,t,a){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var p=o(a(240));t.default=p.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/email-template/templates":{"post":{"operationId":"saveTemplate","requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates/{id}":{"get":{"operationId":"getTemplateDetail","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/email-template/templates:replace":{"post":{"operationId":"replaceVariables","requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates:replaceAsync":{"post":{"operationId":"replaceVariablesAsync","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates:bulkSendMessage":{"post":{"operationId":"bulkSendMessage","requestBody":{"content":{"application/json":{}}}}},"/v1/email-template/templates:revert":{"post":{"operationId":"revertToOriginalTemplate","requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://email-template.sls.epilot.io"}]}')}},t={},a=function a(o){var p=t[o];if(void 0!==p)return p.exports;var r=t[o]={exports:{}};return e[o].call(r.exports,r,r.exports,a),r.exports}(914),o=exports;for(var p in a)o[p]=a[p];a.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})(); |
@@ -75,28 +75,2 @@ { | ||
} | ||
}, | ||
"/v1/email-template/templates/system": { | ||
"post": { | ||
"operationId": "createSystemTemplates" | ||
} | ||
}, | ||
"/v1/email-template/templates/system/names": { | ||
"post": { | ||
"operationId": "createSystemTemplatesByNames", | ||
"requestBody": { | ||
"required": true, | ||
"content": { | ||
"application/json": {} | ||
} | ||
} | ||
} | ||
}, | ||
"/v1/email-template/templates/system/feature": { | ||
"post": { | ||
"operationId": "createFeatureSystemTemplates", | ||
"requestBody": { | ||
"content": { | ||
"application/json": {} | ||
} | ||
} | ||
} | ||
} | ||
@@ -103,0 +77,0 @@ }, |
@@ -115,48 +115,2 @@ /* eslint-disable */ | ||
} | null; | ||
export interface AttachmentResponse { | ||
/** | ||
* Total attachments | ||
* example: | ||
* 10 | ||
*/ | ||
total?: number; | ||
/** | ||
* List attachments | ||
*/ | ||
attachments?: { | ||
/** | ||
* File name | ||
* example: | ||
* order.docx | ||
*/ | ||
filename?: string; | ||
/** | ||
* Bucket name | ||
* example: | ||
* epilot-playground-upload-document | ||
*/ | ||
bucket?: string; | ||
/** | ||
* Object key | ||
* example: | ||
* 9f561bea-f0d9-4e96-b7a9-879fc1643ac0.docx | ||
*/ | ||
object_key?: string; | ||
/** | ||
* URL | ||
* example: | ||
* https://epilot-playground-upload-document.s3.eu-central-1.amazonaws.com/9f561bea-f0d9-4e96-b7a9-879fc1643ac0.docx | ||
*/ | ||
url?: string; | ||
/** | ||
* Document type: | ||
* * 0: Static docs | ||
* * 1: Templates | ||
* | ||
* example: | ||
* 0 | ||
*/ | ||
document_type?: number; | ||
}[]; | ||
} | ||
export interface BaseEntity { | ||
@@ -343,14 +297,2 @@ /** | ||
} | ||
export interface CreateSystemTemplatesReq { | ||
/** | ||
* example: | ||
* [ | ||
* "DoubleOptIn_Email_DE", | ||
* "Einladung Kundenportal", | ||
* "Partner_Kooperation_Email_DE" | ||
* ] | ||
*/ | ||
template_names: string[]; | ||
} | ||
export type CreateSystemTemplatesResp = BaseEntity[]; | ||
export interface EmailTemplateEntity { | ||
@@ -574,49 +516,2 @@ /** | ||
} | ||
export interface PresignedRequest { | ||
/** | ||
* UUID | ||
* example: | ||
* 8c086140-f33e-4bb7-a993-50c0f2402c7b | ||
*/ | ||
id: string; | ||
/** | ||
* File name | ||
* example: | ||
* order.pdf | ||
*/ | ||
filename: string; | ||
/** | ||
* Content type | ||
* example: | ||
* application/pdf | ||
*/ | ||
content_type: string; | ||
} | ||
export interface PresignedResponse { | ||
/** | ||
* URL to download the attachment. This URL is not accessible until attachment is uploaded successfully. | ||
* example: | ||
* https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf | ||
*/ | ||
download_url: string; | ||
/** | ||
* Post presigned URL to upload file | ||
*/ | ||
upload_url: { | ||
/** | ||
* URL to upload the attachment | ||
* example: | ||
* https://s3.eu-central-1.amazonaws.com/893487340562-message-attachment | ||
*/ | ||
url: number; | ||
/** | ||
* Fields are provided by AWS to authenticate and validate the request. All fields should be included in form-data when performing upload request. | ||
* example: | ||
* {} | ||
*/ | ||
fields: { | ||
[key: string]: any; | ||
}; | ||
}; | ||
} | ||
/** | ||
@@ -639,47 +534,2 @@ * When true, it lets to send only the email by skip creating the thread & message entities. | ||
} | ||
export interface UserResponse { | ||
id?: string; | ||
organization_id?: string; | ||
/** | ||
* User's display name (default: email address) | ||
* example: | ||
* Example User | ||
*/ | ||
display_name?: string; | ||
email?: string; // email | ||
/** | ||
* example: | ||
* 1234567890 | ||
*/ | ||
phone?: string | null; | ||
/** | ||
* example: | ||
* de | ||
*/ | ||
preferred_language?: string; | ||
/** | ||
* example: | ||
* { | ||
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png", | ||
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png" | ||
* } | ||
*/ | ||
image_uri?: { | ||
[name: string]: any; | ||
original?: string; // uri | ||
thumbnail_32?: string; // uri | ||
}; | ||
properties?: { | ||
/** | ||
* example: | ||
* profileImageName | ||
*/ | ||
name: string; | ||
/** | ||
* example: | ||
* avatar.png | ||
*/ | ||
value: string; | ||
}[]; | ||
} | ||
export interface VariableParameters { | ||
@@ -737,33 +587,2 @@ template_type: TemplateType; | ||
} | ||
namespace CreateFeatureSystemTemplates { | ||
export interface RequestBody { | ||
/** | ||
* example: | ||
* end_customer_portal | ||
*/ | ||
featureKey?: string; | ||
} | ||
namespace Responses { | ||
export interface $200 { | ||
} | ||
export interface $403 { | ||
} | ||
} | ||
} | ||
namespace CreateSystemTemplates { | ||
namespace Responses { | ||
export interface $200 { | ||
} | ||
export interface $403 { | ||
} | ||
} | ||
} | ||
namespace CreateSystemTemplatesByNames { | ||
export type RequestBody = Components.Schemas.CreateSystemTemplatesReq; | ||
namespace Responses { | ||
export type $200 = Components.Schemas.CreateSystemTemplatesResp; | ||
export interface $403 { | ||
} | ||
} | ||
} | ||
namespace GetTemplateDetail { | ||
@@ -919,32 +738,2 @@ namespace Parameters { | ||
): OperationResponse<Paths.RevertToOriginalTemplate.Responses.$200> | ||
/** | ||
* createSystemTemplates - createSystemTemplates | ||
* | ||
* create system email templates for an organization | ||
*/ | ||
'createSystemTemplates'( | ||
parameters?: Parameters<UnknownParamsObject> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.CreateSystemTemplates.Responses.$200> | ||
/** | ||
* createSystemTemplatesByNames - createSystemTemplatesByNames | ||
* | ||
* create system email templates, for an organization, by names | ||
*/ | ||
'createSystemTemplatesByNames'( | ||
parameters?: Parameters<UnknownParamsObject> | null, | ||
data?: Paths.CreateSystemTemplatesByNames.RequestBody, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.CreateSystemTemplatesByNames.Responses.$200> | ||
/** | ||
* createFeatureSystemTemplates - createFeatureSystemTemplates | ||
* | ||
* create system email templates for an organization based on feature | ||
*/ | ||
'createFeatureSystemTemplates'( | ||
parameters?: Parameters<UnknownParamsObject> | null, | ||
data?: Paths.CreateFeatureSystemTemplates.RequestBody, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.CreateFeatureSystemTemplates.Responses.$200> | ||
} | ||
@@ -1028,40 +817,4 @@ | ||
} | ||
['/v1/email-template/templates/system']: { | ||
/** | ||
* createSystemTemplates - createSystemTemplates | ||
* | ||
* create system email templates for an organization | ||
*/ | ||
'post'( | ||
parameters?: Parameters<UnknownParamsObject> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.CreateSystemTemplates.Responses.$200> | ||
} | ||
['/v1/email-template/templates/system/names']: { | ||
/** | ||
* createSystemTemplatesByNames - createSystemTemplatesByNames | ||
* | ||
* create system email templates, for an organization, by names | ||
*/ | ||
'post'( | ||
parameters?: Parameters<UnknownParamsObject> | null, | ||
data?: Paths.CreateSystemTemplatesByNames.RequestBody, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.CreateSystemTemplatesByNames.Responses.$200> | ||
} | ||
['/v1/email-template/templates/system/feature']: { | ||
/** | ||
* createFeatureSystemTemplates - createFeatureSystemTemplates | ||
* | ||
* create system email templates for an organization based on feature | ||
*/ | ||
'post'( | ||
parameters?: Parameters<UnknownParamsObject> | null, | ||
data?: Paths.CreateFeatureSystemTemplates.RequestBody, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.CreateFeatureSystemTemplates.Responses.$200> | ||
} | ||
} | ||
export type Client = OpenAPIClient<OperationMethods, PathsDictionary> |
@@ -309,91 +309,2 @@ { | ||
} | ||
}, | ||
"/v1/email-template/templates/system": { | ||
"post": { | ||
"operationId": "createSystemTemplates", | ||
"summary": "createSystemTemplates", | ||
"description": "create system email templates for an organization", | ||
"x-internal": true, | ||
"tags": [ | ||
"Email templates" | ||
], | ||
"responses": { | ||
"200": { | ||
"description": "Success" | ||
}, | ||
"403": { | ||
"description": "Forbidden" | ||
} | ||
} | ||
} | ||
}, | ||
"/v1/email-template/templates/system/names": { | ||
"post": { | ||
"operationId": "createSystemTemplatesByNames", | ||
"summary": "createSystemTemplatesByNames", | ||
"description": "create system email templates, for an organization, by names", | ||
"x-internal": true, | ||
"tags": [ | ||
"Email templates" | ||
], | ||
"requestBody": { | ||
"required": true, | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/CreateSystemTemplatesReq" | ||
} | ||
} | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"description": "Success", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/CreateSystemTemplatesResp" | ||
} | ||
} | ||
} | ||
}, | ||
"403": { | ||
"description": "Forbidden" | ||
} | ||
} | ||
} | ||
}, | ||
"/v1/email-template/templates/system/feature": { | ||
"post": { | ||
"operationId": "createFeatureSystemTemplates", | ||
"summary": "createFeatureSystemTemplates", | ||
"description": "create system email templates for an organization based on feature", | ||
"x-internal": true, | ||
"tags": [ | ||
"Email templates" | ||
], | ||
"requestBody": { | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"type": "object", | ||
"properties": { | ||
"featureKey": { | ||
"type": "string", | ||
"example": "end_customer_portal" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"description": "Success" | ||
}, | ||
"403": { | ||
"description": "Forbidden" | ||
} | ||
} | ||
} | ||
} | ||
@@ -773,172 +684,2 @@ }, | ||
}, | ||
"PresignedRequest": { | ||
"type": "object", | ||
"required": [ | ||
"id", | ||
"filename", | ||
"content_type" | ||
], | ||
"properties": { | ||
"id": { | ||
"description": "UUID", | ||
"type": "string", | ||
"example": "8c086140-f33e-4bb7-a993-50c0f2402c7b" | ||
}, | ||
"filename": { | ||
"description": "File name", | ||
"type": "string", | ||
"example": "order.pdf" | ||
}, | ||
"content_type": { | ||
"description": "Content type", | ||
"type": "string", | ||
"example": "application/pdf" | ||
} | ||
} | ||
}, | ||
"PresignedResponse": { | ||
"type": "object", | ||
"required": [ | ||
"download_url", | ||
"upload_url" | ||
], | ||
"properties": { | ||
"download_url": { | ||
"type": "string", | ||
"description": "URL to download the attachment. This URL is not accessible until attachment is uploaded successfully.", | ||
"example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf" | ||
}, | ||
"upload_url": { | ||
"description": "Post presigned URL to upload file", | ||
"type": "object", | ||
"required": [ | ||
"url", | ||
"fields" | ||
], | ||
"properties": { | ||
"url": { | ||
"type": "number", | ||
"description": "URL to upload the attachment", | ||
"example": "https://s3.eu-central-1.amazonaws.com/893487340562-message-attachment" | ||
}, | ||
"fields": { | ||
"type": "object", | ||
"description": "Fields are provided by AWS to authenticate and validate the request. All fields should be included in form-data when performing upload request.", | ||
"example": {} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"AttachmentResponse": { | ||
"type": "object", | ||
"properties": { | ||
"total": { | ||
"description": "Total attachments", | ||
"type": "number", | ||
"example": 10 | ||
}, | ||
"attachments": { | ||
"description": "List attachments", | ||
"type": "array", | ||
"items": { | ||
"type": "object", | ||
"properties": { | ||
"filename": { | ||
"description": "File name", | ||
"type": "string", | ||
"example": "order.docx" | ||
}, | ||
"bucket": { | ||
"description": "Bucket name", | ||
"type": "string", | ||
"example": "epilot-playground-upload-document" | ||
}, | ||
"object_key": { | ||
"description": "Object key", | ||
"type": "string", | ||
"example": "9f561bea-f0d9-4e96-b7a9-879fc1643ac0.docx" | ||
}, | ||
"url": { | ||
"description": "URL", | ||
"type": "string", | ||
"example": "https://epilot-playground-upload-document.s3.eu-central-1.amazonaws.com/9f561bea-f0d9-4e96-b7a9-879fc1643ac0.docx" | ||
}, | ||
"document_type": { | ||
"description": "Document type:\n* 0: Static docs\n* 1: Templates\n", | ||
"type": "number", | ||
"example": 0 | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"UserResponse": { | ||
"type": "object", | ||
"properties": { | ||
"id": { | ||
"type": "string" | ||
}, | ||
"organization_id": { | ||
"type": "string" | ||
}, | ||
"display_name": { | ||
"type": "string", | ||
"description": "User's display name (default: email address)", | ||
"example": "Example User" | ||
}, | ||
"email": { | ||
"type": "string", | ||
"format": "email" | ||
}, | ||
"phone": { | ||
"type": "string", | ||
"nullable": true, | ||
"example": 1234567890 | ||
}, | ||
"preferred_language": { | ||
"type": "string", | ||
"example": "de" | ||
}, | ||
"image_uri": { | ||
"type": "object", | ||
"additionalProperties": true, | ||
"properties": { | ||
"original": { | ||
"type": "string", | ||
"format": "uri" | ||
}, | ||
"thumbnail_32": { | ||
"type": "string", | ||
"format": "uri" | ||
} | ||
}, | ||
"example": { | ||
"original": "https://account-profile-images.epilot.cloud/1/avatar.png", | ||
"thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png" | ||
} | ||
}, | ||
"properties": { | ||
"type": "array", | ||
"items": { | ||
"type": "object", | ||
"properties": { | ||
"name": { | ||
"type": "string", | ||
"example": "profileImageName" | ||
}, | ||
"value": { | ||
"type": "string", | ||
"example": "avatar.png" | ||
} | ||
}, | ||
"required": [ | ||
"name", | ||
"value" | ||
] | ||
} | ||
} | ||
} | ||
}, | ||
"VariableParameters": { | ||
@@ -1296,27 +1037,2 @@ "type": "object", | ||
} | ||
}, | ||
"CreateSystemTemplatesReq": { | ||
"type": "object", | ||
"properties": { | ||
"template_names": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"example": [ | ||
"DoubleOptIn_Email_DE", | ||
"Einladung Kundenportal", | ||
"Partner_Kooperation_Email_DE" | ||
] | ||
} | ||
}, | ||
"required": [ | ||
"template_names" | ||
] | ||
}, | ||
"CreateSystemTemplatesResp": { | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/components/schemas/BaseEntity" | ||
} | ||
} | ||
@@ -1323,0 +1039,0 @@ } |
{ | ||
"name": "@epilot/email-template-client", | ||
"version": "1.7.0-internal", | ||
"version": "1.7.0", | ||
"description": "API Client for epilot Email Template API", | ||
@@ -74,3 +74,3 @@ "main": "dist/index.js", | ||
}, | ||
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7" | ||
"gitHead": "25f84cc5cd8614b24fd23343697d70946768682f" | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
13
0
69633
2023