reach-api-sdk 1.0.187 → 1.0.189

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:
@@ -12998,6 +12998,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -13127,7 +13133,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:
@@ -13154,6 +13160,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -13617,7 +13629,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:
@@ -13644,6 +13656,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -13948,7 +13966,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:
@@ -13975,6 +13993,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -14101,7 +14125,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:
@@ -14128,6 +14152,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -14260,7 +14290,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:
@@ -14287,6 +14317,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -20356,6 +20392,313 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  '/api/end-user-identity-secure-tokens/{id}':
+    get:
+      tags:
+        - EndUserIdentitySecureToken
+      summary: Gets a Reach.Models.EndUserIdentitySecureToken by its Id.
+      operationId: GetObject
+      parameters:
+        - name: id
+          in: path
+          description: The Reach.Models.EndUserIdentitySecureToken id.
+          required: true
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/EndUserIdentitySecureToken'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EndUserIdentitySecureToken'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/EndUserIdentitySecureToken'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+  /api/end-user-identity-secure-tokens/resolve:
+    post:
+      tags:
+        - EndUserIdentitySecureToken
+      summary: Gets a Reach.Models.EndUserIdentitySecureToken by its secure token string.
+      operationId: GetObjectByToken
+      requestBody:
+        description: The secure token.
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ResolveSecureAccessTokenRequest'
+          text/json:
+            schema:
+              $ref: '#/components/schemas/ResolveSecureAccessTokenRequest'
+          application/*+json:
+            schema:
+              $ref: '#/components/schemas/ResolveSecureAccessTokenRequest'
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/EndUserIdentitySecureToken'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EndUserIdentitySecureToken'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/EndUserIdentitySecureToken'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+  /api/end-user-identity-secure-tokens:
+    get:
+      tags:
+        - EndUserIdentitySecureToken
+      summary: Gets a list of Reach.Models.EndUserIdentitySecureToken.
+      operationId: GetList
+      parameters:
+        - name: Token
+          in: query
+          description: Gets or sets the queryable token.
+          schema:
+            type: string
+        - name: PageNumber
+          in: query
+          description: Gets or sets the page number for paged queries.
+          schema:
+            type: integer
+            format: int32
+        - name: Take
+          in: query
+          description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
+          schema:
+            type: integer
+            format: int32
+        - name: Skip
+          in: query
+          description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
+          schema:
+            type: integer
+            format: int32
+        - name: LimitListRequests
+          in: query
+          description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+          schema:
+            type: boolean
+        - name: TenantId
+          in: query
+          description: Gets or sets the Tenant Id.
+          schema:
+            type: string
+            format: uuid
+        - name: ModifiedById
+          in: query
+          description: Gets or sets the Modifed By Id.
+          schema:
+            type: string
+            format: uuid
+        - name: ModifiedByIds
+          in: query
+          description: Gets or sets the Modifed By Ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
+        - name: DateCreatedGTE
+          in: query
+          description: Gets or sets the Date Created greater than equal to.
+          schema:
+            type: string
+            format: date-time
+        - name: DateCreatedLTE
+          in: query
+          description: Gets or sets the Date Created less than equal to.
+          schema:
+            type: string
+            format: date-time
+        - name: IsLive
+          in: query
+          description: Gets or sets the queryable only is live status.
+          schema:
+            type: boolean
+        - name: SortOrderDirection
+          in: query
+          description: Gets or sets the sort order direction.
+          schema:
+            $ref: '#/components/schemas/SearchSortOrderDirection'
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EndUserIdentitySecureToken'
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EndUserIdentitySecureToken'
+            text/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EndUserIdentitySecureToken'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+  /api/end-user-identity-secure-tokens/back-fill:
+    get:
+      tags:
+        - EndUserIdentitySecureToken
+      summary: 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.
+      operationId: BackfillTokens
+      responses:
+        '200':
+          description: OK
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   /api/reports/england-golf/send-email:
     post:
       tags:
@@ -54258,7 +54601,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:
@@ -54285,6 +54628,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -54461,6 +54810,64 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  /api/public/customers/accessible-tenants:
+    get:
+      tags:
+        - PublicCustomers
+      summary: Returns the tenants accessible to the end user.
+      operationId: GetCustomerAccessibleTenants
+      parameters:
+        - name: x_tenant_subdomain
+          in: header
+          description: The tenants subdomain.
+          schema:
+            type: string
+        - name: endUserIdentityId
+          in: path
+          description: The end user identity id.
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: OK
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   /api/public/customers/v2-temporary-route:
     post:
       tags:
@@ -54708,7 +55115,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:
@@ -54735,6 +55142,12 @@ paths:
           description: '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.'
           schema:
             type: boolean
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the customers end user identity id.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -122476,7 +122889,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
@@ -122517,6 +122930,11 @@ components:
           description: Gets or sets how many times the customer has booked with the organisation.
           format: int32
           nullable: true
+        endUserIdentityId:
+          type: string
+          description: Gets or sets the customers end user identity id.
+          format: uuid
+          nullable: true
         stats:
           $ref: '#/components/schemas/CustomerStats'
         attendees:
@@ -123599,6 +124017,38 @@ components:
           format: uuid
       additionalProperties: false
       description: Post model for email setting inserts.
+    EndUserIdentitySecureToken:
+      type: object
+      properties:
+        id:
+          type: integer
+          description: Gets or sets the activities Id.
+          format: int32
+          default: 0
+        token:
+          type: string
+          description: Gets or sets the secure token.
+          nullable: true
+        endUserIdentityId:
+          type: string
+          description: Gets or sets the end user identity id.
+          format: uuid
+        tenantId:
+          type: string
+          description: Gets or sets the tenant id.
+          format: uuid
+        dateCreated:
+          type: string
+          description: Gets or sets the date the resource was created.
+          format: date-time
+        isActive:
+          type: boolean
+          description: Gets or sets a value indicating whether the token is active/revoked.
+          default: false
+        tenant:
+          $ref: '#/components/schemas/Tenant'
+      additionalProperties: false
+      description: Represents an end user identity within the Reach application.
     Facility:
       required:
         - dateCreated
@@ -128995,6 +129445,15 @@ components:
           format: uuid
       additionalProperties: false
       description: Post model for reschedule log inserts.
+    ResolveSecureAccessTokenRequest:
+      type: object
+      properties:
+        token:
+          type: string
+          description: Gets or sets the token.
+          nullable: true
+      additionalProperties: false
+      description: Models secure access token requests.
     ScheduleStatus:
       enum:
         - Pending

package/src/index.ts

@@ -101,6 +101,7 @@ export type { EmailSetting } from './models/EmailSetting';
 export type { EmailSettingPage } from './models/EmailSettingPage';
 export type { EmailSettingPatch } from './models/EmailSettingPatch';
 export type { EmailSettingPost } from './models/EmailSettingPost';
+export type { EndUserIdentitySecureToken } from './models/EndUserIdentitySecureToken';
 export type { Facility } from './models/Facility';
 export type { FacilityIndividual } from './models/FacilityIndividual';
 export type { FacilityIndividualPage } from './models/FacilityIndividualPage';
@@ -264,6 +265,7 @@ export type { RescheduleLog } from './models/RescheduleLog';
 export type { RescheduleLogPage } from './models/RescheduleLogPage';
 export type { RescheduleLogPatch } from './models/RescheduleLogPatch';
 export type { RescheduleLogPost } from './models/RescheduleLogPost';
+export type { ResolveSecureAccessTokenRequest } from './models/ResolveSecureAccessTokenRequest';
 export type { ScheduledSession } from './models/ScheduledSession';
 export type { ScheduledSessionEmailAttendeesPatch } from './models/ScheduledSessionEmailAttendeesPatch';
 export type { ScheduledSessionPage } from './models/ScheduledSessionPage';
@@ -461,6 +463,7 @@ export { DealsService } from './services/DealsService';
 export { DiscountCodeUsesService } from './services/DiscountCodeUsesService';
 export { EmailReminderSchedulesService } from './services/EmailReminderSchedulesService';
 export { EmailSettingsService } from './services/EmailSettingsService';
+export { EndUserIdentitySecureTokenService } from './services/EndUserIdentitySecureTokenService';
 export { EnglandGolfReportService } from './services/EnglandGolfReportService';
 export { FacilitiesService } from './services/FacilitiesService';
 export { FacilityIndividualsService } from './services/FacilityIndividualsService';

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.
    */
@@ -100,6 +100,10 @@ export type Customer = {
    * Gets or sets how many times the customer has booked with the organisation.
    */
   bookingCount?: number | null;
+  /**
+   * Gets or sets the customers end user identity id.
+   */
+  endUserIdentityId?: string | null;
   stats?: CustomerStats;
   /**
    * Gets or sets the attendees registered by the customer.