reach-api-sdk 1.0.206 → 1.0.208

package/src/index.ts

@@ -26,6 +26,7 @@ export type { Attendee } from './models/Attendee';
 export type { AttendeePage } from './models/AttendeePage';
 export type { AttendeePatch } from './models/AttendeePatch';
 export type { AttendeePost } from './models/AttendeePost';
+export type { AttendeeWalletDeductionPreview } from './models/AttendeeWalletDeductionPreview';
 export type { AutoCompleteResponseModel } from './models/AutoCompleteResponseModel';
 export { AvailabilityIndicator } from './models/AvailabilityIndicator';
 export { BookingStatus } from './models/BookingStatus';
@@ -68,6 +69,7 @@ export type { CreateVenue } from './models/CreateVenue';
 export { CustomDateRange } from './models/CustomDateRange';
 export type { CustomDateRangeOption } from './models/CustomDateRangeOption';
 export type { Customer } from './models/Customer';
+export type { CustomerAccountInvitePatch } from './models/CustomerAccountInvitePatch';
 export { CustomerCancellationOption } from './models/CustomerCancellationOption';
 export type { CustomerEmailPatch } from './models/CustomerEmailPatch';
 export type { CustomerPage } from './models/CustomerPage';
@@ -75,6 +77,7 @@ export type { CustomerPatch } from './models/CustomerPatch';
 export type { CustomerPost } from './models/CustomerPost';
 export type { CustomerStats } from './models/CustomerStats';
 export { CustomerType } from './models/CustomerType';
+export type { CustomerWalletDeductionPreview } from './models/CustomerWalletDeductionPreview';
 export { CustomFieldDataType } from './models/CustomFieldDataType';
 export type { CustomFieldDefinition } from './models/CustomFieldDefinition';
 export type { CustomFieldDefinitionPage } from './models/CustomFieldDefinitionPage';
@@ -469,6 +472,19 @@ export type { WaitlistOpportunityReport } from './models/WaitlistOpportunityRepo
 export type { WaitlistOpportunityReportPage } from './models/WaitlistOpportunityReportPage';
 export type { WaitlistOpportunityReportPatch } from './models/WaitlistOpportunityReportPatch';
 export type { WaitlistOpportunityReportPost } from './models/WaitlistOpportunityReportPost';
+export type { Wallet } from './models/Wallet';
+export type { WalletDeductionPreview } from './models/WalletDeductionPreview';
+export type { WalletPage } from './models/WalletPage';
+export type { WalletPatch } from './models/WalletPatch';
+export type { WalletPost } from './models/WalletPost';
+export type { WalletRemoveCreditPost } from './models/WalletRemoveCreditPost';
+export type { WalletTopUpPost } from './models/WalletTopUpPost';
+export { WalletTrackingLevel } from './models/WalletTrackingLevel';
+export type { WalletTransaction } from './models/WalletTransaction';
+export type { WalletTransactionPage } from './models/WalletTransactionPage';
+export type { WalletTransactionPatch } from './models/WalletTransactionPatch';
+export type { WalletTransactionPost } from './models/WalletTransactionPost';
+export { WalletTransactionType } from './models/WalletTransactionType';
 
 export { ActivityService } from './services/ActivityService';
 export { ActivityPerformanceService } from './services/ActivityPerformanceService';
@@ -590,3 +606,5 @@ export { WaitlistActivityService } from './services/WaitlistActivityService';
 export { WaitlistActivityReportService } from './services/WaitlistActivityReportService';
 export { WaitlistOpportunityService } from './services/WaitlistOpportunityService';
 export { WaitlistOpportunityReportService } from './services/WaitlistOpportunityReportService';
+export { WalletsService } from './services/WalletsService';
+export { WalletTransactionsService } from './services/WalletTransactionsService';

package/src/models/Attendee.ts

@@ -3,6 +3,9 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { EndUserIdentity } from './EndUserIdentity';
+import type { Wallet } from './Wallet';
+
 /**
  * Represents a Attendee within the Reach application.
  */
@@ -31,14 +34,14 @@ export type Attendee = {
    * Gets or sets a value indicating whether the record is live and available for use within the application.
    */
   isLive: boolean;
-  /**
-   * Gets or sets the venue id.
-   */
-  venueId: string;
   /**
    * Gets or sets the customer id.
    */
   customerId: string;
+  /**
+   * Gets or sets the end user identity id.
+   */
+  endUserIdentityId?: string | null;
   /**
    * Gets or sets the first name.
    */
@@ -55,4 +58,6 @@ export type Attendee = {
    * Gets the attendees full name.
    */
   readonly fullName?: string | null;
+  wallet?: Wallet;
+  endUserIdentity?: EndUserIdentity;
 };

package/src/models/AttendeePatch.ts

@@ -15,4 +15,17 @@ export type AttendeePatch = {
    * Gets or sets the Id.
    */
   id: string;
+  /**
+   * Gets or sets the attendee first name.
+   */
+  firstName?: string | null;
+  /**
+   * Gets or sets the attendee last name.
+   */
+  lastName?: string | null;
+  /**
+   * Gets or sets the attendee date of birth.
+   * This updates the linked end_user_identity record, not the attendee directly.
+   */
+  dateOfBirth?: string | null;
 };

package/src/models/AttendeePost.ts

@@ -20,7 +20,20 @@ export type AttendeePost = {
    */
   lastName: string;
   /**
-   * Gets or sets the attendee last name.
+   * Gets or sets the customer id that the attendee belongs to.
    */
   customerId: string;
+  /**
+   * Gets or sets the initial wallet balance for the attendee.
+   * This is only applicable when wallet tracking level is set to Attendee.
+   * When wallet tracking level is Attendee, a wallet is always created for the attendee.
+   * If InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.
+   * If not provided or set to 0, the wallet will be created with a balance of 0.
+   */
+  initialWalletBalance?: number | null;
+  /**
+   * Gets or sets the attendee date of birth.
+   * This is used to resolve or create the linked end_user_identity record for person-level identity tracking.
+   */
+  dateOfBirth?: string | null;
 };

package/src/models/AttendeeWalletDeductionPreview.ts

@@ -0,0 +1,51 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Attendee } from './Attendee';
+
+/**
+ * Represents attendee-level wallet deduction preview information.
+ */
+export type AttendeeWalletDeductionPreview = {
+  /**
+   * Gets or sets the attendee id.
+   */
+  attendeeId?: string;
+  attendee?: Attendee;
+  /**
+   * Gets or sets the attendee's first name.
+   */
+  firstName?: string | null;
+  /**
+   * Gets or sets the attendee's last name.
+   */
+  lastName?: string | null;
+  /**
+   * Gets or sets the attendee's current wallet balance.
+   */
+  currentBalance?: number;
+  /**
+   * Gets or sets the amount that will be deducted from the attendee's wallet.
+   */
+  amountToDeduct?: number;
+  /**
+   * Gets or sets the wallet balance after deduction.
+   */
+  balanceAfterDeduction?: number;
+  /**
+   * Gets or sets the attendee's payment amount (their portion of the order total).
+   */
+  paymentAmount?: number;
+  /**
+   * Gets or sets a value indicating whether this attendee's wallet balance is sufficient to cover their payment amount.
+   * This is only relevant when wallet-only payments are enabled.
+   */
+  isWalletBalanceSufficient?: boolean;
+  /**
+   * Gets or sets a value indicating whether this attendee's portion of the order can be processed based on wallet-only payment requirements.
+   * Returns false if wallet-only payments are enabled and this attendee's wallet balance is insufficient.
+   */
+  canProcessAttendeeOrder?: boolean;
+};

package/src/models/CoursePatch.ts

@@ -5,6 +5,7 @@
 
 import type { CheckoutPlatform } from './CheckoutPlatform';
 import type { CourseBookingCutoff } from './CourseBookingCutoff';
+import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
 import type { Gender } from './Gender';
 import type { UpdateEmailSettings } from './UpdateEmailSettings';
 import type { UpdateOffer } from './UpdateOffer';
@@ -157,4 +158,5 @@ export type CoursePatch = {
    * Gets or sets the course offers.
    */
   offers?: Array<UpdateOffer> | null;
+  customFields?: CustomFieldsBulkUpdate;
 };

package/src/models/CoursePost.ts

@@ -3,6 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
 import type { UpdateEmailSettings } from './UpdateEmailSettings';
 
 /**
@@ -14,4 +15,5 @@ export type CoursePost = {
    */
   tenantId: string;
   emailSettings?: UpdateEmailSettings;
+  customFields?: CustomFieldsBulkUpdate;
 };

package/src/models/Customer.ts

@@ -4,8 +4,10 @@
 /* eslint-disable */
 
 import type { Attendee } from './Attendee';
+import type { Country } from './Country';
 import type { CustomerStats } from './CustomerStats';
 import type { CustomerType } from './CustomerType';
+import type { Wallet } from './Wallet';
 
 /**
  * Represents an organisation within the Reach application.
@@ -39,10 +41,6 @@ export type Customer = {
    * Gets or sets the customer provider id.
    */
   providerId?: string | null;
-  /**
-   * Gets or sets the venue id.
-   */
-  venueId?: string | null;
   type?: CustomerType;
   /**
    * Gets or sets the first name.
@@ -85,13 +83,14 @@ export type Customer = {
    */
   addressPostalcode?: string | null;
   /**
-   * Gets or sets the customer locality.
+   * Gets or sets the customer country id.
    */
-  addressCountry?: string | null;
+  countryId?: number | null;
   /**
    * Gets or sets a value indicating whether the customer is opted into marketing.
    */
   marketingOptIn?: boolean;
+  country?: Country;
   /**
    * 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.
    */
@@ -109,4 +108,5 @@ export type Customer = {
    * Gets or sets the attendees registered by the customer.
    */
   attendees?: Array<Attendee> | null;
+  wallet?: Wallet;
 };

package/src/models/CustomerAccountInvitePatch.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for sending account invite email to the customer.
+ */
+export type CustomerAccountInvitePatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the acceptance code for the account invite.
+   */
+  acceptanceCode?: string | null;
+  /**
+   * Gets or sets the base domain for the invite link. If not provided, will use configuration value.
+   */
+  baseDomain?: string | null;
+};

package/src/models/CustomerPatch.ts

@@ -55,9 +55,9 @@ export type CustomerPatch = {
    */
   addressPostalcode?: string | null;
   /**
-   * Gets or sets the customer country.
+   * Gets or sets the customer country id.
    */
-  addressCountry?: string | null;
+  countryId?: number | null;
   /**
    * Gets or sets a value indicating whether the customer is opted into marketing.
    */

package/src/models/CustomerPost.ts

@@ -55,9 +55,9 @@ export type CustomerPost = {
    */
   addressPostalcode?: string | null;
   /**
-   * Gets or sets the customer country.
+   * Gets or sets the customer country id.
    */
-  addressCountry?: string | null;
+  countryId?: number | null;
   /**
    * Gets or sets a value indicating whether the customer is opted into marketing.
    */

package/src/models/CustomerWalletDeductionPreview.ts

@@ -0,0 +1,36 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents customer-level wallet deduction preview information.
+ */
+export type CustomerWalletDeductionPreview = {
+  /**
+   * Gets or sets the customer id.
+   */
+  customerId?: string;
+  /**
+   * Gets or sets the customer's current wallet balance.
+   */
+  currentBalance?: number;
+  /**
+   * Gets or sets the amount that will be deducted from the customer's wallet.
+   */
+  amountToDeduct?: number;
+  /**
+   * Gets or sets the wallet balance after deduction.
+   */
+  balanceAfterDeduction?: number;
+  /**
+   * Gets or sets a value indicating whether the customer's wallet balance is sufficient to cover the full order amount.
+   * This is only relevant when wallet-only payments are enabled.
+   */
+  isWalletBalanceSufficient?: boolean;
+  /**
+   * Gets or sets a value indicating whether the order can be processed based on wallet-only payment requirements.
+   * Returns false if wallet-only payments are enabled and the customer's wallet balance is insufficient.
+   */
+  canProcessOrder?: boolean;
+};

package/src/models/EndUserIdentity.ts

@@ -23,6 +23,10 @@ export type EndUserIdentity = {
    * Gets or sets the last name.
    */
   lastName?: string | null;
+  /**
+   * Gets or sets the date of birth.
+   */
+  dateOfBirth?: string | null;
   /**
    * Gets or sets the date created.
    */

package/src/models/Order.ts

@@ -15,6 +15,7 @@ import type { Payment } from './Payment';
 import type { PaymentMethod } from './PaymentMethod';
 import type { RefundStatus } from './RefundStatus';
 import type { Venue } from './Venue';
+import type { WalletDeductionPreview } from './WalletDeductionPreview';
 
 /**
  * Represents an organisation within the Reach application.
@@ -144,6 +145,10 @@ export type Order = {
    * Gets or sets the payment policy transfer fee (used to transfer an amount to the enterprise tenant in enterprise setups).
    */
   paymentPolicyXferFee?: number | null;
+  /**
+   * Gets or sets the amount deducted from wallet for this order.
+   */
+  walletAmountUsed?: number | null;
   /**
    * Gets or sets the provided customer order reference.
    */
@@ -233,6 +238,7 @@ export type Order = {
    * Gets or sets the orders stripe payment intent client secret.
    */
   paymentIntentClientSecret?: string | null;
+  walletDeductionPreview?: WalletDeductionPreview;
   venue?: Venue;
   country?: Country;
   customer?: Customer;

package/src/models/RecentOrderActivityReport.ts

@@ -51,6 +51,10 @@ export type RecentOrderActivityReport = {
    * Gets or sets the total revenue value.
    */
   totalRevenue?: string | null;
+  /**
+   * Gets or sets the total wallet amount used value.
+   */
+  totalWalletAmountUsed?: string | null;
   /**
    * Gets or sets the total orders value.
    */

package/src/models/SessionPatch.ts

@@ -4,6 +4,7 @@
 /* eslint-disable */
 
 import type { CheckoutPlatform } from './CheckoutPlatform';
+import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
 import type { Gender } from './Gender';
 import type { UpdateEmailSettings } from './UpdateEmailSettings';
 import type { UpdateOffer } from './UpdateOffer';
@@ -155,4 +156,5 @@ export type SessionPatch = {
    * Gets or sets the session offers.
    */
   offers?: Array<UpdateOffer> | null;
+  customFields?: CustomFieldsBulkUpdate;
 };

package/src/models/SessionPost.ts

@@ -3,6 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
 import type { UpdateEmailSettings } from './UpdateEmailSettings';
 
 /**
@@ -14,4 +15,5 @@ export type SessionPost = {
    */
   tenantId: string;
   emailSettings?: UpdateEmailSettings;
+  customFields?: CustomFieldsBulkUpdate;
 };

package/src/models/SurveySubmitAttendee.ts

@@ -21,6 +21,10 @@ export type SurveySubmitAttendee = {
    * Gets or sets the attendee last name.
    */
   lastName?: string | null;
+  /**
+   * Gets or sets the attendee date of birth.
+   */
+  dateOfBirth?: string | null;
   /**
    * Gets or sets the attendee number.
    */

package/src/models/TenantSetting.ts

@@ -3,6 +3,8 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { WalletTrackingLevel } from './WalletTrackingLevel';
+
 /**
  * Represents an organisation within the Reach application.
  */
@@ -51,6 +53,12 @@ export type TenantSetting = {
    * Gets or sets a value indicating whether providers are enabled for the tenant (only applicable to enterprise tenants).
    */
   enableProviders?: boolean;
+  walletTrackingLevel?: WalletTrackingLevel;
+  /**
+   * Gets or sets a value indicating whether customers are only allowed to use wallet transactions (no card payments).
+   * When enabled, prices will be displayed as 'credits' rather than currency.
+   */
+  walletOnlyPayments?: boolean;
   /**
    * Gets the next order number in the sequence.
    */

package/src/models/TotalRevenueReport.ts

@@ -66,4 +66,8 @@ export type TotalRevenueReport = {
    * Gets or sets the total revenue.
    */
   totalRevenue?: number;
+  /**
+   * Gets or sets the total wallet amount used.
+   */
+  totalWalletAmountUsed?: number;
 };

package/src/models/VenuePatch.ts

@@ -3,6 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
 import type { UpcomingLayout } from './UpcomingLayout';
 import type { UpdateEmailSettings } from './UpdateEmailSettings';
 import type { VenueOpeningHourUpdate } from './VenueOpeningHourUpdate';
@@ -101,4 +102,5 @@ export type VenuePatch = {
    * Gets or sets the venue amenities.
    */
   openingHours?: Array<VenueOpeningHourUpdate> | null;
+  customFields?: CustomFieldsBulkUpdate;
 };

package/src/models/VenuePost.ts

@@ -3,6 +3,8 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
+
 /**
  * Post model for venue inserts.
  */
@@ -67,4 +69,5 @@ export type VenuePost = {
    * Gets or sets the amenity ids.
    */
   amenityIds?: Array<number> | null;
+  customFields?: CustomFieldsBulkUpdate;
 };

package/src/models/Wallet.ts

@@ -0,0 +1,60 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Attendee } from './Attendee';
+import type { Customer } from './Customer';
+import type { WalletTransaction } from './WalletTransaction';
+
+/**
+ * Represents a wallet within the Reach application.
+ */
+export type Wallet = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive: boolean;
+  /**
+   * Gets or sets the customer id. This is set when wallet tracking is at customer level.
+   */
+  customerId?: string | null;
+  /**
+   * Gets or sets the attendee id. This is set when wallet tracking is at attendee level.
+   */
+  attendeeId?: string | null;
+  /**
+   * Gets or sets the wallet balance.
+   */
+  balance: number;
+  /**
+   * Gets or sets the wallet currency.
+   */
+  currency?: string | null;
+  customer?: Customer;
+  attendee?: Attendee;
+  /**
+   * Gets or sets the wallet transactions.
+   */
+  transactions?: Array<WalletTransaction> | null;
+};

package/src/models/WalletDeductionPreview.ts

@@ -0,0 +1,44 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { AttendeeWalletDeductionPreview } from './AttendeeWalletDeductionPreview';
+import type { CustomerWalletDeductionPreview } from './CustomerWalletDeductionPreview';
+
+/**
+ * Represents wallet deduction preview information for an order.
+ */
+export type WalletDeductionPreview = {
+  /**
+   * Gets or sets the total amount that will be deducted from wallets.
+   */
+  totalWalletAmountToDeduct?: number;
+  /**
+   * Gets or sets the remaining amount that will need to be paid after wallet deductions.
+   */
+  remainingAmountToPay?: number;
+  /**
+   * Gets or sets the currency code.
+   */
+  currency?: string | null;
+  customerWallet?: CustomerWalletDeductionPreview;
+  /**
+   * Gets or sets the attendee-level wallet deduction information (when tracking at attendee level).
+   */
+  attendeeWallets?: Array<AttendeeWalletDeductionPreview> | null;
+  /**
+   * Gets or sets a value indicating whether wallet-only payments are enabled for this tenant.
+   */
+  isWalletOnlyPayments?: boolean;
+  /**
+   * Gets or sets a value indicating whether the wallet balance is sufficient to cover the full order amount.
+   * This is only relevant when wallet-only payments are enabled.
+   */
+  isWalletBalanceSufficient?: boolean;
+  /**
+   * Gets or sets a value indicating whether the order can be processed based on wallet-only payment requirements.
+   * Returns false if wallet-only payments are enabled and wallet balance is insufficient.
+   */
+  canProcessOrder?: boolean;
+};

package/src/models/WalletPage.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Pagination } from './Pagination';
+import type { Wallet } from './Wallet';
+
+export type WalletPage = {
+  pagination: Pagination;
+  readonly items: Array<Wallet>;
+};

package/src/models/WalletPatch.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for wallet updates.
+ */
+export type WalletPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the wallet currency (e.g., "GBP", "USD", "EUR").
+   * Note: Balance cannot be updated directly through this model. Use top-up or transaction operations instead.
+   */
+  currency?: string | null;
+};

package/src/models/WalletPost.ts

@@ -0,0 +1,29 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for wallet creation.
+ */
+export type WalletPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the customer id. This is set when wallet tracking is at customer level.
+   * Either CustomerId or AttendeeId must be provided, but not both.
+   */
+  customerId?: string | null;
+  /**
+   * Gets or sets the attendee id. This is set when wallet tracking is at attendee level.
+   * Either CustomerId or AttendeeId must be provided, but not both.
+   */
+  attendeeId?: string | null;
+  /**
+   * Gets or sets the wallet currency (e.g., "GBP", "USD", "EUR").
+   * If not provided, will default to the tenant's currency.
+   */
+  currency?: string | null;
+};