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

package/src/brevo/generated/models/SendSmtpEmailToInner.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 SendSmtpEmailToInner
+ */
+export interface SendSmtpEmailToInner {
+  /**
+   * Email address of the recipient
+   * @type {string}
+   * @memberof SendSmtpEmailToInner
+   */
+  email: string;
+  /**
+   * Name of the recipient. Maximum allowed characters are 70.
+   * @type {string}
+   * @memberof SendSmtpEmailToInner
+   */
+  name?: string;
+}
+
+/**
+ * Check if a given object implements the SendSmtpEmailToInner interface.
+ */
+export function instanceOfSendSmtpEmailToInner(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'email' in value;
+
+  return isInstance;
+}
+
+export function SendSmtpEmailToInnerFromJSON(json: any): SendSmtpEmailToInner {
+  return SendSmtpEmailToInnerFromJSONTyped(json, false);
+}
+
+export function SendSmtpEmailToInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendSmtpEmailToInner {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    email: json['email'],
+    name: !exists(json, 'name') ? undefined : json['name'],
+  };
+}
+
+export function SendSmtpEmailToInnerToJSON(value?: SendSmtpEmailToInner | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    email: value.email,
+    name: value.name,
+  };
+}

package/src/brevo/generated/models/SendTemplateEmail.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 SendTemplateEmail
+ */
+export interface SendTemplateEmail {
+  /**
+   * Message ID of the template Email sent
+   * @type {string}
+   * @memberof SendTemplateEmail
+   */
+  messageId: string;
+}
+
+/**
+ * Check if a given object implements the SendTemplateEmail interface.
+ */
+export function instanceOfSendTemplateEmail(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'messageId' in value;
+
+  return isInstance;
+}
+
+export function SendTemplateEmailFromJSON(json: any): SendTemplateEmail {
+  return SendTemplateEmailFromJSONTyped(json, false);
+}
+
+export function SendTemplateEmailFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendTemplateEmail {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    messageId: json['messageId'],
+  };
+}
+
+export function SendTemplateEmailToJSON(value?: SendTemplateEmail | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    messageId: value.messageId,
+  };
+}

package/src/brevo/generated/models/SendTestEmail.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 SendTestEmail
+ */
+export interface SendTestEmail {
+  /**
+   * List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list.
+   * @type {Array<string>}
+   * @memberof SendTestEmail
+   */
+  emailTo?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the SendTestEmail interface.
+ */
+export function instanceOfSendTestEmail(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function SendTestEmailFromJSON(json: any): SendTestEmail {
+  return SendTestEmailFromJSONTyped(json, false);
+}
+
+export function SendTestEmailFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendTestEmail {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    emailTo: !exists(json, 'emailTo') ? undefined : json['emailTo'],
+  };
+}
+
+export function SendTestEmailToJSON(value?: SendTestEmail | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    emailTo: value.emailTo,
+  };
+}

package/src/brevo/generated/models/SendTestSms.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 SendTestSms
+ */
+export interface SendTestSms {
+  /**
+   * Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
+   * @type {string}
+   * @memberof SendTestSms
+   */
+  phoneNumber?: string;
+}
+
+/**
+ * Check if a given object implements the SendTestSms interface.
+ */
+export function instanceOfSendTestSms(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function SendTestSmsFromJSON(json: any): SendTestSms {
+  return SendTestSmsFromJSONTyped(json, false);
+}
+
+export function SendTestSmsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendTestSms {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    phoneNumber: !exists(json, 'phoneNumber') ? undefined : json['phoneNumber'],
+  };
+}
+
+export function SendTestSmsToJSON(value?: SendTestSms | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    phoneNumber: value.phoneNumber,
+  };
+}

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

@@ -0,0 +1,122 @@
+/* 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 SendTransacSms
+ */
+export interface SendTransacSms {
+  /**
+   * Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
+   * @type {string}
+   * @memberof SendTransacSms
+   */
+  sender: string;
+  /**
+   * Mobile number to send SMS with the country code
+   * @type {string}
+   * @memberof SendTransacSms
+   */
+  recipient: string;
+  /**
+   * Content of the message. If more than 160 characters long, will be sent as multiple text messages
+   * @type {string}
+   * @memberof SendTransacSms
+   */
+  content: string;
+  /**
+   * Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
+   * @type {string}
+   * @memberof SendTransacSms
+   */
+  type?: SendTransacSmsTypeEnum;
+  /**
+   * Tag of the message
+   * @type {string}
+   * @memberof SendTransacSms
+   */
+  tag?: string;
+  /**
+   * Webhook to call for each event triggered by the message (delivered etc.)
+   * @type {string}
+   * @memberof SendTransacSms
+   */
+  webUrl?: string;
+  /**
+   * A recognizable prefix will ensure your audience knows who you are.**Mandatory for U.S. Carriers**.This will be added as your Brand Name before the message content and will be included in content,**Prefer to verify maximum length of 160 characters including this prefix to avoid multiple sending of same sms**.
+   * @type {string}
+   * @memberof SendTransacSms
+   */
+  organisationPrefix?: string;
+}
+
+/**
+ * @export
+ * @enum {string}
+ */
+export enum SendTransacSmsTypeEnum {
+  Transactional = 'transactional',
+  Marketing = 'marketing',
+}
+
+/**
+ * Check if a given object implements the SendTransacSms interface.
+ */
+export function instanceOfSendTransacSms(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'sender' in value;
+  isInstance = isInstance && 'recipient' in value;
+  isInstance = isInstance && 'content' in value;
+
+  return isInstance;
+}
+
+export function SendTransacSmsFromJSON(json: any): SendTransacSms {
+  return SendTransacSmsFromJSONTyped(json, false);
+}
+
+export function SendTransacSmsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendTransacSms {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    sender: json['sender'],
+    recipient: json['recipient'],
+    content: json['content'],
+    type: !exists(json, 'type') ? undefined : json['type'],
+    tag: !exists(json, 'tag') ? undefined : json['tag'],
+    webUrl: !exists(json, 'webUrl') ? undefined : json['webUrl'],
+    organisationPrefix: !exists(json, 'organisationPrefix') ? undefined : json['organisationPrefix'],
+  };
+}
+
+export function SendTransacSmsToJSON(value?: SendTransacSms | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    sender: value.sender,
+    recipient: value.recipient,
+    content: value.content,
+    type: value.type,
+    tag: value.tag,
+    webUrl: value.webUrl,
+    organisationPrefix: value.organisationPrefix,
+  };
+}

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

@@ -0,0 +1,74 @@
+/* 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 { UpdateAttributeEnumerationInner } from './UpdateAttributeEnumerationInner.js';
+import { UpdateAttributeEnumerationInnerFromJSON, UpdateAttributeEnumerationInnerToJSON } from './UpdateAttributeEnumerationInner.js';
+
+/**
+ *
+ * @export
+ * @interface UpdateAttribute
+ */
+export interface UpdateAttribute {
+  /**
+   * Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'
+   * @type {string}
+   * @memberof UpdateAttribute
+   */
+  value?: string;
+  /**
+   * List of the values and labels that the attribute can take. Use only if the attribute's category is "category". For example, [{"value":1, "label":"male"}, {"value":2, "label":"female"}]
+   * @type {Array<UpdateAttributeEnumerationInner>}
+   * @memberof UpdateAttribute
+   */
+  enumeration?: Array<UpdateAttributeEnumerationInner>;
+}
+
+/**
+ * Check if a given object implements the UpdateAttribute interface.
+ */
+export function instanceOfUpdateAttribute(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function UpdateAttributeFromJSON(json: any): UpdateAttribute {
+  return UpdateAttributeFromJSONTyped(json, false);
+}
+
+export function UpdateAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateAttribute {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    value: !exists(json, 'value') ? undefined : json['value'],
+    enumeration: !exists(json, 'enumeration')
+      ? undefined
+      : (json['enumeration'] as Array<any>).map(UpdateAttributeEnumerationInnerFromJSON),
+  };
+}
+
+export function UpdateAttributeToJSON(value?: UpdateAttribute | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    value: value.value,
+    enumeration: value.enumeration === undefined ? undefined : (value.enumeration as Array<any>).map(UpdateAttributeEnumerationInnerToJSON),
+  };
+}

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

@@ -0,0 +1,70 @@
+/* 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 UpdateAttributeEnumerationInner
+ */
+export interface UpdateAttributeEnumerationInner {
+  /**
+   * Id of the value
+   * @type {number}
+   * @memberof UpdateAttributeEnumerationInner
+   */
+  value: number;
+  /**
+   * Label of the value
+   * @type {string}
+   * @memberof UpdateAttributeEnumerationInner
+   */
+  label: string;
+}
+
+/**
+ * Check if a given object implements the UpdateAttributeEnumerationInner interface.
+ */
+export function instanceOfUpdateAttributeEnumerationInner(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'value' in value;
+  isInstance = isInstance && 'label' in value;
+
+  return isInstance;
+}
+
+export function UpdateAttributeEnumerationInnerFromJSON(json: any): UpdateAttributeEnumerationInner {
+  return UpdateAttributeEnumerationInnerFromJSONTyped(json, false);
+}
+
+export function UpdateAttributeEnumerationInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateAttributeEnumerationInner {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    value: json['value'],
+    label: json['label'],
+  };
+}
+
+export function UpdateAttributeEnumerationInnerToJSON(value?: UpdateAttributeEnumerationInner | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    value: value.value,
+    label: value.label,
+  };
+}

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

@@ -0,0 +1,77 @@
+/* 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';
+
+/**
+ * Status of the campaign
+ * @export
+ * @interface UpdateCampaignStatus
+ */
+export interface UpdateCampaignStatus {
+  /**
+   * Note:- replicateTemplate status will be available only for template type campaigns.
+   * @type {string}
+   * @memberof UpdateCampaignStatus
+   */
+  status?: UpdateCampaignStatusStatusEnum;
+}
+
+/**
+ * @export
+ * @enum {string}
+ */
+export enum UpdateCampaignStatusStatusEnum {
+  Suspended = 'suspended',
+  Archive = 'archive',
+  Darchive = 'darchive',
+  Sent = 'sent',
+  Queued = 'queued',
+  Replicate = 'replicate',
+  ReplicateTemplate = 'replicateTemplate',
+  Draft = 'draft',
+}
+
+/**
+ * Check if a given object implements the UpdateCampaignStatus interface.
+ */
+export function instanceOfUpdateCampaignStatus(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function UpdateCampaignStatusFromJSON(json: any): UpdateCampaignStatus {
+  return UpdateCampaignStatusFromJSONTyped(json, false);
+}
+
+export function UpdateCampaignStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateCampaignStatus {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    status: !exists(json, 'status') ? undefined : json['status'],
+  };
+}
+
+export function UpdateCampaignStatusToJSON(value?: UpdateCampaignStatus | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    status: value.status,
+  };
+}