reach-api-sdk 1.0.211 → 1.0.213

package/src/index.ts

@@ -11,11 +11,14 @@ export { OpenAPI } from './core/OpenAPI';
 export type { OpenAPIConfig } from './core/OpenAPI';
 
 export type { Activity } from './models/Activity';
+export type { ActivityFacet } from './models/ActivityFacet';
 export type { ActivityPerformance } from './models/ActivityPerformance';
 export type { ActivityPerformancePage } from './models/ActivityPerformancePage';
 export type { ActivityPerformancePatch } from './models/ActivityPerformancePatch';
 export type { ActivityPerformancePost } from './models/ActivityPerformancePost';
+export type { ActivitySearchResponse } from './models/ActivitySearchResponse';
 export { ActivityType } from './models/ActivityType';
+export type { ActivityTypeCategory } from './models/ActivityTypeCategory';
 export type { AddressBookItem } from './models/AddressBookItem';
 export type { AddressBooksRequest } from './models/AddressBooksRequest';
 export type { AddressComponent } from './models/AddressComponent';
@@ -283,6 +286,7 @@ export type { ProgrammePage } from './models/ProgrammePage';
 export type { ProgrammePatch } from './models/ProgrammePatch';
 export type { ProgrammePost } from './models/ProgrammePost';
 export type { Provider } from './models/Provider';
+export type { ProviderActivityLocation } from './models/ProviderActivityLocation';
 export type { ProviderCreate } from './models/ProviderCreate';
 export type { ProviderPage } from './models/ProviderPage';
 export type { ProviderPatch } from './models/ProviderPatch';
@@ -508,9 +512,11 @@ export type { WalletTransactionPage } from './models/WalletTransactionPage';
 export type { WalletTransactionPatch } from './models/WalletTransactionPatch';
 export type { WalletTransactionPost } from './models/WalletTransactionPost';
 export { WalletTransactionType } from './models/WalletTransactionType';
+export { WebsiteHomepage } from './models/WebsiteHomepage';
 
 export { ActivityService } from './services/ActivityService';
 export { ActivityPerformanceService } from './services/ActivityPerformanceService';
+export { ActivityTypeCategoryService } from './services/ActivityTypeCategoryService';
 export { AmenityService } from './services/AmenityService';
 export { AttendeesService } from './services/AttendeesService';
 export { BadEnglandReportService } from './services/BadEnglandReportService';

package/src/models/Activity.ts

@@ -49,6 +49,10 @@ export type Activity = {
    * Gets or sets the activities Icon url.
    */
   iconUrl?: string | null;
+  /**
+   * Gets or sets the activities type category id.
+   */
+  activityTypeCategoryId?: number | null;
   /**
    * Gets or sets the activities referenced surfaces.
    */

package/src/models/ActivityFacet.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents an activity facet with count for filtering in location-based search.
+ */
+export type ActivityFacet = {
+  /**
+   * Gets or sets the activity id.
+   */
+  id?: number;
+  /**
+   * Gets or sets the activity name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the OpenActive activity identifier.
+   */
+  openactiveActivityId?: string | null;
+  /**
+   * Gets or sets the count of activities of this type within the search criteria.
+   */
+  count?: number;
+};

package/src/models/ActivitySearchResponse.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { ActivityFacet } from './ActivityFacet';
+import type { GenericActivity } from './GenericActivity';
+import type { Pagination } from './Pagination';
+
+/**
+ * Response wrapper for activity search that can optionally include activity facets.
+ */
+export type ActivitySearchResponse = {
+  pagination?: Pagination;
+  /**
+   * Gets or sets the activity items.
+   */
+  items?: Array<GenericActivity> | null;
+  /**
+   * Gets or sets the activity facets with counts, when includeActivityFacets=true and location params are provided.
+   */
+  activityFacets?: Array<ActivityFacet> | null;
+};

package/src/models/ActivityTypeCategory.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents an activity type category within the Reach application.
+ */
+export type ActivityTypeCategory = {
+  /**
+   * Gets or sets the activities Id.
+   */
+  id?: number;
+  /**
+   * Gets or sets the activities type category Name.
+   */
+  name?: string | null;
+};

package/src/models/Provider.ts

@@ -4,9 +4,11 @@
 /* eslint-disable */
 
 import type { Country } from './Country';
+import type { ProviderActivityLocation } from './ProviderActivityLocation';
 import type { ProviderType } from './ProviderType';
 import type { StripeAccount } from './StripeAccount';
 import type { Tenant } from './Tenant';
+import type { UpcomingLayout } from './UpcomingLayout';
 import type { User } from './User';
 
 /**
@@ -125,6 +127,7 @@ export type Provider = {
    * Gets or sets the contact website.
    */
   contactWebsite?: string | null;
+  upcomingLayout?: UpcomingLayout;
   /**
    * Gets or sets the facebook url.
    */
@@ -156,5 +159,9 @@ export type Provider = {
    * Gets or sets the providers assigned users.
    */
   users?: Array<User> | null;
+  /**
+   * Gets or sets the distinct locations/venues where the provider offers activities.
+   */
+  activityLocations?: Array<ProviderActivityLocation> | null;
   country?: Country;
 };

package/src/models/ProviderActivityLocation.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a location (venue) where a provider offers activities.
+ */
+export type ProviderActivityLocation = {
+  /**
+   * Gets or sets the full formatted address.
+   */
+  formattedAddress?: string | null;
+  /**
+   * Gets or sets the shortened formatted address (locality, region, postal code).
+   */
+  formattedAddressShortened?: string | null;
+};

package/src/models/ProviderPatch.ts

@@ -3,6 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { UpcomingLayout } from './UpcomingLayout';
 import type { UpdateEmailSettings } from './UpdateEmailSettings';
 
 /**
@@ -81,6 +82,7 @@ export type ProviderPatch = {
    * Gets or sets the contact website.
    */
   contactWebsite?: string | null;
+  upcomingLayout?: UpcomingLayout;
   /**
    * Gets or sets the organisations social media Urls.
    */

package/src/models/TenantSetting.ts

@@ -53,6 +53,10 @@ export type TenantSetting = {
    * Gets or sets a value indicating whether providers are enabled for the tenant (only applicable to enterprise tenants).
    */
   enableProviders?: boolean;
+  /**
+   * Gets or sets a value indicating whether programmes are enabled for the tenant (only applicable to enterprise tenants).
+   */
+  enableProgrammes?: boolean;
   walletTrackingLevel?: WalletTrackingLevel;
   /**
    * Gets or sets a value indicating whether customers are only allowed to use wallet transactions (no card payments).

package/src/models/TenantWebsiteSetting.ts

@@ -4,6 +4,7 @@
 /* eslint-disable */
 
 import type { UpcomingLayout } from './UpcomingLayout';
+import type { WebsiteHomepage } from './WebsiteHomepage';
 
 /**
  * Represents an organisation within the Reach application.
@@ -98,4 +99,16 @@ export type TenantWebsiteSetting = {
    */
   tenantMarketingOptinText?: string | null;
   upcomingLayout?: UpcomingLayout;
+  defaultUpcomingLayoutForVenues?: UpcomingLayout;
+  defaultUpcomingLayoutForProviders?: UpcomingLayout;
+  defaultUpcomingLayoutForProgrammes?: UpcomingLayout;
+  /**
+   * Gets or sets the default map distance in kilometres. Used when displaying the map on the website.
+   */
+  defaultMapDistance?: number | null;
+  /**
+   * Gets or sets the default map center Google Place ID. Used when displaying the map on the website.
+   */
+  defaultMapCenterPlaceId?: string | null;
+  websiteHomepage?: WebsiteHomepage;
 };

package/src/models/TenantWebsiteSettingPatch.ts

@@ -3,6 +3,9 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { UpcomingLayout } from './UpcomingLayout';
+import type { WebsiteHomepage } from './WebsiteHomepage';
+
 /**
  * Post model for tenant website  setting updates.
  */
@@ -63,4 +66,17 @@ export type TenantWebsiteSettingPatch = {
    * Gets or sets the tenants website marketing optin text.
    */
   tenantMarketingOptinText?: string | null;
+  upcomingLayout?: UpcomingLayout;
+  defaultUpcomingLayoutForVenues?: UpcomingLayout;
+  defaultUpcomingLayoutForProviders?: UpcomingLayout;
+  defaultUpcomingLayoutForProgrammes?: UpcomingLayout;
+  /**
+   * Gets or sets the default map distance in kilometres. Used when displaying the map on the website.
+   */
+  defaultMapDistance?: number | null;
+  /**
+   * Gets or sets the default map center Google Place ID. Used when displaying the map on the website.
+   */
+  defaultMapCenterPlaceId?: string | null;
+  websiteHomepage?: WebsiteHomepage;
 };

package/src/models/WebsiteHomepage.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Determines the website homepage display.
+ */
+export enum WebsiteHomepage {
+  DEFAULT = 'Default',
+  MAP = 'Map',
+}

package/src/services/ActivityTypeCategoryService.ts

@@ -0,0 +1,133 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ActivityTypeCategory } from '../models/ActivityTypeCategory';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class ActivityTypeCategoryService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Gets a Reach.Models.ActivityTypeCategory by its Id.
+   * @returns ActivityTypeCategory OK
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The Reach.Models.ActivityTypeCategory id.
+     */
+    id: number;
+  }): CancelablePromise<ActivityTypeCategory> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/activity-type-categories/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of Reach.Models.Activity.
+   * @returns ActivityTypeCategory OK
+   * @throws ApiError
+   */
+  public getList({
+    name,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable name.
+     */
+    name?: string;
+    /**
+     * Gets or sets the page number for paged queries.
+     */
+    pageNumber?: number;
+    /**
+     * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
+     */
+    take?: number;
+    /**
+     * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
+     */
+    skip?: number;
+    /**
+     * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+     */
+    limitListRequests?: boolean;
+    /**
+     * Gets or sets the Tenant Id.
+     */
+    tenantId?: string;
+    /**
+     * Gets or sets the Modifed By Id.
+     */
+    modifiedById?: string;
+    /**
+     * Gets or sets the Modifed By Ids.
+     */
+    modifiedByIds?: Array<string>;
+    /**
+     * Gets or sets the Date Created greater than equal to.
+     */
+    dateCreatedGte?: string;
+    /**
+     * Gets or sets the Date Created less than equal to.
+     */
+    dateCreatedLte?: string;
+    /**
+     * Gets or sets the queryable only is live status.
+     */
+    isLive?: boolean;
+    /**
+     * Gets or sets the sort order direction.
+     */
+    sortOrderDirection?: SearchSortOrderDirection;
+  }): CancelablePromise<Array<ActivityTypeCategory>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/activity-type-categories',
+      query: {
+        Name: name,
+        PageNumber: pageNumber,
+        Take: take,
+        Skip: skip,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+}

package/src/services/CoursesService.ts

@@ -639,6 +639,7 @@ export class CoursesService {
     ids,
     venueId,
     programmeId,
+    providerId,
     surveyId,
     cancellationPolicyId,
     paymentPolicyId,
@@ -695,6 +696,10 @@ export class CoursesService {
      * Gets or sets the queryable Programme Id.
      */
     programmeId?: string;
+    /**
+     * Gets or sets the queryable Provider Id.
+     */
+    providerId?: string;
     /**
      * Gets or sets the queryable Survey Id.
      */
@@ -860,6 +865,7 @@ export class CoursesService {
         Ids: ids,
         VenueId: venueId,
         ProgrammeId: programmeId,
+        ProviderId: providerId,
         SurveyId: surveyId,
         CancellationPolicyId: cancellationPolicyId,
         PaymentPolicyId: paymentPolicyId,
@@ -999,6 +1005,7 @@ export class CoursesService {
     ids,
     venueId,
     programmeId,
+    providerId,
     surveyId,
     cancellationPolicyId,
     paymentPolicyId,
@@ -1055,6 +1062,10 @@ export class CoursesService {
      * Gets or sets the queryable Programme Id.
      */
     programmeId?: string;
+    /**
+     * Gets or sets the queryable Provider Id.
+     */
+    providerId?: string;
     /**
      * Gets or sets the queryable Survey Id.
      */
@@ -1220,6 +1231,7 @@ export class CoursesService {
         Ids: ids,
         VenueId: venueId,
         ProgrammeId: programmeId,
+        ProviderId: providerId,
         SurveyId: surveyId,
         CancellationPolicyId: cancellationPolicyId,
         PaymentPolicyId: paymentPolicyId,
@@ -1278,6 +1290,7 @@ export class CoursesService {
     ids,
     venueId,
     programmeId,
+    providerId,
     surveyId,
     cancellationPolicyId,
     paymentPolicyId,
@@ -1334,6 +1347,10 @@ export class CoursesService {
      * Gets or sets the queryable Programme Id.
      */
     programmeId?: string;
+    /**
+     * Gets or sets the queryable Provider Id.
+     */
+    providerId?: string;
     /**
      * Gets or sets the queryable Survey Id.
      */
@@ -1499,6 +1516,7 @@ export class CoursesService {
         Ids: ids,
         VenueId: venueId,
         ProgrammeId: programmeId,
+        ProviderId: providerId,
         SurveyId: surveyId,
         CancellationPolicyId: cancellationPolicyId,
         PaymentPolicyId: paymentPolicyId,
@@ -1557,6 +1575,7 @@ export class CoursesService {
     ids,
     venueId,
     programmeId,
+    providerId,
     surveyId,
     cancellationPolicyId,
     paymentPolicyId,
@@ -1613,6 +1632,10 @@ export class CoursesService {
      * Gets or sets the queryable Programme Id.
      */
     programmeId?: string;
+    /**
+     * Gets or sets the queryable Provider Id.
+     */
+    providerId?: string;
     /**
      * Gets or sets the queryable Survey Id.
      */
@@ -1778,6 +1801,7 @@ export class CoursesService {
         Ids: ids,
         VenueId: venueId,
         ProgrammeId: programmeId,
+        ProviderId: providerId,
         SurveyId: surveyId,
         CancellationPolicyId: cancellationPolicyId,
         PaymentPolicyId: paymentPolicyId,
@@ -1836,6 +1860,7 @@ export class CoursesService {
     ids,
     venueId,
     programmeId,
+    providerId,
     surveyId,
     cancellationPolicyId,
     paymentPolicyId,
@@ -1892,6 +1917,10 @@ export class CoursesService {
      * Gets or sets the queryable Programme Id.
      */
     programmeId?: string;
+    /**
+     * Gets or sets the queryable Provider Id.
+     */
+    providerId?: string;
     /**
      * Gets or sets the queryable Survey Id.
      */
@@ -2057,6 +2086,7 @@ export class CoursesService {
         Ids: ids,
         VenueId: venueId,
         ProgrammeId: programmeId,
+        ProviderId: providerId,
         SurveyId: surveyId,
         CancellationPolicyId: cancellationPolicyId,
         PaymentPolicyId: paymentPolicyId,