reach-api-sdk 1.0.30 → 1.0.31

package/dist/reach-sdk.d.ts

@@ -1149,6 +1149,28 @@ type Country = {
     taxes?: Array<Tax> | null;
 };
 
+/**
+ * Model for customer stats.
+ */
+type CustomerStats = {
+    /**
+     * Gets or sets the total revenue recieved from the customer.
+     */
+    totalRevenue: number;
+    /**
+     * Gets or sets the total number of orders placed by the customer.
+     */
+    totalOrders: number;
+    /**
+     * Gets or sets the total number of cancellations.
+     */
+    totalCancellations: number;
+    /**
+     * Gets or sets the total amount refunded to the customer.
+     */
+    totalRefunded: number;
+};
+
 /**
  * The customer type.
  */
@@ -1242,6 +1264,7 @@ type Customer = {
      * Gets or sets how many times the customer has booked with the organisation.
      */
     bookingCount?: number | null;
+    stats?: CustomerStats;
 };
 
 /**
@@ -6420,6 +6443,17 @@ type CustomerPost = {
 declare class CustomersService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Gets the customer with added stats.
+     * @returns Customer Success
+     * @throws ApiError
+     */
+    getObjectWithStats({ id, }: {
+        /**
+         * The customer Id.
+         */
+        id: string;
+    }): CancelablePromise<Customer>;
     /**
      * Exports the customers list to a csv format.
      * Endpoint has AllowAnonymous attr, however the jwt is validated in the method body (in support of authenticated file downloads.
@@ -28860,4 +28894,4 @@ type ValidationResultModel = {
     readonly errors?: Array<ValidationError> | null;
 };
 
-export { Activity, ActivityService, ActivityType, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, Attendee, AttendeePage, AttendeePatch, AttendeePost, AttendeesService, AutoCompleteResponseModel, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CoursesService, CreateOffer, CreateQuestion, CreateQuestionOption, CreateVenue, Customer, CustomerCancellationOption, CustomerPage, CustomerPatch, CustomerPost, CustomerType, CustomersService, DayOfWeek, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FilestackImageMetaResponseModel, FilestackService, GenericActivity, GenericActivityPage, GenericActivityPatch, GenericActivityPost, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HereAddressDetails, HereAutoComplete, HereAutocompleteLookupService, HereLookupResults, HereMapDetails, HerePositionDetails, HttpStatusCode, IOpportunity, Image, ImagePage, ImagePatch, ImagePost, ImagesService, InviteStatus, LeasingService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueuePatch, NotificationQueuePost, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingPatch, NotificationSettingPost, NotificationSettingsService, NotificationType, Offer, OfferPage, OfferPatch, OfferPost, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediatePatch, OpenactiveFeedIntermediatePost, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemPatch, OpenactiveFeedItemPost, OpenactiveFeedItemService, OpportunityRegister, OpportunityRegisterPage, OpportunityRegisterPatch, OpportunityRegisterPost, OpportunityRegisterService, OpportunityType, Order, OrderItem, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPost, OrderPostItem, OrderRefresh, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrderUpdateContact, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, PatchSurveyQuestionOption, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPost, PaymentsService, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, PublicBookingService, PublicCoursesService, PublicFacilitiesService, PublicHealthCheckService, PublicLeasingService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, ScheduleStatus, ScheduledSession, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionCreate, SessionGender, SessionPage, SessionPatch, SessionPost, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOfferPatch, SlotOfferPost, SlotOffersService, SlotPage, SlotPatch, SlotPost, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOfferPatch, SlotScheduleOfferPost, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulePatch, SlotSchedulePost, SlotSchedulesService, SlotStatus, SlotsService, Southwest, StripeAccount, StripeAccountPage, StripeAccountPatch, StripeAccountPost, StripeAccountService, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswerPatch, SurveyAnswerPost, SurveyAnswersService, SurveyCreate, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPost, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveyResponseMode, SurveySubmissionModel, SurveySubmissionResponse, SurveySubmit, SurveyType, SurveysService, Tax, Tenant, TenantPage, TenantPatch, TenantPost, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingPatch, TenantWebsiteSettingPost, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportPatch, TotalRevenueReportPost, TotalRevenueReportService, UpdateEmailSettings, UpdateOffer, User, UserPage, UserPatch, UserPost, UserRole, UsersService, ValidationError, ValidationResultModel, Venue, VenueBadmintonEnglandReport, VenueBadmintonEnglandReportPage, VenueBadmintonEnglandReportPatch, VenueBadmintonEnglandReportPost, VenueCreate, VenueOpeningHours, VenuePage, VenuePatch, VenuePost, VenuesReport, VenuesReportPage, VenuesReportPatch, VenuesReportPost, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityPatch, WaitlistActivityPost, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityService };
+export { Activity, ActivityService, ActivityType, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, Attendee, AttendeePage, AttendeePatch, AttendeePost, AttendeesService, AutoCompleteResponseModel, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CoursesService, CreateOffer, CreateQuestion, CreateQuestionOption, CreateVenue, Customer, CustomerCancellationOption, CustomerPage, CustomerPatch, CustomerPost, CustomerStats, CustomerType, CustomersService, DayOfWeek, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FilestackImageMetaResponseModel, FilestackService, GenericActivity, GenericActivityPage, GenericActivityPatch, GenericActivityPost, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HereAddressDetails, HereAutoComplete, HereAutocompleteLookupService, HereLookupResults, HereMapDetails, HerePositionDetails, HttpStatusCode, IOpportunity, Image, ImagePage, ImagePatch, ImagePost, ImagesService, InviteStatus, LeasingService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueuePatch, NotificationQueuePost, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingPatch, NotificationSettingPost, NotificationSettingsService, NotificationType, Offer, OfferPage, OfferPatch, OfferPost, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediatePatch, OpenactiveFeedIntermediatePost, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemPatch, OpenactiveFeedItemPost, OpenactiveFeedItemService, OpportunityRegister, OpportunityRegisterPage, OpportunityRegisterPatch, OpportunityRegisterPost, OpportunityRegisterService, OpportunityType, Order, OrderItem, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPost, OrderPostItem, OrderRefresh, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrderUpdateContact, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, PatchSurveyQuestionOption, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPost, PaymentsService, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, PublicBookingService, PublicCoursesService, PublicFacilitiesService, PublicHealthCheckService, PublicLeasingService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, ScheduleStatus, ScheduledSession, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionCreate, SessionGender, SessionPage, SessionPatch, SessionPost, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOfferPatch, SlotOfferPost, SlotOffersService, SlotPage, SlotPatch, SlotPost, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOfferPatch, SlotScheduleOfferPost, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulePatch, SlotSchedulePost, SlotSchedulesService, SlotStatus, SlotsService, Southwest, StripeAccount, StripeAccountPage, StripeAccountPatch, StripeAccountPost, StripeAccountService, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswerPatch, SurveyAnswerPost, SurveyAnswersService, SurveyCreate, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPost, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveyResponseMode, SurveySubmissionModel, SurveySubmissionResponse, SurveySubmit, SurveyType, SurveysService, Tax, Tenant, TenantPage, TenantPatch, TenantPost, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingPatch, TenantWebsiteSettingPost, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportPatch, TotalRevenueReportPost, TotalRevenueReportService, UpdateEmailSettings, UpdateOffer, User, UserPage, UserPatch, UserPost, UserRole, UsersService, ValidationError, ValidationResultModel, Venue, VenueBadmintonEnglandReport, VenueBadmintonEnglandReportPage, VenueBadmintonEnglandReportPatch, VenueBadmintonEnglandReportPost, VenueCreate, VenueOpeningHours, VenuePage, VenuePatch, VenuePost, VenuesReport, VenuesReportPage, VenuesReportPatch, VenuesReportPost, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityPatch, WaitlistActivityPost, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityService };

package/dist/reach-sdk.js

@@ -3011,6 +3011,27 @@ const request = (config, options, axiosClient = axios) => {
   constructor(httpRequest) {
     this.httpRequest = httpRequest;
   }
+  /**
+   * Gets the customer with added stats.
+   * @returns Customer Success
+   * @throws ApiError
+   */
+  getObjectWithStats({
+    id
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/api/customers/{id}/with-stats",
+      path: {
+        id
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Client Error`,
+        500: `Server Error`
+      }
+    });
+  }
   /**
    * Exports the customers list to a csv format.
    * Endpoint has AllowAnonymous attr, however the jwt is validated in the method body (in support of authenticated file downloads.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reach-api-sdk",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "description": "sdk for reach api",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/definition/swagger.yaml

@@ -7939,6 +7939,69 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  '/api/customers/{id}/with-stats':
+    get:
+      tags:
+        - Customers
+      summary: Gets the customer with added stats.
+      operationId: GetObjectWithStats
+      parameters:
+        - name: id
+          in: path
+          description: The customer Id.
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: Success
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/Customer'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Customer'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/Customer'
+        '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: 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: Client Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   /api/customers/export/csv:
     post:
       tags:
@@ -67332,6 +67395,8 @@ components:
           description: Gets or sets how many times the customer has booked with the organisation.
           format: int32
           nullable: true
+        stats:
+          $ref: '#/components/schemas/CustomerStats'
       additionalProperties: false
       description: Represents an organisation within the Reach application.
     CustomerCancellationOption:
@@ -67477,6 +67542,34 @@ components:
           default: false
       additionalProperties: false
       description: Post model for customer inserts.
+    CustomerStats:
+      required:
+        - totalCancellations
+        - totalOrders
+        - totalRefunded
+        - totalRevenue
+      type: object
+      properties:
+        totalRevenue:
+          type: number
+          description: Gets or sets the total revenue recieved from the customer.
+          format: double
+        totalOrders:
+          type: integer
+          description: Gets or sets the total number of orders placed by the customer.
+          format: int32
+          default: 0
+        totalCancellations:
+          type: integer
+          description: Gets or sets the total number of cancellations.
+          format: int32
+          default: 0
+        totalRefunded:
+          type: number
+          description: Gets or sets the total amount refunded to the customer.
+          format: double
+      additionalProperties: false
+      description: Model for customer stats.
     CustomerType:
       enum:
         - Person

package/src/index.ts

@@ -47,6 +47,7 @@ export { CustomerCancellationOption } from './models/CustomerCancellationOption'
 export type { CustomerPage } from './models/CustomerPage';
 export type { CustomerPatch } from './models/CustomerPatch';
 export type { CustomerPost } from './models/CustomerPost';
+export type { CustomerStats } from './models/CustomerStats';
 export { CustomerType } from './models/CustomerType';
 export { DayOfWeek } from './models/DayOfWeek';
 export type { EmailReminderSchedule } from './models/EmailReminderSchedule';

package/src/models/Customer.ts

@@ -3,6 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { CustomerStats } from './CustomerStats';
 import type { CustomerType } from './CustomerType';
 
 /**
@@ -90,4 +91,5 @@ export type Customer = {
    * Gets or sets how many times the customer has booked with the organisation.
    */
   bookingCount?: number | null;
+  stats?: CustomerStats;
 };

package/src/models/CustomerStats.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Model for customer stats.
+ */
+export type CustomerStats = {
+  /**
+   * Gets or sets the total revenue recieved from the customer.
+   */
+  totalRevenue: number;
+  /**
+   * Gets or sets the total number of orders placed by the customer.
+   */
+  totalOrders: number;
+  /**
+   * Gets or sets the total number of cancellations.
+   */
+  totalCancellations: number;
+  /**
+   * Gets or sets the total amount refunded to the customer.
+   */
+  totalRefunded: number;
+};

package/src/services/CustomersService.ts

@@ -14,6 +14,33 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
 export class CustomersService {
   constructor(public readonly httpRequest: BaseHttpRequest) {}
 
+  /**
+   * Gets the customer with added stats.
+   * @returns Customer Success
+   * @throws ApiError
+   */
+  public getObjectWithStats({
+    id,
+  }: {
+    /**
+     * The customer Id.
+     */
+    id: string;
+  }): CancelablePromise<Customer> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/customers/{id}/with-stats',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Client Error`,
+        500: `Server Error`,
+      },
+    });
+  }
+
   /**
    * Exports the customers list to a csv format.
    * Endpoint has AllowAnonymous attr, however the jwt is validated in the method body (in support of authenticated file downloads.