reach-api-sdk 1.0.195 → 1.0.196

package/src/definition/swagger.yaml

@@ -19626,6 +19626,13 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OrderStages
+          in: query
+          description: Gets or sets the queryable order stages.
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/OrderStage'
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -19943,6 +19950,13 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OrderStages
+          in: query
+          description: Gets or sets the queryable order stages.
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/OrderStage'
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -20082,6 +20096,13 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OrderStages
+          in: query
+          description: Gets or sets the queryable order stages.
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/OrderStage'
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -20224,6 +20245,13 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OrderStages
+          in: query
+          description: Gets or sets the queryable order stages.
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/OrderStage'
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -20369,6 +20397,13 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OrderStages
+          in: query
+          description: Gets or sets the queryable order stages.
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/OrderStage'
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -80330,6 +80365,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -80609,6 +80649,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -131203,6 +131248,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -131531,6 +131581,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -131681,6 +131736,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -131834,6 +131894,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -131990,6 +132055,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -132147,6 +132217,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -132263,6 +132338,51 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  /api/waitlist-opportunity-report/conversion-stats:
+    get:
+      tags:
+        - WaitlistOpportunityReport
+      summary: Gets waitlist conversion statistics.
+      operationId: GetConversionStats
+      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/waitlist-opportunity-report/v2-temporary-route:
     post:
       tags:
@@ -132634,6 +132754,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -132962,6 +133087,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -133112,6 +133242,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -133265,6 +133400,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -133421,6 +133561,11 @@ paths:
           description: Gets or sets the queryable Email.
           schema:
             type: string
+        - name: FutureOnly
+          in: query
+          description: Gets or sets a value indicating whether to filter for future opportunities only.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.

package/src/services/DiscountCodeUsesService.ts

@@ -6,6 +6,7 @@ import type { DiscountCodeUse } from '../models/DiscountCodeUse';
 import type { DiscountCodeUsePage } from '../models/DiscountCodeUsePage';
 import type { DiscountCodeUsePatch } from '../models/DiscountCodeUsePatch';
 import type { DiscountCodeUsePost } from '../models/DiscountCodeUsePost';
+import type { OrderStage } from '../models/OrderStage';
 import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
 
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -153,6 +154,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -177,6 +179,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -229,6 +235,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -339,6 +346,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -363,6 +371,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -415,6 +427,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -444,6 +457,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -468,6 +482,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -520,6 +538,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -549,6 +568,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -573,6 +593,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -625,6 +649,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -654,6 +679,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -678,6 +704,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -730,6 +760,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,

package/src/services/PublicWaitlistOpportunityService.ts

@@ -162,6 +162,7 @@ export class PublicWaitlistOpportunityService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -198,6 +199,10 @@ export class PublicWaitlistOpportunityService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -255,6 +260,7 @@ export class PublicWaitlistOpportunityService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -357,6 +363,7 @@ export class PublicWaitlistOpportunityService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -393,6 +400,10 @@ export class PublicWaitlistOpportunityService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -450,6 +461,7 @@ export class PublicWaitlistOpportunityService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,

package/src/services/WaitlistOpportunityReportService.ts

@@ -26,6 +26,7 @@ export class WaitlistOpportunityReportService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -59,6 +60,10 @@ export class WaitlistOpportunityReportService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -119,6 +124,7 @@ export class WaitlistOpportunityReportService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -141,6 +147,23 @@ export class WaitlistOpportunityReportService {
     });
   }
 
+  /**
+   * Gets waitlist conversion statistics.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public getConversionStats(): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/waitlist-opportunity-report/conversion-stats',
+      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 WaitlistOpportunityReport OK
@@ -282,6 +305,7 @@ export class WaitlistOpportunityReportService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -314,6 +338,10 @@ export class WaitlistOpportunityReportService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -368,6 +396,7 @@ export class WaitlistOpportunityReportService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -480,6 +509,7 @@ export class WaitlistOpportunityReportService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -512,6 +542,10 @@ export class WaitlistOpportunityReportService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -566,6 +600,7 @@ export class WaitlistOpportunityReportService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -597,6 +632,7 @@ export class WaitlistOpportunityReportService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -629,6 +665,10 @@ export class WaitlistOpportunityReportService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -683,6 +723,7 @@ export class WaitlistOpportunityReportService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -714,6 +755,7 @@ export class WaitlistOpportunityReportService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -746,6 +788,10 @@ export class WaitlistOpportunityReportService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -800,6 +846,7 @@ export class WaitlistOpportunityReportService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -831,6 +878,7 @@ export class WaitlistOpportunityReportService {
     scheduledSessionId,
     courseId,
     email,
+    futureOnly,
     pageNumber,
     take,
     skip,
@@ -863,6 +911,10 @@ export class WaitlistOpportunityReportService {
      * Gets or sets the queryable Email.
      */
     email?: string;
+    /**
+     * Gets or sets a value indicating whether to filter for future opportunities only.
+     */
+    futureOnly?: boolean;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -917,6 +969,7 @@ export class WaitlistOpportunityReportService {
         ScheduledSessionId: scheduledSessionId,
         CourseId: courseId,
         Email: email,
+        FutureOnly: futureOnly,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,