@bitblit/ratchet-misc 6.0.146-alpha → 6.0.148-alpha

package/src/brevo/generated/models/CreateSmsCampaign.ts

@@ -0,0 +1,99 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists } from '../runtime.js';
+import type { CreateSmsCampaignRecipients } from './CreateSmsCampaignRecipients.js';
+import { CreateSmsCampaignRecipientsFromJSON, CreateSmsCampaignRecipientsToJSON } from './CreateSmsCampaignRecipients.js';
+
+/**
+ *
+ * @export
+ * @interface CreateSmsCampaign
+ */
+export interface CreateSmsCampaign {
+  /**
+   * Name of the campaign
+   * @type {string}
+   * @memberof CreateSmsCampaign
+   */
+  name: string;
+  /**
+   * Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
+   * @type {string}
+   * @memberof CreateSmsCampaign
+   */
+  sender: string;
+  /**
+   * Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS
+   * @type {string}
+   * @memberof CreateSmsCampaign
+   */
+  content: string;
+  /**
+   *
+   * @type {CreateSmsCampaignRecipients}
+   * @memberof CreateSmsCampaign
+   */
+  recipients?: CreateSmsCampaignRecipients;
+  /**
+   * UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+   * @type {Date}
+   * @memberof CreateSmsCampaign
+   */
+  scheduledAt?: Date;
+}
+
+/**
+ * Check if a given object implements the CreateSmsCampaign interface.
+ */
+export function instanceOfCreateSmsCampaign(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'name' in value;
+  isInstance = isInstance && 'sender' in value;
+  isInstance = isInstance && 'content' in value;
+
+  return isInstance;
+}
+
+export function CreateSmsCampaignFromJSON(json: any): CreateSmsCampaign {
+  return CreateSmsCampaignFromJSONTyped(json, false);
+}
+
+export function CreateSmsCampaignFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSmsCampaign {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    name: json['name'],
+    sender: json['sender'],
+    content: json['content'],
+    recipients: !exists(json, 'recipients') ? undefined : CreateSmsCampaignRecipientsFromJSON(json['recipients']),
+    scheduledAt: !exists(json, 'scheduledAt') ? undefined : new Date(json['scheduledAt']),
+  };
+}
+
+export function CreateSmsCampaignToJSON(value?: CreateSmsCampaign | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    name: value.name,
+    sender: value.sender,
+    content: value.content,
+    recipients: CreateSmsCampaignRecipientsToJSON(value.recipients),
+    scheduledAt: value.scheduledAt === undefined ? undefined : value.scheduledAt.toISOString(),
+  };
+}

package/src/brevo/generated/models/CreateSmsCampaignRecipients.ts

@@ -0,0 +1,71 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists } from '../runtime.js';
+
+/**
+ *
+ * @export
+ * @interface CreateSmsCampaignRecipients
+ */
+export interface CreateSmsCampaignRecipients {
+  /**
+   * Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty
+   * @type {Array<number>}
+   * @memberof CreateSmsCampaignRecipients
+   */
+  listIds: Array<number>;
+  /**
+   * List ids which have to be excluded from a campaign
+   * @type {Array<number>}
+   * @memberof CreateSmsCampaignRecipients
+   */
+  exclusionListIds?: Array<number>;
+}
+
+/**
+ * Check if a given object implements the CreateSmsCampaignRecipients interface.
+ */
+export function instanceOfCreateSmsCampaignRecipients(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'listIds' in value;
+
+  return isInstance;
+}
+
+export function CreateSmsCampaignRecipientsFromJSON(json: any): CreateSmsCampaignRecipients {
+  return CreateSmsCampaignRecipientsFromJSONTyped(json, false);
+}
+
+export function CreateSmsCampaignRecipientsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSmsCampaignRecipients {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    listIds: json['listIds'],
+    exclusionListIds: !exists(json, 'exclusionListIds') ? undefined : json['exclusionListIds'],
+  };
+}
+
+export function CreateSmsCampaignRecipientsToJSON(value?: CreateSmsCampaignRecipients | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    listIds: value.listIds,
+    exclusionListIds: value.exclusionListIds,
+  };
+}

package/src/brevo/generated/models/CreateSmtpEmail.ts

@@ -0,0 +1,61 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface CreateSmtpEmail
+ */
+export interface CreateSmtpEmail {
+  /**
+   * Message ID of the transactional email sent
+   * @type {string}
+   * @memberof CreateSmtpEmail
+   */
+  messageId: string;
+}
+
+/**
+ * Check if a given object implements the CreateSmtpEmail interface.
+ */
+export function instanceOfCreateSmtpEmail(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'messageId' in value;
+
+  return isInstance;
+}
+
+export function CreateSmtpEmailFromJSON(json: any): CreateSmtpEmail {
+  return CreateSmtpEmailFromJSONTyped(json, false);
+}
+
+export function CreateSmtpEmailFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSmtpEmail {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    messageId: json['messageId'],
+  };
+}
+
+export function CreateSmtpEmailToJSON(value?: CreateSmtpEmail | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    messageId: value.messageId,
+  };
+}

package/src/brevo/generated/models/CreateSmtpTemplate.ts

@@ -0,0 +1,139 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists } from '../runtime.js';
+import type { CreateSmtpTemplateSender } from './CreateSmtpTemplateSender.js';
+import { CreateSmtpTemplateSenderFromJSON, CreateSmtpTemplateSenderToJSON } from './CreateSmtpTemplateSender.js';
+
+/**
+ *
+ * @export
+ * @interface CreateSmtpTemplate
+ */
+export interface CreateSmtpTemplate {
+  /**
+   * Tag of the template
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  tag?: string;
+  /**
+   *
+   * @type {CreateSmtpTemplateSender}
+   * @memberof CreateSmtpTemplate
+   */
+  sender: CreateSmtpTemplateSender;
+  /**
+   * Name of the template
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  templateName: string;
+  /**
+   * Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  htmlContent?: string;
+  /**
+   * Url which contents the body of the email message. REQUIRED if htmlContent is empty
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  htmlUrl?: string;
+  /**
+   * Subject of the template
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  subject: string;
+  /**
+   * Email on which campaign recipients will be able to reply to
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  replyTo?: string;
+  /**
+   * To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  toField?: string;
+  /**
+   * Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
+   * @type {string}
+   * @memberof CreateSmtpTemplate
+   */
+  attachmentUrl?: string;
+  /**
+   * Status of template. isActive = true means template is active and isActive = false means template is inactive
+   * @type {boolean}
+   * @memberof CreateSmtpTemplate
+   */
+  isActive?: boolean;
+}
+
+/**
+ * Check if a given object implements the CreateSmtpTemplate interface.
+ */
+export function instanceOfCreateSmtpTemplate(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'sender' in value;
+  isInstance = isInstance && 'templateName' in value;
+  isInstance = isInstance && 'subject' in value;
+
+  return isInstance;
+}
+
+export function CreateSmtpTemplateFromJSON(json: any): CreateSmtpTemplate {
+  return CreateSmtpTemplateFromJSONTyped(json, false);
+}
+
+export function CreateSmtpTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSmtpTemplate {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    tag: !exists(json, 'tag') ? undefined : json['tag'],
+    sender: CreateSmtpTemplateSenderFromJSON(json['sender']),
+    templateName: json['templateName'],
+    htmlContent: !exists(json, 'htmlContent') ? undefined : json['htmlContent'],
+    htmlUrl: !exists(json, 'htmlUrl') ? undefined : json['htmlUrl'],
+    subject: json['subject'],
+    replyTo: !exists(json, 'replyTo') ? undefined : json['replyTo'],
+    toField: !exists(json, 'toField') ? undefined : json['toField'],
+    attachmentUrl: !exists(json, 'attachmentUrl') ? undefined : json['attachmentUrl'],
+    isActive: !exists(json, 'isActive') ? undefined : json['isActive'],
+  };
+}
+
+export function CreateSmtpTemplateToJSON(value?: CreateSmtpTemplate | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    tag: value.tag,
+    sender: CreateSmtpTemplateSenderToJSON(value.sender),
+    templateName: value.templateName,
+    htmlContent: value.htmlContent,
+    htmlUrl: value.htmlUrl,
+    subject: value.subject,
+    replyTo: value.replyTo,
+    toField: value.toField,
+    attachmentUrl: value.attachmentUrl,
+    isActive: value.isActive,
+  };
+}

package/src/brevo/generated/models/CreateSmtpTemplateSender.ts

@@ -0,0 +1,78 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists } from '../runtime.js';
+
+/**
+ * Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{"name":"xyz", "email":"example@abc.com"}` , `{"name":"xyz", "id":123}`
+ * @export
+ * @interface CreateSmtpTemplateSender
+ */
+export interface CreateSmtpTemplateSender {
+  /**
+   * Name of the sender. If not passed, will be set to default
+   * @type {string}
+   * @memberof CreateSmtpTemplateSender
+   */
+  name?: string;
+  /**
+   * Email of the sender
+   * @type {string}
+   * @memberof CreateSmtpTemplateSender
+   */
+  email?: string;
+  /**
+   * Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email).
+   * @type {number}
+   * @memberof CreateSmtpTemplateSender
+   */
+  id?: number;
+}
+
+/**
+ * Check if a given object implements the CreateSmtpTemplateSender interface.
+ */
+export function instanceOfCreateSmtpTemplateSender(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function CreateSmtpTemplateSenderFromJSON(json: any): CreateSmtpTemplateSender {
+  return CreateSmtpTemplateSenderFromJSONTyped(json, false);
+}
+
+export function CreateSmtpTemplateSenderFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSmtpTemplateSender {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    name: !exists(json, 'name') ? undefined : json['name'],
+    email: !exists(json, 'email') ? undefined : json['email'],
+    id: !exists(json, 'id') ? undefined : json['id'],
+  };
+}
+
+export function CreateSmtpTemplateSenderToJSON(value?: CreateSmtpTemplateSender | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    name: value.name,
+    email: value.email,
+    id: value.id,
+  };
+}

package/src/brevo/generated/models/CreateUpdateContactModel.ts

@@ -0,0 +1,62 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists } from '../runtime.js';
+
+/**
+ *
+ * @export
+ * @interface CreateUpdateContactModel
+ */
+export interface CreateUpdateContactModel {
+  /**
+   * ID of the contact when a new contact is created
+   * @type {number}
+   * @memberof CreateUpdateContactModel
+   */
+  id?: number;
+}
+
+/**
+ * Check if a given object implements the CreateUpdateContactModel interface.
+ */
+export function instanceOfCreateUpdateContactModel(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function CreateUpdateContactModelFromJSON(json: any): CreateUpdateContactModel {
+  return CreateUpdateContactModelFromJSONTyped(json, false);
+}
+
+export function CreateUpdateContactModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateUpdateContactModel {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    id: !exists(json, 'id') ? undefined : json['id'],
+  };
+}
+
+export function CreateUpdateContactModelToJSON(value?: CreateUpdateContactModel | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    id: value.id,
+  };
+}

package/src/brevo/generated/models/CreateUpdateFolder.ts

@@ -0,0 +1,62 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists } from '../runtime.js';
+
+/**
+ *
+ * @export
+ * @interface CreateUpdateFolder
+ */
+export interface CreateUpdateFolder {
+  /**
+   * Name of the folder
+   * @type {string}
+   * @memberof CreateUpdateFolder
+   */
+  name?: string;
+}
+
+/**
+ * Check if a given object implements the CreateUpdateFolder interface.
+ */
+export function instanceOfCreateUpdateFolder(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function CreateUpdateFolderFromJSON(json: any): CreateUpdateFolder {
+  return CreateUpdateFolderFromJSONTyped(json, false);
+}
+
+export function CreateUpdateFolderFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateUpdateFolder {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    name: !exists(json, 'name') ? undefined : json['name'],
+  };
+}
+
+export function CreateUpdateFolderToJSON(value?: CreateUpdateFolder | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    name: value.name,
+  };
+}