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

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

@@ -0,0 +1,92 @@
+/* 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 { GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription } from './GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription.js';
+import {
+  GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscriptionFromJSON,
+  GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscriptionToJSON,
+} from './GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription.js';
+import type { GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription } from './GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription.js';
+import {
+  GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscriptionFromJSON,
+  GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscriptionToJSON,
+} from './GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription.js';
+
+/**
+ *
+ * @export
+ * @interface GetContactCampaignStatsUnsubscriptions
+ */
+export interface GetContactCampaignStatsUnsubscriptions {
+  /**
+   * Contact has unsubscribed via the unsubscription link in the email
+   * @type {Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription>}
+   * @memberof GetContactCampaignStatsUnsubscriptions
+   */
+  userUnsubscription: Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription>;
+  /**
+   * Contact has been unsubscribed from the administrator
+   * @type {Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription>}
+   * @memberof GetContactCampaignStatsUnsubscriptions
+   */
+  adminUnsubscription: Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription>;
+}
+
+/**
+ * Check if a given object implements the GetContactCampaignStatsUnsubscriptions interface.
+ */
+export function instanceOfGetContactCampaignStatsUnsubscriptions(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'userUnsubscription' in value;
+  isInstance = isInstance && 'adminUnsubscription' in value;
+
+  return isInstance;
+}
+
+export function GetContactCampaignStatsUnsubscriptionsFromJSON(json: any): GetContactCampaignStatsUnsubscriptions {
+  return GetContactCampaignStatsUnsubscriptionsFromJSONTyped(json, false);
+}
+
+export function GetContactCampaignStatsUnsubscriptionsFromJSONTyped(
+  json: any,
+  ignoreDiscriminator: boolean,
+): GetContactCampaignStatsUnsubscriptions {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    userUnsubscription: (json['userUnsubscription'] as Array<any>).map(
+      GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscriptionFromJSON,
+    ),
+    adminUnsubscription: (json['adminUnsubscription'] as Array<any>).map(
+      GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscriptionFromJSON,
+    ),
+  };
+}
+
+export function GetContactCampaignStatsUnsubscriptionsToJSON(value?: GetContactCampaignStatsUnsubscriptions | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    userUnsubscription: (value.userUnsubscription as Array<any>).map(
+      GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscriptionToJSON,
+    ),
+    adminUnsubscription: (value.adminUnsubscription as Array<any>).map(
+      GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscriptionToJSON,
+    ),
+  };
+}

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

@@ -0,0 +1,133 @@
+/* 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 GetContactDetails
+ */
+export interface GetContactDetails {
+  /**
+   * Email address of the contact for which you requested the details
+   * @type {string}
+   * @memberof GetContactDetails
+   */
+  email?: string;
+  /**
+   * ID of the contact for which you requested the details
+   * @type {number}
+   * @memberof GetContactDetails
+   */
+  id: number;
+  /**
+   * Blacklist status for email campaigns (true=blacklisted, false=not blacklisted)
+   * @type {boolean}
+   * @memberof GetContactDetails
+   */
+  emailBlacklisted: boolean;
+  /**
+   * Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted)
+   * @type {boolean}
+   * @memberof GetContactDetails
+   */
+  smsBlacklisted: boolean;
+  /**
+   * Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @type {Date}
+   * @memberof GetContactDetails
+   */
+  createdAt: Date;
+  /**
+   * Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @type {Date}
+   * @memberof GetContactDetails
+   */
+  modifiedAt: Date;
+  /**
+   *
+   * @type {Array<number>}
+   * @memberof GetContactDetails
+   */
+  listIds: Array<number>;
+  /**
+   *
+   * @type {Array<number>}
+   * @memberof GetContactDetails
+   */
+  listUnsubscribed?: Array<number>;
+  /**
+   * Set of attributes of the contact
+   * @type {object}
+   * @memberof GetContactDetails
+   */
+  attributes: object;
+}
+
+/**
+ * Check if a given object implements the GetContactDetails interface.
+ */
+export function instanceOfGetContactDetails(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'id' in value;
+  isInstance = isInstance && 'emailBlacklisted' in value;
+  isInstance = isInstance && 'smsBlacklisted' in value;
+  isInstance = isInstance && 'createdAt' in value;
+  isInstance = isInstance && 'modifiedAt' in value;
+  isInstance = isInstance && 'listIds' in value;
+  isInstance = isInstance && 'attributes' in value;
+
+  return isInstance;
+}
+
+export function GetContactDetailsFromJSON(json: any): GetContactDetails {
+  return GetContactDetailsFromJSONTyped(json, false);
+}
+
+export function GetContactDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContactDetails {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    email: !exists(json, 'email') ? undefined : json['email'],
+    id: json['id'],
+    emailBlacklisted: json['emailBlacklisted'],
+    smsBlacklisted: json['smsBlacklisted'],
+    createdAt: new Date(json['createdAt']),
+    modifiedAt: new Date(json['modifiedAt']),
+    listIds: json['listIds'],
+    listUnsubscribed: !exists(json, 'listUnsubscribed') ? undefined : json['listUnsubscribed'],
+    attributes: json['attributes'],
+  };
+}
+
+export function GetContactDetailsToJSON(value?: GetContactDetails | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    email: value.email,
+    id: value.id,
+    emailBlacklisted: value.emailBlacklisted,
+    smsBlacklisted: value.smsBlacklisted,
+    createdAt: value.createdAt.toISOString(),
+    modifiedAt: value.modifiedAt.toISOString(),
+    listIds: value.listIds,
+    listUnsubscribed: value.listUnsubscribed,
+    attributes: value.attributes,
+  };
+}

package/src/brevo/generated/models/GetContacts.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 type { GetContactDetails } from './GetContactDetails.js';
+import { GetContactDetailsFromJSON, GetContactDetailsToJSON } from './GetContactDetails.js';
+
+/**
+ *
+ * @export
+ * @interface GetContacts
+ */
+export interface GetContacts {
+  /**
+   *
+   * @type {Array<GetContactDetails>}
+   * @memberof GetContacts
+   */
+  contacts: Array<GetContactDetails>;
+  /**
+   * Number of contacts
+   * @type {number}
+   * @memberof GetContacts
+   */
+  count: number;
+}
+
+/**
+ * Check if a given object implements the GetContacts interface.
+ */
+export function instanceOfGetContacts(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'contacts' in value;
+  isInstance = isInstance && 'count' in value;
+
+  return isInstance;
+}
+
+export function GetContactsFromJSON(json: any): GetContacts {
+  return GetContactsFromJSONTyped(json, false);
+}
+
+export function GetContactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContacts {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    contacts: (json['contacts'] as Array<any>).map(GetContactDetailsFromJSON),
+    count: json['count'],
+  };
+}
+
+export function GetContactsToJSON(value?: GetContacts | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    contacts: (value.contacts as Array<any>).map(GetContactDetailsToJSON),
+    count: value.count,
+  };
+}

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

@@ -0,0 +1,88 @@
+/* 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 GetDeviceBrowserStats
+ */
+export interface GetDeviceBrowserStats {
+  /**
+   * Number of total clicks for the campaign using the particular browser
+   * @type {number}
+   * @memberof GetDeviceBrowserStats
+   */
+  clickers: number;
+  /**
+   * Number of unique clicks for the campaign using the particular browser
+   * @type {number}
+   * @memberof GetDeviceBrowserStats
+   */
+  uniqueClicks: number;
+  /**
+   * Number of openings for the campaign using the particular browser
+   * @type {number}
+   * @memberof GetDeviceBrowserStats
+   */
+  viewed: number;
+  /**
+   * Number of unique openings for the campaign using the particular browser
+   * @type {number}
+   * @memberof GetDeviceBrowserStats
+   */
+  uniqueViews: number;
+}
+
+/**
+ * Check if a given object implements the GetDeviceBrowserStats interface.
+ */
+export function instanceOfGetDeviceBrowserStats(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'clickers' in value;
+  isInstance = isInstance && 'uniqueClicks' in value;
+  isInstance = isInstance && 'viewed' in value;
+  isInstance = isInstance && 'uniqueViews' in value;
+
+  return isInstance;
+}
+
+export function GetDeviceBrowserStatsFromJSON(json: any): GetDeviceBrowserStats {
+  return GetDeviceBrowserStatsFromJSONTyped(json, false);
+}
+
+export function GetDeviceBrowserStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetDeviceBrowserStats {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    clickers: json['clickers'],
+    uniqueClicks: json['uniqueClicks'],
+    viewed: json['viewed'],
+    uniqueViews: json['uniqueViews'],
+  };
+}
+
+export function GetDeviceBrowserStatsToJSON(value?: GetDeviceBrowserStats | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    clickers: value.clickers,
+    uniqueClicks: value.uniqueClicks,
+    viewed: value.viewed,
+    uniqueViews: value.uniqueViews,
+  };
+}