reach-api-sdk 1.0.187 → 1.0.189

package/src/models/EndUserIdentitySecureToken.ts

@@ -0,0 +1,37 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Tenant } from './Tenant';
+
+/**
+ * Represents an end user identity within the Reach application.
+ */
+export type EndUserIdentitySecureToken = {
+  /**
+   * Gets or sets the activities Id.
+   */
+  id?: number;
+  /**
+   * Gets or sets the secure token.
+   */
+  token?: string | null;
+  /**
+   * Gets or sets the end user identity id.
+   */
+  endUserIdentityId?: string;
+  /**
+   * Gets or sets the tenant id.
+   */
+  tenantId?: string;
+  /**
+   * Gets or sets the date the resource was created.
+   */
+  dateCreated?: string;
+  /**
+   * Gets or sets a value indicating whether the token is active/revoked.
+   */
+  isActive?: boolean;
+  tenant?: Tenant;
+};

package/src/models/ResolveSecureAccessTokenRequest.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Models secure access token requests.
+ */
+export type ResolveSecureAccessTokenRequest = {
+  /**
+   * Gets or sets the token.
+   */
+  token?: string | null;
+};

package/src/services/CustomersService.ts

@@ -84,11 +84,12 @@ export class CustomersService {
    */
   public exportToCsv({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -109,7 +110,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.
      */
@@ -126,6 +127,10 @@ export class CustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -182,11 +187,12 @@ export class CustomersService {
       url: '/api/customers/export/csv',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -217,11 +223,12 @@ export class CustomersService {
    */
   public exportToXlsx({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -242,7 +249,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.
      */
@@ -259,6 +266,10 @@ export class CustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -315,11 +326,12 @@ export class CustomersService {
       url: '/api/customers/export/xlsx',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -479,11 +491,12 @@ export class CustomersService {
    */
   public getPage({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -503,7 +516,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.
      */
@@ -520,6 +533,10 @@ export class CustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -570,11 +587,12 @@ export class CustomersService {
       url: '/api/customers',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -683,11 +701,12 @@ export class CustomersService {
    */
   public exists({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -707,7 +726,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.
      */
@@ -724,6 +743,10 @@ export class CustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -774,11 +797,12 @@ export class CustomersService {
       url: '/api/customers/exists',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -806,11 +830,12 @@ export class CustomersService {
    */
   public getListWithoutReferences({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -830,7 +855,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.
      */
@@ -847,6 +872,10 @@ export class CustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -897,11 +926,12 @@ export class CustomersService {
       url: '/api/customers/without-references',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -929,11 +959,12 @@ export class CustomersService {
    */
   public getListIdName({
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -953,7 +984,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.
      */
@@ -970,6 +1001,10 @@ export class CustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1020,11 +1055,12 @@ export class CustomersService {
       url: '/api/customers/id-name',
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,

package/src/services/EndUserIdentitySecureTokenService.ts

@@ -0,0 +1,177 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { EndUserIdentitySecureToken } from '../models/EndUserIdentitySecureToken';
+import type { ResolveSecureAccessTokenRequest } from '../models/ResolveSecureAccessTokenRequest';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class EndUserIdentitySecureTokenService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Gets a Reach.Models.EndUserIdentitySecureToken by its Id.
+   * @returns EndUserIdentitySecureToken OK
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The Reach.Models.EndUserIdentitySecureToken id.
+     */
+    id: number;
+  }): CancelablePromise<EndUserIdentitySecureToken> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/end-user-identity-secure-tokens/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a Reach.Models.EndUserIdentitySecureToken by its secure token string.
+   * @returns EndUserIdentitySecureToken OK
+   * @throws ApiError
+   */
+  public getObjectByToken({
+    requestBody,
+  }: {
+    /**
+     * The secure token.
+     */
+    requestBody?: ResolveSecureAccessTokenRequest;
+  }): CancelablePromise<EndUserIdentitySecureToken> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/end-user-identity-secure-tokens/resolve',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of Reach.Models.EndUserIdentitySecureToken.
+   * @returns EndUserIdentitySecureToken OK
+   * @throws ApiError
+   */
+  public getList({
+    token,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable token.
+     */
+    token?: string;
+    /**
+     * Gets or sets the page number for paged queries.
+     */
+    pageNumber?: number;
+    /**
+     * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
+     */
+    take?: number;
+    /**
+     * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
+     */
+    skip?: number;
+    /**
+     * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+     */
+    limitListRequests?: boolean;
+    /**
+     * Gets or sets the Tenant Id.
+     */
+    tenantId?: string;
+    /**
+     * Gets or sets the Modifed By Id.
+     */
+    modifiedById?: string;
+    /**
+     * Gets or sets the Modifed By Ids.
+     */
+    modifiedByIds?: Array<string>;
+    /**
+     * Gets or sets the Date Created greater than equal to.
+     */
+    dateCreatedGte?: string;
+    /**
+     * Gets or sets the Date Created less than equal to.
+     */
+    dateCreatedLte?: string;
+    /**
+     * Gets or sets the queryable only is live status.
+     */
+    isLive?: boolean;
+    /**
+     * Gets or sets the sort order direction.
+     */
+    sortOrderDirection?: SearchSortOrderDirection;
+  }): CancelablePromise<Array<EndUserIdentitySecureToken>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/end-user-identity-secure-tokens',
+      query: {
+        Token: token,
+        PageNumber: pageNumber,
+        Take: take,
+        Skip: skip,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Backfills the secure access tokens for all end user identities. Should only be run once and by existing developers whos db structure is outdated with relevance to end user identities.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public backfillTokens(): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/end-user-identity-secure-tokens/back-fill',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+}

package/src/services/PublicCustomersService.ts

@@ -84,11 +84,12 @@ export class PublicCustomersService {
   public getPage({
     xTenantSubdomain,
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -109,7 +110,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.
      */
@@ -126,6 +127,10 @@ export class PublicCustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -179,11 +184,12 @@ export class PublicCustomersService {
       },
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -238,6 +244,41 @@ export class PublicCustomersService {
     });
   }
 
+  /**
+   * Returns the tenants accessible to the end user.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public getCustomerAccessibleTenants({
+    endUserIdentityId,
+    xTenantSubdomain,
+  }: {
+    /**
+     * The end user identity id.
+     */
+    endUserIdentityId: string;
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/customers/accessible-tenants',
+      path: {
+        endUserIdentityId: endUserIdentityId,
+      },
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
    * @returns Customer OK
@@ -348,11 +389,12 @@ export class PublicCustomersService {
   public exists({
     xTenantSubdomain,
     wildcard,
-    email,
+    displayEmail,
     venueId,
     programmeId,
     marketingOptIn,
     isActiveCustomer,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -376,7 +418,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.
      */
@@ -393,6 +435,10 @@ export class PublicCustomersService {
      * Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
      */
     isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -446,11 +492,12 @@ export class PublicCustomersService {
       },
       query: {
         Wildcard: wildcard,
-        Email: email,
+        DisplayEmail: displayEmail,
         VenueId: venueId,
         ProgrammeId: programmeId,
         MarketingOptIn: marketingOptIn,
         IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,