reach-api-sdk 1.0.187 → 1.0.188

package/dist/reach-sdk.d.ts

@@ -2062,7 +2062,7 @@ type Customer = {
     /**
      * Gets or sets the email.
      */
-    email?: string | null;
+    displayEmail?: string | null;
     /**
      * Gets or sets the phone number.
      */
@@ -10053,7 +10053,7 @@ declare class CustomersService {
      * @returns any OK
      * @throws ApiError
      */
-    exportToCsv({ wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
+    exportToCsv({ wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
         /**
          * Gets or sets the wildcard for use in a query search.
          */
@@ -10061,7 +10061,7 @@ declare class CustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */
@@ -10135,7 +10135,7 @@ declare class CustomersService {
      * @returns any OK
      * @throws ApiError
      */
-    exportToXlsx({ wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
+    exportToXlsx({ wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
         /**
          * Gets or sets the wildcard for use in a query search.
          */
@@ -10143,7 +10143,7 @@ declare class CustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */
@@ -10271,7 +10271,7 @@ declare class CustomersService {
      * @returns CustomerPage OK
      * @throws ApiError
      */
-    getPage({ wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
+    getPage({ wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
         /**
          * Gets or sets the wildcard for use in a query search.
          */
@@ -10279,7 +10279,7 @@ declare class CustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */
@@ -10379,7 +10379,7 @@ declare class CustomersService {
      * @returns boolean OK
      * @throws ApiError
      */
-    exists({ wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
+    exists({ wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
         /**
          * Gets or sets the wildcard for use in a query search.
          */
@@ -10387,7 +10387,7 @@ declare class CustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */
@@ -10454,7 +10454,7 @@ declare class CustomersService {
      * @returns Customer OK
      * @throws ApiError
      */
-    getListWithoutReferences({ wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
+    getListWithoutReferences({ wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
         /**
          * Gets or sets the wildcard for use in a query search.
          */
@@ -10462,7 +10462,7 @@ declare class CustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */
@@ -10529,7 +10529,7 @@ declare class CustomersService {
      * @returns Customer OK
      * @throws ApiError
      */
-    getListIdName({ wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
+    getListIdName({ wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
         /**
          * Gets or sets the wildcard for use in a query search.
          */
@@ -10537,7 +10537,7 @@ declare class CustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */
@@ -27601,7 +27601,7 @@ declare class PublicCustomersService {
      * @returns CustomerPage OK
      * @throws ApiError
      */
-    getPage({ xTenantSubdomain, wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
+    getPage({ xTenantSubdomain, wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
         xTenantSubdomain?: string;
         /**
          * Gets or sets the wildcard for use in a query search.
@@ -27610,7 +27610,7 @@ declare class PublicCustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */
@@ -27737,7 +27737,7 @@ declare class PublicCustomersService {
      * @returns boolean OK
      * @throws ApiError
      */
-    exists({ xTenantSubdomain, wildcard, email, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
+    exists({ xTenantSubdomain, wildcard, displayEmail, venueId, programmeId, marketingOptIn, isActiveCustomer, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
         /**
          * The tenants subdomain.
          */
@@ -27749,7 +27749,7 @@ declare class PublicCustomersService {
         /**
          * Gets or sets the customers email for use in a query search.
          */
-        email?: string;
+        displayEmail?: string;
         /**
          * Gets or sets the venue id for use in a query search.
          */

package/dist/reach-sdk.js

@@ -4692,7 +4692,7 @@ const request = (config, options, axiosClient = axios) => {
    */
   exportToCsv({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -4715,7 +4715,7 @@ const request = (config, options, axiosClient = axios) => {
       url: "/api/customers/export/csv",
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -4749,7 +4749,7 @@ const request = (config, options, axiosClient = axios) => {
    */
   exportToXlsx({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -4772,7 +4772,7 @@ const request = (config, options, axiosClient = axios) => {
       url: "/api/customers/export/xlsx",
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -4905,7 +4905,7 @@ const request = (config, options, axiosClient = axios) => {
    */
   getPage({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -4927,7 +4927,7 @@ const request = (config, options, axiosClient = axios) => {
       url: "/api/customers",
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -5021,7 +5021,7 @@ const request = (config, options, axiosClient = axios) => {
    */
   exists({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -5043,7 +5043,7 @@ const request = (config, options, axiosClient = axios) => {
       url: "/api/customers/exists",
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -5074,7 +5074,7 @@ const request = (config, options, axiosClient = axios) => {
    */
   getListWithoutReferences({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -5096,7 +5096,7 @@ const request = (config, options, axiosClient = axios) => {
       url: "/api/customers/without-references",
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -5127,7 +5127,7 @@ const request = (config, options, axiosClient = axios) => {
    */
   getListIdName({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -5149,7 +5149,7 @@ const request = (config, options, axiosClient = axios) => {
       url: "/api/customers/id-name",
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -18447,7 +18447,7 @@ const request = (config, options, axiosClient = axios) => {
   getPage({
     xTenantSubdomain,
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -18472,7 +18472,7 @@ const request = (config, options, axiosClient = axios) => {
       },
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -18600,7 +18600,7 @@ const request = (config, options, axiosClient = axios) => {
   exists({
     xTenantSubdomain,
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -18625,7 +18625,7 @@ const request = (config, options, axiosClient = axios) => {
       },
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reach-api-sdk",
-  "version": "1.0.187",
+  "version": "1.0.188",
   "description": "sdk for reach api",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/definition/swagger.yaml

@@ -12971,7 +12971,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -13127,7 +13127,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -13617,7 +13617,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -13948,7 +13948,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -14101,7 +14101,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -14260,7 +14260,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -54258,7 +54258,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -54708,7 +54708,7 @@ paths:
           description: Gets or sets the wildcard for use in a query search.
           schema:
             type: string
-        - name: Email
+        - name: DisplayEmail
           in: query
           description: Gets or sets the customers email for use in a query search.
           schema:
@@ -122476,7 +122476,7 @@ components:
           type: string
           description: Gets or sets the organisation name.
           nullable: true
-        email:
+        displayEmail:
           type: string
           description: Gets or sets the email.
           nullable: true

package/src/models/Customer.ts

@@ -63,7 +63,7 @@ export type Customer = {
   /**
    * Gets or sets the email.
    */
-  email?: string | null;
+  displayEmail?: string | null;
   /**
    * Gets or sets the phone number.
    */

package/src/services/CustomersService.ts

@@ -84,7 +84,7 @@ export class CustomersService {
    */
   public exportToCsv({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -109,7 +109,7 @@ export class CustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -182,7 +182,7 @@ export class CustomersService {
       url: '/api/customers/export/csv',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -217,7 +217,7 @@ export class CustomersService {
    */
   public exportToXlsx({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -242,7 +242,7 @@ export class CustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -315,7 +315,7 @@ export class CustomersService {
       url: '/api/customers/export/xlsx',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -479,7 +479,7 @@ export class CustomersService {
    */
   public getPage({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -503,7 +503,7 @@ export class CustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -570,7 +570,7 @@ export class CustomersService {
       url: '/api/customers',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -683,7 +683,7 @@ export class CustomersService {
    */
   public exists({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -707,7 +707,7 @@ export class CustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -774,7 +774,7 @@ export class CustomersService {
       url: '/api/customers/exists',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -806,7 +806,7 @@ export class CustomersService {
    */
   public getListWithoutReferences({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -830,7 +830,7 @@ export class CustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -897,7 +897,7 @@ export class CustomersService {
       url: '/api/customers/without-references',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -929,7 +929,7 @@ export class CustomersService {
    */
   public getListIdName({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -953,7 +953,7 @@ export class CustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -1020,7 +1020,7 @@ export class CustomersService {
       url: '/api/customers/id-name',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,

package/src/services/PublicCustomersService.ts

@@ -84,7 +84,7 @@ export class PublicCustomersService {
   public getPage({
     xTenantSubdomain,
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -109,7 +109,7 @@ export class PublicCustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -179,7 +179,7 @@ export class PublicCustomersService {
       },
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
@@ -348,7 +348,7 @@ export class PublicCustomersService {
   public exists({
     xTenantSubdomain,
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
@@ -376,7 +376,7 @@ export class PublicCustomersService {
     /**
      * Gets or sets the customers email for use in a query search.
      */
-    email?: string;
+    displayEmail?: string;
     /**
      * Gets or sets the venue id for use in a query search.
      */
@@ -446,7 +446,7 @@ export class PublicCustomersService {
       },
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,