@epilot/email-template-client
Advanced tools
Comparing version 1.6.1 to 1.6.2
@@ -182,10 +182,10 @@ /* eslint-disable */ | ||
*/ | ||
status: "PROCESSING" | "QUEUEING" | "SENDING" | "SUCCESS" | "FAILED" | "CANCELLED"; | ||
status: "PROCESSING" | "QUEUEING" | "APPROVAL" | "SENDING" | "SUCCESS" | "FAILED" | "CANCELLED"; | ||
request: BulkSendMessageRequest | BulkSendMessageRequestWithQuery; | ||
/** | ||
* Total number of emails generated and queued for sending | ||
* User ID who created the bulk message action | ||
* example: | ||
* 100 | ||
* 1234 | ||
*/ | ||
total_queued?: number; | ||
created_by?: string; | ||
/** | ||
@@ -200,2 +200,30 @@ * Time when the bulk message action was created | ||
/** | ||
* Time when the bulk message action was last updated | ||
*/ | ||
approved_at?: string; // date-time | ||
/** | ||
* Task token to approve or cancel the bulk message action | ||
* example: | ||
* 8c086140-f33e-4bb7-a993-50c0f2402c7b | ||
*/ | ||
task_token?: string; | ||
/** | ||
* Total number of emails generated and queued for sending | ||
* example: | ||
* 100 | ||
*/ | ||
total_queued?: number; | ||
/** | ||
* List of entity ids that are queued for sending | ||
*/ | ||
queued?: { | ||
/** | ||
* Recipient Entity ID | ||
* example: | ||
* 3fa85f64-5717-4562-b3fc-2c963f66afa6 | ||
*/ | ||
entity_id: string; | ||
email_to?: string[]; | ||
}[]; | ||
/** | ||
* List of entity ids and message ids that were sent successfully | ||
@@ -216,2 +244,3 @@ */ | ||
message_id: string; | ||
email_to?: string[]; | ||
}[]; | ||
@@ -232,2 +261,3 @@ /** | ||
error: string; | ||
email_to?: string[]; | ||
}[]; | ||
@@ -540,5 +570,5 @@ } | ||
/** | ||
* Provide CANCEL to stop the bulk message request | ||
* Trigger an APPROVE OR CANCEL action for the bulk message request | ||
*/ | ||
action?: "CANCEL"; | ||
action?: "APPROVE" | "CANCEL"; | ||
}; | ||
@@ -545,0 +575,0 @@ namespace Responses { |
@@ -244,4 +244,5 @@ { | ||
"type": "string", | ||
"description": "Provide CANCEL to stop the bulk message request", | ||
"description": "Trigger an APPROVE OR CANCEL action for the bulk message request", | ||
"enum": [ | ||
"APPROVE", | ||
"CANCEL" | ||
@@ -316,10 +317,5 @@ ] | ||
"scheme": "bearer", | ||
"description": "Epilot Bearer Custom Authorization Token\n\n```\nbtoa(JSON.stringify(\n {\n idtoken: $idToken,\n accesstoken: $accessToken\n }\n))\n```\n" | ||
"description": "Authorization header with epilot OAuth2 bearer token", | ||
"bearerFormat": "JWT" | ||
}, | ||
"AsOrganization": { | ||
"type": "apiKey", | ||
"in": "header", | ||
"name": "x-ivy-org-id", | ||
"description": "Set organization id when using internal auth" | ||
}, | ||
"EpilotOrg": { | ||
@@ -888,2 +884,3 @@ "description": "Overrides the target organization to allow shared tenant access", | ||
"QUEUEING", | ||
"APPROVAL", | ||
"SENDING", | ||
@@ -905,6 +902,7 @@ "SUCCESS", | ||
}, | ||
"total_queued": { | ||
"type": "integer", | ||
"description": "Total number of emails generated and queued for sending", | ||
"example": 100 | ||
"created_by": { | ||
"type": "string", | ||
"description": "User ID who created the bulk message action", | ||
"example": "1234", | ||
"readonly": true | ||
}, | ||
@@ -923,2 +921,45 @@ "created_at": { | ||
}, | ||
"approved_at": { | ||
"type": "string", | ||
"description": "Time when the bulk message action was last updated", | ||
"format": "date-time", | ||
"readonly": true | ||
}, | ||
"task_token": { | ||
"type": "string", | ||
"description": "Task token to approve or cancel the bulk message action", | ||
"example": "8c086140-f33e-4bb7-a993-50c0f2402c7b", | ||
"readonly": true | ||
}, | ||
"total_queued": { | ||
"type": "integer", | ||
"description": "Total number of emails generated and queued for sending", | ||
"example": 100, | ||
"deprecated": true | ||
}, | ||
"queued": { | ||
"type": "array", | ||
"description": "List of entity ids that are queued for sending", | ||
"items": { | ||
"type": "object", | ||
"required": [ | ||
"entity_id" | ||
], | ||
"properties": { | ||
"entity_id": { | ||
"type": "string", | ||
"description": "Recipient Entity ID", | ||
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" | ||
}, | ||
"email_to": { | ||
"type": "array", | ||
"items": { | ||
"type": "string", | ||
"description": "Recipient email address", | ||
"example": "recipient@example.com" | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"sent": { | ||
@@ -943,2 +984,10 @@ "type": "array", | ||
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" | ||
}, | ||
"email_to": { | ||
"type": "array", | ||
"items": { | ||
"type": "string", | ||
"description": "Recipient email address", | ||
"example": "recipient@example.com" | ||
} | ||
} | ||
@@ -966,2 +1015,10 @@ } | ||
"description": "Error message" | ||
}, | ||
"email_to": { | ||
"type": "array", | ||
"items": { | ||
"type": "string", | ||
"description": "Recipient email address", | ||
"example": "recipient@example.com" | ||
} | ||
} | ||
@@ -968,0 +1025,0 @@ } |
{ | ||
"name": "@epilot/email-template-client", | ||
"version": "1.6.1", | ||
"version": "1.6.2", | ||
"description": "API Client for epilot Email Template API", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
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
67385
2003