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

package/src/brevo/generated/models/CreateEmailCampaignRecipients.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.
+ */
+
+import { exists } from '../runtime.js';
+
+/**
+ * List ids to include/exclude from campaign
+ * @export
+ * @interface CreateEmailCampaignRecipients
+ */
+export interface CreateEmailCampaignRecipients {
+  /**
+   * List ids to exclude from the campaign
+   * @type {Array<number>}
+   * @memberof CreateEmailCampaignRecipients
+   */
+  exclusionListIds?: Array<number>;
+  /**
+   * Mandatory if scheduledAt is not empty. List Ids to send the campaign to
+   * @type {Array<number>}
+   * @memberof CreateEmailCampaignRecipients
+   */
+  listIds?: Array<number>;
+}
+
+/**
+ * Check if a given object implements the CreateEmailCampaignRecipients interface.
+ */
+export function instanceOfCreateEmailCampaignRecipients(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function CreateEmailCampaignRecipientsFromJSON(json: any): CreateEmailCampaignRecipients {
+  return CreateEmailCampaignRecipientsFromJSONTyped(json, false);
+}
+
+export function CreateEmailCampaignRecipientsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateEmailCampaignRecipients {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    exclusionListIds: !exists(json, 'exclusionListIds') ? undefined : json['exclusionListIds'],
+    listIds: !exists(json, 'listIds') ? undefined : json['listIds'],
+  };
+}
+
+export function CreateEmailCampaignRecipientsToJSON(value?: CreateEmailCampaignRecipients | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    exclusionListIds: value.exclusionListIds,
+    listIds: value.listIds,
+  };
+}

package/src/brevo/generated/models/CreateEmailCampaignSender.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 CreateEmailCampaignSender
+ */
+export interface CreateEmailCampaignSender {
+  /**
+   * Sender Name
+   * @type {string}
+   * @memberof CreateEmailCampaignSender
+   */
+  name?: string;
+  /**
+   * Sender email
+   * @type {string}
+   * @memberof CreateEmailCampaignSender
+   */
+  email?: string;
+  /**
+   * Select the sender for the campaign 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 CreateEmailCampaignSender
+   */
+  id?: number;
+}
+
+/**
+ * Check if a given object implements the CreateEmailCampaignSender interface.
+ */
+export function instanceOfCreateEmailCampaignSender(value: object): boolean {
+  let isInstance = true;
+
+  return isInstance;
+}
+
+export function CreateEmailCampaignSenderFromJSON(json: any): CreateEmailCampaignSender {
+  return CreateEmailCampaignSenderFromJSONTyped(json, false);
+}
+
+export function CreateEmailCampaignSenderFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateEmailCampaignSender {
+  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 CreateEmailCampaignSenderToJSON(value?: CreateEmailCampaignSender | 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/CreateList.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 CreateList
+ */
+export interface CreateList {
+  /**
+   * Name of the list
+   * @type {string}
+   * @memberof CreateList
+   */
+  name: string;
+  /**
+   * Id of the parent folder in which this list is to be created
+   * @type {number}
+   * @memberof CreateList
+   */
+  folderId: number;
+}
+
+/**
+ * Check if a given object implements the CreateList interface.
+ */
+export function instanceOfCreateList(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'name' in value;
+  isInstance = isInstance && 'folderId' in value;
+
+  return isInstance;
+}
+
+export function CreateListFromJSON(json: any): CreateList {
+  return CreateListFromJSONTyped(json, false);
+}
+
+export function CreateListFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateList {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    name: json['name'],
+    folderId: json['folderId'],
+  };
+}
+
+export function CreateListToJSON(value?: CreateList | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    name: value.name,
+    folderId: value.folderId,
+  };
+}

package/src/brevo/generated/models/CreateModel.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 CreateModel
+ */
+export interface CreateModel {
+  /**
+   * ID of the object created
+   * @type {number}
+   * @memberof CreateModel
+   */
+  id: number;
+}
+
+/**
+ * Check if a given object implements the CreateModel interface.
+ */
+export function instanceOfCreateModel(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'id' in value;
+
+  return isInstance;
+}
+
+export function CreateModelFromJSON(json: any): CreateModel {
+  return CreateModelFromJSONTyped(json, false);
+}
+
+export function CreateModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateModel {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    id: json['id'],
+  };
+}
+
+export function CreateModelToJSON(value?: CreateModel | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    id: value.id,
+  };
+}

package/src/brevo/generated/models/CreateReseller.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 CreateReseller
+ */
+export interface CreateReseller {
+  /**
+   * AuthKey of Reseller child created
+   * @type {string}
+   * @memberof CreateReseller
+   */
+  authKey: string;
+  /**
+   * Id of Reseller child created
+   * @type {number}
+   * @memberof CreateReseller
+   */
+  id?: number;
+}
+
+/**
+ * Check if a given object implements the CreateReseller interface.
+ */
+export function instanceOfCreateReseller(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'authKey' in value;
+
+  return isInstance;
+}
+
+export function CreateResellerFromJSON(json: any): CreateReseller {
+  return CreateResellerFromJSONTyped(json, false);
+}
+
+export function CreateResellerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateReseller {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    authKey: json['authKey'],
+    id: !exists(json, 'id') ? undefined : json['id'],
+  };
+}
+
+export function CreateResellerToJSON(value?: CreateReseller | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    authKey: value.authKey,
+    id: value.id,
+  };
+}

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

@@ -0,0 +1,82 @@
+/* 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 { CreateSenderIpsInner } from './CreateSenderIpsInner.js';
+import { CreateSenderIpsInnerFromJSON, CreateSenderIpsInnerToJSON } from './CreateSenderIpsInner.js';
+
+/**
+ *
+ * @export
+ * @interface CreateSender
+ */
+export interface CreateSender {
+  /**
+   * From Name to use for the sender
+   * @type {string}
+   * @memberof CreateSender
+   */
+  name: string;
+  /**
+   * From email to use for the sender. A verification email will be sent to this address.
+   * @type {string}
+   * @memberof CreateSender
+   */
+  email: string;
+  /**
+   * Mandatory in case of dedicated IP, IPs to associate to the sender
+   * @type {Array<CreateSenderIpsInner>}
+   * @memberof CreateSender
+   */
+  ips?: Array<CreateSenderIpsInner>;
+}
+
+/**
+ * Check if a given object implements the CreateSender interface.
+ */
+export function instanceOfCreateSender(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'name' in value;
+  isInstance = isInstance && 'email' in value;
+
+  return isInstance;
+}
+
+export function CreateSenderFromJSON(json: any): CreateSender {
+  return CreateSenderFromJSONTyped(json, false);
+}
+
+export function CreateSenderFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSender {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    name: json['name'],
+    email: json['email'],
+    ips: !exists(json, 'ips') ? undefined : (json['ips'] as Array<any>).map(CreateSenderIpsInnerFromJSON),
+  };
+}
+
+export function CreateSenderToJSON(value?: CreateSender | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    name: value.name,
+    email: value.email,
+    ips: value.ips === undefined ? undefined : (value.ips as Array<any>).map(CreateSenderIpsInnerToJSON),
+  };
+}

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

@@ -0,0 +1,80 @@
+/* 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 CreateSenderIpsInner
+ */
+export interface CreateSenderIpsInner {
+  /**
+   * Dedicated IP available in your account
+   * @type {string}
+   * @memberof CreateSenderIpsInner
+   */
+  ip: string;
+  /**
+   * Domain of the IP
+   * @type {string}
+   * @memberof CreateSenderIpsInner
+   */
+  domain: string;
+  /**
+   * Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs.
+   * @type {number}
+   * @memberof CreateSenderIpsInner
+   */
+  weight?: number;
+}
+
+/**
+ * Check if a given object implements the CreateSenderIpsInner interface.
+ */
+export function instanceOfCreateSenderIpsInner(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'ip' in value;
+  isInstance = isInstance && 'domain' in value;
+
+  return isInstance;
+}
+
+export function CreateSenderIpsInnerFromJSON(json: any): CreateSenderIpsInner {
+  return CreateSenderIpsInnerFromJSONTyped(json, false);
+}
+
+export function CreateSenderIpsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSenderIpsInner {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    ip: json['ip'],
+    domain: json['domain'],
+    weight: !exists(json, 'weight') ? undefined : json['weight'],
+  };
+}
+
+export function CreateSenderIpsInnerToJSON(value?: CreateSenderIpsInner | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    ip: value.ip,
+    domain: value.domain,
+    weight: value.weight,
+  };
+}

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

@@ -0,0 +1,79 @@
+/* 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 CreateSenderModel
+ */
+export interface CreateSenderModel {
+  /**
+   * ID of the Sender created
+   * @type {number}
+   * @memberof CreateSenderModel
+   */
+  id: number;
+  /**
+   * Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured)
+   * @type {boolean}
+   * @memberof CreateSenderModel
+   */
+  spfError?: boolean;
+  /**
+   * Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured)
+   * @type {boolean}
+   * @memberof CreateSenderModel
+   */
+  dkimError?: boolean;
+}
+
+/**
+ * Check if a given object implements the CreateSenderModel interface.
+ */
+export function instanceOfCreateSenderModel(value: object): boolean {
+  let isInstance = true;
+  isInstance = isInstance && 'id' in value;
+
+  return isInstance;
+}
+
+export function CreateSenderModelFromJSON(json: any): CreateSenderModel {
+  return CreateSenderModelFromJSONTyped(json, false);
+}
+
+export function CreateSenderModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSenderModel {
+  if (json === undefined || json === null) {
+    return json;
+  }
+  return {
+    id: json['id'],
+    spfError: !exists(json, 'spfError') ? undefined : json['spfError'],
+    dkimError: !exists(json, 'dkimError') ? undefined : json['dkimError'],
+  };
+}
+
+export function CreateSenderModelToJSON(value?: CreateSenderModel | null): any {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    id: value.id,
+    spfError: value.spfError,
+    dkimError: value.dkimError,
+  };
+}