reach-api-sdk 1.0.225 → 1.0.228

package/src/definition/swagger.yaml

@@ -139247,6 +139247,11 @@ paths:
           description: Gets or sets the team member invite status for use in a query search.
           schema:
             $ref: '#/components/schemas/InviteStatus'
+        - name: IsPlatformAccount
+          in: query
+          description: Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -139909,6 +139914,11 @@ paths:
           description: Gets or sets the team member invite status for use in a query search.
           schema:
             $ref: '#/components/schemas/InviteStatus'
+        - name: IsPlatformAccount
+          in: query
+          description: Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -140243,6 +140253,11 @@ paths:
           description: Gets or sets the team member invite status for use in a query search.
           schema:
             $ref: '#/components/schemas/InviteStatus'
+        - name: IsPlatformAccount
+          in: query
+          description: Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -140399,6 +140414,11 @@ paths:
           description: Gets or sets the team member invite status for use in a query search.
           schema:
             $ref: '#/components/schemas/InviteStatus'
+        - name: IsPlatformAccount
+          in: query
+          description: Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -140558,6 +140578,11 @@ paths:
           description: Gets or sets the team member invite status for use in a query search.
           schema:
             $ref: '#/components/schemas/InviteStatus'
+        - name: IsPlatformAccount
+          in: query
+          description: Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -140720,6 +140745,11 @@ paths:
           description: Gets or sets the team member invite status for use in a query search.
           schema:
             $ref: '#/components/schemas/InviteStatus'
+        - name: IsPlatformAccount
+          in: query
+          description: Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -154609,6 +154639,81 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  '/api/wallets/{id}/credit-periods/reassess':
+    post:
+      tags:
+        - Wallets
+      summary: Reassesses the active credit period for a wallet and sets balance to the new allocation.
+      operationId: ReassessCreditPeriod
+      parameters:
+        - name: id
+          in: path
+          description: The wallet id.
+          required: true
+          schema:
+            type: string
+            format: uuid
+      requestBody:
+        description: The reassessment request.
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WalletCreditPeriodReassessPost'
+          text/json:
+            schema:
+              $ref: '#/components/schemas/WalletCreditPeriodReassessPost'
+          application/*+json:
+            schema:
+              $ref: '#/components/schemas/WalletCreditPeriodReassessPost'
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/Wallet'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Wallet'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/Wallet'
+        '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/wallets/{id}/transactions':
     get:
       tags:
@@ -157909,9 +158014,28 @@ components:
           format: uuid
         initialWalletBalance:
           type: number
-          description: "Gets or sets the initial wallet balance for the attendee.\r\nThis is only applicable when wallet tracking level is set to Attendee.\r\nWhen wallet tracking level is Attendee, a wallet is always created for the attendee.\r\nIf InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.\r\nIf not provided or set to 0, the wallet will be created with a balance of 0."
+          description: "Gets or sets the initial wallet balance for the attendee.\r\nThis is only applicable when wallet tracking level is set to Attendee.\r\nWhen wallet tracking level is Attendee, a wallet is always created for the attendee.\r\nIf InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.\r\nIf not provided or set to 0, the wallet will be created with a balance of 0.\r\nIgnored when enable_wallet_credit_periods is enabled; use credit period fields instead."
           format: double
           nullable: true
+        creditPeriodStartDate:
+          type: string
+          description: Gets or sets the credit period start date. Required when wallet credit periods are enabled.
+          format: date-time
+          nullable: true
+        creditPeriodEndDate:
+          type: string
+          description: Gets or sets the credit period end date. Required when wallet credit periods are enabled.
+          format: date-time
+          nullable: true
+        creditAllocation:
+          type: number
+          description: Gets or sets the credit allocation for the initial period. Required when wallet credit periods are enabled.
+          format: double
+          nullable: true
+        creditPeriodAutoRenew:
+          type: boolean
+          description: Gets or sets a value indicating whether the credit period auto-renews. Defaults to true when not specified.
+          nullable: true
         dateOfBirth:
           type: string
           description: "Gets or sets the attendee date of birth.\r\nThis is used to resolve or create the linked end_user_identity record for person-level identity tracking."
@@ -161162,6 +161286,7 @@ components:
         - paidOpportunitiesExist
         - providersExist
         - scheduledSessionsExist
+        - sellableItemsExist
         - sessionsExist
         - slotsExist
         - storefrontTouched
@@ -161238,6 +161363,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether facilities database records exist.
           default: false
+        sellableItemsExist:
+          type: boolean
+          description: Gets or sets a value indicating whether sellable item (product) database records exist.
+          default: false
         scheduledSessionsExist:
           type: boolean
           description: Gets or sets a value indicating whether scheduled session database records exist.
@@ -173842,6 +173971,10 @@ components:
           type: boolean
           description: "Gets or sets a value indicating whether customers are only allowed to use wallet transactions (no card payments).\r\nWhen enabled, prices will be displayed as 'credits' rather than currency."
           default: false
+        enableWalletCreditPeriods:
+          type: boolean
+          description: "Gets or sets a value indicating whether wallet credit periods are enabled for the tenant.\r\nWhen enabled, attendee wallets require an active credit period for bookings and allocation management."
+          default: false
         customerLoginRequiresPreprovision:
           type: boolean
           description: "Gets or sets a value indicating whether customer portal WorkOS login is restricted to pre-provisioned customers only.\r\nWhen true, the authenticated email must match a live customer row (email or display_email) for this tenant."
@@ -176693,10 +176826,23 @@ components:
           type: string
           description: Gets or sets the wallet currency.
           nullable: true
+        currentCreditPeriodId:
+          type: string
+          description: Gets or sets the current active credit period id when wallet credit periods are enabled.
+          format: uuid
+          nullable: true
+        cycleEndDate:
+          type: string
+          description: Gets the period end date for the current credit period. Used by partner platform wallet UI.
+          format: date-time
+          nullable: true
+          readOnly: true
         customer:
           $ref: '#/components/schemas/Customer'
         attendee:
           $ref: '#/components/schemas/Attendee'
+        currentCreditPeriod:
+          $ref: '#/components/schemas/WalletCreditPeriod'
         transactions:
           type: array
           items:
@@ -176705,6 +176851,97 @@ components:
           nullable: true
       additionalProperties: false
       description: Represents a wallet within the Reach application.
+    WalletCreditPeriod:
+      required:
+        - autoRenew
+        - creditAllocation
+        - dateCreated
+        - dateModified
+        - isLive
+        - periodEndDate
+        - periodStartDate
+        - status
+        - tenantId
+        - walletId
+      type: object
+      properties:
+        id:
+          type: string
+          description: Gets or sets the entities Id.
+          format: uuid
+        tenantId:
+          type: string
+          description: Gets or sets the tenant Id.
+          format: uuid
+        dateCreated:
+          type: string
+          description: Gets or sets the created date of this entity.
+          format: date-time
+        dateModified:
+          type: string
+          description: Gets or sets the last modified date of this entity.
+          format: date-time
+        modifiedById:
+          type: string
+          description: Gets or sets the modified by Id.
+          format: uuid
+          nullable: true
+        isLive:
+          type: boolean
+          description: Gets or sets a value indicating whether the record is live and available for use within the application.
+          default: false
+        walletId:
+          type: string
+          description: Gets or sets the wallet id.
+          format: uuid
+        periodStartDate:
+          type: string
+          description: Gets or sets the first day credits are usable (inclusive).
+          format: date-time
+        periodEndDate:
+          type: string
+          description: Gets or sets the last day credits are usable (inclusive).
+          format: date-time
+        creditAllocation:
+          type: number
+          description: Gets or sets the credit award amount for this period.
+          format: double
+        autoRenew:
+          type: boolean
+          description: Gets or sets a value indicating whether this period should auto-renew when it ends.
+          default: false
+        status:
+          $ref: '#/components/schemas/WalletCreditPeriodStatus'
+        wallet:
+          $ref: '#/components/schemas/Wallet'
+      additionalProperties: false
+      description: Represents a credit entitlement window for a wallet.
+    WalletCreditPeriodReassessPost:
+      required:
+        - creditAllocation
+      type: object
+      properties:
+        creditAllocation:
+          type: number
+          description: Gets or sets the new credit allocation. Wallet balance is set to this amount immediately.
+          format: double
+        periodEndDate:
+          type: string
+          description: Gets or sets an optional updated period end date.
+          format: date-time
+          nullable: true
+        autoRenew:
+          type: boolean
+          description: Gets or sets an optional auto-renew flag.
+          nullable: true
+      additionalProperties: false
+      description: Request body for mid-cycle credit reassessment.
+    WalletCreditPeriodStatus:
+      enum:
+        - Active
+        - Closed
+      type: string
+      description: Controls the wallet credit period status.
     WalletDeductionPreview:
       type: object
       properties:

package/src/index.ts

@@ -530,6 +530,9 @@ export type { WaitlistOpportunityReportPage } from './models/WaitlistOpportunity
 export type { WaitlistOpportunityReportPatch } from './models/WaitlistOpportunityReportPatch';
 export type { WaitlistOpportunityReportPost } from './models/WaitlistOpportunityReportPost';
 export type { Wallet } from './models/Wallet';
+export type { WalletCreditPeriod } from './models/WalletCreditPeriod';
+export type { WalletCreditPeriodReassessPost } from './models/WalletCreditPeriodReassessPost';
+export { WalletCreditPeriodStatus } from './models/WalletCreditPeriodStatus';
 export type { WalletDeductionPreview } from './models/WalletDeductionPreview';
 export type { WalletPage } from './models/WalletPage';
 export type { WalletPatch } from './models/WalletPatch';

package/src/models/AttendeePost.ts

@@ -29,8 +29,25 @@ export type AttendeePost = {
    * 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.
+   * Ignored when enable_wallet_credit_periods is enabled; use credit period fields instead.
    */
   initialWalletBalance?: number | null;
+  /**
+   * Gets or sets the credit period start date. Required when wallet credit periods are enabled.
+   */
+  creditPeriodStartDate?: string | null;
+  /**
+   * Gets or sets the credit period end date. Required when wallet credit periods are enabled.
+   */
+  creditPeriodEndDate?: string | null;
+  /**
+   * Gets or sets the credit allocation for the initial period. Required when wallet credit periods are enabled.
+   */
+  creditAllocation?: number | null;
+  /**
+   * Gets or sets a value indicating whether the credit period auto-renews. Defaults to true when not specified.
+   */
+  creditPeriodAutoRenew?: boolean | 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.

package/src/models/DatabaseState.ts

@@ -73,6 +73,10 @@ export type DatabaseState = {
    * Gets or sets a value indicating whether facilities database records exist.
    */
   facilitiesExist: boolean;
+  /**
+   * Gets or sets a value indicating whether sellable item (product) database records exist.
+   */
+  sellableItemsExist: boolean;
   /**
    * Gets or sets a value indicating whether scheduled session database records exist.
    */

package/src/models/TenantSetting.ts

@@ -63,6 +63,11 @@ export type TenantSetting = {
    * When enabled, prices will be displayed as 'credits' rather than currency.
    */
   walletOnlyPayments?: boolean;
+  /**
+   * Gets or sets a value indicating whether wallet credit periods are enabled for the tenant.
+   * When enabled, attendee wallets require an active credit period for bookings and allocation management.
+   */
+  enableWalletCreditPeriods?: boolean;
   /**
    * Gets or sets a value indicating whether customer portal WorkOS login is restricted to pre-provisioned customers only.
    * When true, the authenticated email must match a live customer row (email or display_email) for this tenant.

package/src/models/Wallet.ts

@@ -5,6 +5,7 @@
 
 import type { Attendee } from './Attendee';
 import type { Customer } from './Customer';
+import type { WalletCreditPeriod } from './WalletCreditPeriod';
 import type { WalletTransaction } from './WalletTransaction';
 
 /**
@@ -51,8 +52,17 @@ export type Wallet = {
    * Gets or sets the wallet currency.
    */
   currency?: string | null;
+  /**
+   * Gets or sets the current active credit period id when wallet credit periods are enabled.
+   */
+  currentCreditPeriodId?: string | null;
+  /**
+   * Gets the period end date for the current credit period. Used by partner platform wallet UI.
+   */
+  readonly cycleEndDate?: string | null;
   customer?: Customer;
   attendee?: Attendee;
+  currentCreditPeriod?: WalletCreditPeriod;
   /**
    * Gets or sets the wallet transactions.
    */

package/src/models/WalletCreditPeriod.ts

@@ -0,0 +1,59 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Wallet } from './Wallet';
+import type { WalletCreditPeriodStatus } from './WalletCreditPeriodStatus';
+
+/**
+ * Represents a credit entitlement window for a wallet.
+ */
+export type WalletCreditPeriod = {
+  /**
+   * 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 wallet id.
+   */
+  walletId: string;
+  /**
+   * Gets or sets the first day credits are usable (inclusive).
+   */
+  periodStartDate: string;
+  /**
+   * Gets or sets the last day credits are usable (inclusive).
+   */
+  periodEndDate: string;
+  /**
+   * Gets or sets the credit award amount for this period.
+   */
+  creditAllocation: number;
+  /**
+   * Gets or sets a value indicating whether this period should auto-renew when it ends.
+   */
+  autoRenew: boolean;
+  status: WalletCreditPeriodStatus;
+  wallet?: Wallet;
+};

package/src/models/WalletCreditPeriodReassessPost.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Request body for mid-cycle credit reassessment.
+ */
+export type WalletCreditPeriodReassessPost = {
+  /**
+   * Gets or sets the new credit allocation. Wallet balance is set to this amount immediately.
+   */
+  creditAllocation: number;
+  /**
+   * Gets or sets an optional updated period end date.
+   */
+  periodEndDate?: string | null;
+  /**
+   * Gets or sets an optional auto-renew flag.
+   */
+  autoRenew?: boolean | null;
+};

package/src/models/WalletCreditPeriodStatus.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Controls the wallet credit period status.
+ */
+export enum WalletCreditPeriodStatus {
+  ACTIVE = 'Active',
+  CLOSED = 'Closed',
+}

package/src/services/UsersService.ts

@@ -108,6 +108,7 @@ export class UsersService {
     nameLike,
     email,
     inviteStatus,
+    isPlatformAccount,
     pageNumber,
     take,
     skip,
@@ -144,6 +145,10 @@ export class UsersService {
      * Gets or sets the team member invite status for use in a query search.
      */
     inviteStatus?: InviteStatus;
+    /**
+     * Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+     */
+    isPlatformAccount?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -199,6 +204,7 @@ export class UsersService {
         NameLike: nameLike,
         Email: email,
         InviteStatus: inviteStatus,
+        IsPlatformAccount: isPlatformAccount,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -422,6 +428,7 @@ export class UsersService {
     nameLike,
     email,
     inviteStatus,
+    isPlatformAccount,
     pageNumber,
     take,
     skip,
@@ -458,6 +465,10 @@ export class UsersService {
      * Gets or sets the team member invite status for use in a query search.
      */
     inviteStatus?: InviteStatus;
+    /**
+     * Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+     */
+    isPlatformAccount?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -513,6 +524,7 @@ export class UsersService {
         NameLike: nameLike,
         Email: email,
         InviteStatus: inviteStatus,
+        IsPlatformAccount: isPlatformAccount,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -626,6 +638,7 @@ export class UsersService {
     nameLike,
     email,
     inviteStatus,
+    isPlatformAccount,
     pageNumber,
     take,
     skip,
@@ -662,6 +675,10 @@ export class UsersService {
      * Gets or sets the team member invite status for use in a query search.
      */
     inviteStatus?: InviteStatus;
+    /**
+     * Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+     */
+    isPlatformAccount?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -717,6 +734,7 @@ export class UsersService {
         NameLike: nameLike,
         Email: email,
         InviteStatus: inviteStatus,
+        IsPlatformAccount: isPlatformAccount,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -749,6 +767,7 @@ export class UsersService {
     nameLike,
     email,
     inviteStatus,
+    isPlatformAccount,
     pageNumber,
     take,
     skip,
@@ -785,6 +804,10 @@ export class UsersService {
      * Gets or sets the team member invite status for use in a query search.
      */
     inviteStatus?: InviteStatus;
+    /**
+     * Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+     */
+    isPlatformAccount?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -840,6 +863,7 @@ export class UsersService {
         NameLike: nameLike,
         Email: email,
         InviteStatus: inviteStatus,
+        IsPlatformAccount: isPlatformAccount,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -872,6 +896,7 @@ export class UsersService {
     nameLike,
     email,
     inviteStatus,
+    isPlatformAccount,
     pageNumber,
     take,
     skip,
@@ -908,6 +933,10 @@ export class UsersService {
      * Gets or sets the team member invite status for use in a query search.
      */
     inviteStatus?: InviteStatus;
+    /**
+     * Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+     */
+    isPlatformAccount?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -963,6 +992,7 @@ export class UsersService {
         NameLike: nameLike,
         Email: email,
         InviteStatus: inviteStatus,
+        IsPlatformAccount: isPlatformAccount,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -995,6 +1025,7 @@ export class UsersService {
     nameLike,
     email,
     inviteStatus,
+    isPlatformAccount,
     pageNumber,
     take,
     skip,
@@ -1031,6 +1062,10 @@ export class UsersService {
      * Gets or sets the team member invite status for use in a query search.
      */
     inviteStatus?: InviteStatus;
+    /**
+     * Gets or sets a value indicating whether to return only users with a platform role in user_tenant_access for the current tenant.
+     */
+    isPlatformAccount?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1086,6 +1121,7 @@ export class UsersService {
         NameLike: nameLike,
         Email: email,
         InviteStatus: inviteStatus,
+        IsPlatformAccount: isPlatformAccount,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,