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

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

@@ -0,0 +1,115 @@
+/* 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 GetSmsCampaignStats
+ */
+export interface GetSmsCampaignStats {
+  /**
+   * Number of delivered SMS
+   * @type {number}
+   * @memberof GetSmsCampaignStats
+   */
+  delivered: number;
+  /**
+   * Number of sent SMS
+   * @type {number}
+   * @memberof GetSmsCampaignStats
+   */
+  sent: number;
+  /**
+   * Number of processing SMS
+   * @type {number}
+   * @memberof GetSmsCampaignStats
+   */
+  processing: number;
+  /**
+   * Number of softbounced SMS
+   * @type {number}
+   * @memberof GetSmsCampaignStats
+   */
+  softBounces: number;
+  /**
+   * Number of hardbounced SMS
+   * @type {number}
+   * @memberof GetSmsCampaignStats
+   */
+  hardBounces: number;
+  /**
+   * Number of unsubscription SMS
+   * @type {number}
+   * @memberof GetSmsCampaignStats
+   */
+  unsubscriptions: number;
+  /**
+   * Number of replies to the SMS
+   * @type {number}
+   * @memberof GetSmsCampaignStats
+   */
+  answered: number;
+}
+
+/**
+ * Check if a given object implements the GetSmsCampaignStats interface.
+ */
+export function instanceOfGetSmsCampaignStats(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'delivered' in value;
+  isInstance = isInstance && 'sent' in value;
+  isInstance = isInstance && 'processing' in value;
+  isInstance = isInstance && 'softBounces' in value;
+  isInstance = isInstance && 'hardBounces' in value;
+  isInstance = isInstance && 'unsubscriptions' in value;
+  isInstance = isInstance && 'answered' in value;
+
+  return isInstance;
+}
+
+export function GetSmsCampaignStatsFromJSON(json: any): GetSmsCampaignStats {
+  return GetSmsCampaignStatsFromJSONTyped(json, false);
+}
+
+export function GetSmsCampaignStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSmsCampaignStats {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    delivered: json['delivered'],
+    sent: json['sent'],
+    processing: json['processing'],
+    softBounces: json['softBounces'],
+    hardBounces: json['hardBounces'],
+    unsubscriptions: json['unsubscriptions'],
+    answered: json['answered'],
+  };
+}
+
+export function GetSmsCampaignStatsToJSON(value?: GetSmsCampaignStats | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    delivered: value.delivered,
+    sent: value.sent,
+    processing: value.processing,
+    softBounces: value.softBounces,
+    hardBounces: value.hardBounces,
+    unsubscriptions: value.unsubscriptions,
+    answered: value.answered,
+  };
+}

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

@@ -0,0 +1,73 @@
+/* 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 { GetSmsCampaignsCampaignsInner } from './GetSmsCampaignsCampaignsInner.js';
+import { GetSmsCampaignsCampaignsInnerFromJSON, GetSmsCampaignsCampaignsInnerToJSON } from './GetSmsCampaignsCampaignsInner.js';
+
+/**
+ *
+ * @export
+ * @interface GetSmsCampaigns
+ */
+export interface GetSmsCampaigns {
+  /**
+   *
+   * @type {Array<GetSmsCampaignsCampaignsInner>}
+   * @memberof GetSmsCampaigns
+   */
+  campaigns?: Array<GetSmsCampaignsCampaignsInner>;
+  /**
+   * Number of SMS campaigns retrieved
+   * @type {number}
+   * @memberof GetSmsCampaigns
+   */
+  count: number;
+}
+
+/**
+ * Check if a given object implements the GetSmsCampaigns interface.
+ */
+export function instanceOfGetSmsCampaigns(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'count' in value;
+
+  return isInstance;
+}
+
+export function GetSmsCampaignsFromJSON(json: any): GetSmsCampaigns {
+  return GetSmsCampaignsFromJSONTyped(json, false);
+}
+
+export function GetSmsCampaignsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSmsCampaigns {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    campaigns: !exists(json, 'campaigns') ? undefined : (json['campaigns'] as Array<any>).map(GetSmsCampaignsCampaignsInnerFromJSON),
+    count: json['count'],
+  };
+}
+
+export function GetSmsCampaignsToJSON(value?: GetSmsCampaigns | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    campaigns: value.campaigns === undefined ? undefined : (value.campaigns as Array<any>).map(GetSmsCampaignsCampaignsInnerToJSON),
+    count: value.count,
+  };
+}

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

@@ -0,0 +1,160 @@
+/* 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 type { GetCampaignRecipients } from './GetCampaignRecipients.js';
+import { GetCampaignRecipientsFromJSON, GetCampaignRecipientsToJSON } from './GetCampaignRecipients.js';
+import type { GetSmsCampaignStats } from './GetSmsCampaignStats.js';
+import { GetSmsCampaignStatsFromJSON, GetSmsCampaignStatsToJSON } from './GetSmsCampaignStats.js';
+
+/**
+ *
+ * @export
+ * @interface GetSmsCampaignsCampaignsInner
+ */
+export interface GetSmsCampaignsCampaignsInner {
+  /**
+   * ID of the SMS Campaign
+   * @type {number}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  id: number;
+  /**
+   * Name of the SMS Campaign
+   * @type {string}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  name: string;
+  /**
+   * Status of the SMS Campaign
+   * @type {string}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  status: GetSmsCampaignsCampaignsInnerStatusEnum;
+  /**
+   * Content of the SMS Campaign
+   * @type {string}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  content: string;
+  /**
+   * UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
+   * @type {Date}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  scheduledAt: Date;
+  /**
+   * Sender of the SMS Campaign
+   * @type {string}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  sender: string;
+  /**
+   * Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @type {Date}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  createdAt: Date;
+  /**
+   * UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @type {Date}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  modifiedAt: Date;
+  /**
+   *
+   * @type {GetCampaignRecipients}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  recipients: GetCampaignRecipients;
+  /**
+   *
+   * @type {GetSmsCampaignStats}
+   * @memberof GetSmsCampaignsCampaignsInner
+   */
+  statistics: GetSmsCampaignStats;
+}
+
+/**
+ * @export
+ * @enum {string}
+ */
+export enum GetSmsCampaignsCampaignsInnerStatusEnum {
+  Draft = 'draft',
+  Sent = 'sent',
+  Archive = 'archive',
+  Queued = 'queued',
+  Suspended = 'suspended',
+  InProcess = 'inProcess',
+}
+
+/**
+ * Check if a given object implements the GetSmsCampaignsCampaignsInner interface.
+ */
+export function instanceOfGetSmsCampaignsCampaignsInner(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'id' in value;
+  isInstance = isInstance && 'name' in value;
+  isInstance = isInstance && 'status' in value;
+  isInstance = isInstance && 'content' in value;
+  isInstance = isInstance && 'scheduledAt' in value;
+  isInstance = isInstance && 'sender' in value;
+  isInstance = isInstance && 'createdAt' in value;
+  isInstance = isInstance && 'modifiedAt' in value;
+  isInstance = isInstance && 'recipients' in value;
+  isInstance = isInstance && 'statistics' in value;
+
+  return isInstance;
+}
+
+export function GetSmsCampaignsCampaignsInnerFromJSON(json: any): GetSmsCampaignsCampaignsInner {
+  return GetSmsCampaignsCampaignsInnerFromJSONTyped(json, false);
+}
+
+export function GetSmsCampaignsCampaignsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSmsCampaignsCampaignsInner {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    id: json['id'],
+    name: json['name'],
+    status: json['status'],
+    content: json['content'],
+    scheduledAt: new Date(json['scheduledAt']),
+    sender: json['sender'],
+    createdAt: new Date(json['createdAt']),
+    modifiedAt: new Date(json['modifiedAt']),
+    recipients: GetCampaignRecipientsFromJSON(json['recipients']),
+    statistics: GetSmsCampaignStatsFromJSON(json['statistics']),
+  };
+}
+
+export function GetSmsCampaignsCampaignsInnerToJSON(value?: GetSmsCampaignsCampaignsInner | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    id: value.id,
+    name: value.name,
+    status: value.status,
+    content: value.content,
+    scheduledAt: value.scheduledAt.toISOString(),
+    sender: value.sender,
+    createdAt: value.createdAt.toISOString(),
+    modifiedAt: value.modifiedAt.toISOString(),
+    recipients: GetCampaignRecipientsToJSON(value.recipients),
+    statistics: GetSmsCampaignStatsToJSON(value.statistics),
+  };
+}

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

@@ -0,0 +1,64 @@
+/* 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 { GetSmsEventReportEventsInner } from './GetSmsEventReportEventsInner.js';
+import { GetSmsEventReportEventsInnerFromJSON, GetSmsEventReportEventsInnerToJSON } from './GetSmsEventReportEventsInner.js';
+
+/**
+ *
+ * @export
+ * @interface GetSmsEventReport
+ */
+export interface GetSmsEventReport {
+  /**
+   *
+   * @type {Array<GetSmsEventReportEventsInner>}
+   * @memberof GetSmsEventReport
+   */
+  events?: Array<GetSmsEventReportEventsInner>;
+}
+
+/**
+ * Check if a given object implements the GetSmsEventReport interface.
+ */
+export function instanceOfGetSmsEventReport(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function GetSmsEventReportFromJSON(json: any): GetSmsEventReport {
+  return GetSmsEventReportFromJSONTyped(json, false);
+}
+
+export function GetSmsEventReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSmsEventReport {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    events: !exists(json, 'events') ? undefined : (json['events'] as Array<any>).map(GetSmsEventReportEventsInnerFromJSON),
+  };
+}
+
+export function GetSmsEventReportToJSON(value?: GetSmsEventReport | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    events: value.events === undefined ? undefined : (value.events as Array<any>).map(GetSmsEventReportEventsInnerToJSON),
+  };
+}

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

@@ -0,0 +1,131 @@
+/* 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 GetSmsEventReportEventsInner
+ */
+export interface GetSmsEventReportEventsInner {
+  /**
+   * Phone number which has generated the event
+   * @type {string}
+   * @memberof GetSmsEventReportEventsInner
+   */
+  phoneNumber: string;
+  /**
+   * UTC date-time on which the event has been generated
+   * @type {Date}
+   * @memberof GetSmsEventReportEventsInner
+   */
+  date: Date;
+  /**
+   * Message ID which generated the event
+   * @type {string}
+   * @memberof GetSmsEventReportEventsInner
+   */
+  messageId: string;
+  /**
+   * Event which occurred
+   * @type {string}
+   * @memberof GetSmsEventReportEventsInner
+   */
+  event: GetSmsEventReportEventsInnerEventEnum;
+  /**
+   * Reason of bounce (only available if the event is hardbounce or softbounce)
+   * @type {string}
+   * @memberof GetSmsEventReportEventsInner
+   */
+  reason?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof GetSmsEventReportEventsInner
+   */
+  reply?: string;
+  /**
+   * Tag of the SMS which generated the event
+   * @type {string}
+   * @memberof GetSmsEventReportEventsInner
+   */
+  tag?: string;
+}
+
+/**
+ * @export
+ * @enum {string}
+ */
+export enum GetSmsEventReportEventsInnerEventEnum {
+  Bounces = 'bounces',
+  HardBounces = 'hardBounces',
+  SoftBounces = 'softBounces',
+  Delivered = 'delivered',
+  Sent = 'sent',
+  Accepted = 'accepted',
+  Unsubscription = 'unsubscription',
+  Replies = 'replies',
+  Blocked = 'blocked',
+  Rejected = 'rejected',
+}
+
+/**
+ * Check if a given object implements the GetSmsEventReportEventsInner interface.
+ */
+export function instanceOfGetSmsEventReportEventsInner(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'phoneNumber' in value;
+  isInstance = isInstance && 'date' in value;
+  isInstance = isInstance && 'messageId' in value;
+  isInstance = isInstance && 'event' in value;
+
+  return isInstance;
+}
+
+export function GetSmsEventReportEventsInnerFromJSON(json: any): GetSmsEventReportEventsInner {
+  return GetSmsEventReportEventsInnerFromJSONTyped(json, false);
+}
+
+export function GetSmsEventReportEventsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSmsEventReportEventsInner {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    phoneNumber: json['phoneNumber'],
+    date: new Date(json['date']),
+    messageId: json['messageId'],
+    event: json['event'],
+    reason: !exists(json, 'reason') ? undefined : json['reason'],
+    reply: !exists(json, 'reply') ? undefined : json['reply'],
+    tag: !exists(json, 'tag') ? undefined : json['tag'],
+  };
+}
+
+export function GetSmsEventReportEventsInnerToJSON(value?: GetSmsEventReportEventsInner | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    phoneNumber: value.phoneNumber,
+    date: value.date.toISOString(),
+    messageId: value.messageId,
+    event: value.event,
+    reason: value.reason,
+    reply: value.reply,
+    tag: value.tag,
+  };
+}