reach-api-sdk 1.0.202 → 1.0.204

package/src/services/PublicVenueTypesService.ts

@@ -0,0 +1,401 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+import type { VenueType } from '../models/VenueType';
+import type { VenueTypePage } from '../models/VenueTypePage';
+import type { VenueTypePatch } from '../models/VenueTypePatch';
+import type { VenueTypePost } from '../models/VenueTypePost';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class PublicVenueTypesService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * @returns VenueType OK
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+    xTenantSubdomain,
+  }: {
+    id: string;
+    xTenantSubdomain?: string;
+  }): CancelablePromise<VenueType> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/venue-types/{id}',
+      path: {
+        id: id,
+      },
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public deleteById({
+    id,
+    xTenantSubdomain,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/public/venue-types/{id}',
+      path: {
+        id: id,
+      },
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * @returns VenueTypePage OK
+   * @throws ApiError
+   */
+  public getPage({
+    xTenantSubdomain,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    xTenantSubdomain?: 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<VenueTypePage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/venue-types',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        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`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public deleteByObject({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: VenueType;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/public/venue-types',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      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 VenueType OK
+   * @throws ApiError
+   */
+  public post({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: VenueTypePost;
+  }): CancelablePromise<VenueType> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/public/venue-types/v2-temporary-route',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns VenueType OK
+   * @throws ApiError
+   */
+  public patch({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: VenueTypePatch;
+  }): CancelablePromise<VenueType> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/public/venue-types/v2-temporary-route',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Inserts a list of resources.
+   * @returns VenueType OK
+   * @throws ApiError
+   */
+  public postList({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The list of <typeparamref name="TObject" />.
+     */
+    requestBody?: Array<VenueTypePost>;
+  }): CancelablePromise<Array<VenueType>> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/public/venue-types/v2-temporary-route/list',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Returns a value indicating whether the resource exists in the database given the provided search params.
+   * @returns boolean OK
+   * @throws ApiError
+   */
+  public exists({
+    xTenantSubdomain,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: 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<boolean> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/venue-types/exists',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        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/PublicVenuesService.ts

@@ -105,6 +105,7 @@ export class PublicVenuesService {
     distance,
     dashboardRequest,
     programmeIds,
+    venueTypeIds,
     pageNumber,
     take,
     skip,
@@ -202,6 +203,10 @@ export class PublicVenuesService {
      * Gets or sets the programme ids.
      */
     programmeIds?: Array<string>;
+    /**
+     * Gets or sets the venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -275,6 +280,7 @@ export class PublicVenuesService {
         Distance: distance,
         DashboardRequest: dashboardRequest,
         ProgrammeIds: programmeIds,
+        VenueTypeIds: venueTypeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -356,6 +362,7 @@ export class PublicVenuesService {
     distance,
     dashboardRequest,
     programmeIds,
+    venueTypeIds,
     pageNumber,
     take,
     skip,
@@ -452,6 +459,10 @@ export class PublicVenuesService {
      * Gets or sets the programme ids.
      */
     programmeIds?: Array<string>;
+    /**
+     * Gets or sets the venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -522,6 +533,226 @@ export class PublicVenuesService {
         Distance: distance,
         DashboardRequest: dashboardRequest,
         ProgrammeIds: programmeIds,
+        VenueTypeIds: venueTypeIds,
+        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`,
+      },
+    });
+  }
+
+  /**
+   * Get Venues for a network using optimized query.
+   * @returns VenuePage OK
+   * @throws ApiError
+   */
+  public getNetworkPageOptimized({
+    ids,
+    wildcard,
+    name,
+    streetAddress,
+    addressPostalcode,
+    nameLike,
+    slug,
+    assignedTo,
+    stripeAccountId,
+    searchGeoCenter,
+    publishedOnWeb,
+    archived,
+    networkId,
+    tenantStatus,
+    programmeId,
+    includeOpportunityImages,
+    includeOpportunityOffers,
+    includeNextOpportunity,
+    distance,
+    dashboardRequest,
+    programmeIds,
+    venueTypeIds,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable venue ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable venue name wildcard.
+     */
+    wildcard?: string;
+    /**
+     * Gets or sets the queryable venue name.
+     */
+    name?: string;
+    /**
+     * Gets or sets the queryable venue street address.
+     */
+    streetAddress?: string;
+    /**
+     * Gets or sets the queryable venue address postal code.
+     */
+    addressPostalcode?: string;
+    /**
+     * Gets or sets the queryable venue name wildcard.
+     */
+    nameLike?: string;
+    /**
+     * Gets or sets the queryable venue url slug.
+     */
+    slug?: string;
+    /**
+     * Gets or sets the queryable assign to Id.
+     */
+    assignedTo?: string;
+    /**
+     * Gets or sets the queryable stripe account Id.
+     */
+    stripeAccountId?: string;
+    /**
+     * Gets or sets the queryable search geo center.
+     */
+    searchGeoCenter?: string;
+    /**
+     * Gets or sets a value indicating whether to show published venues.
+     */
+    publishedOnWeb?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include archived venues.
+     */
+    archived?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include only sessions by given NetworkId.
+     */
+    networkId?: string;
+    /**
+     * Gets or sets a value indicating whether the results should return a specific tenant status.
+     */
+    tenantStatus?: TenantStatus;
+    /**
+     * Gets or sets the queryable programme Id.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets a value indicating whether to inlcude the venues opportunity images.
+     */
+    includeOpportunityImages?: boolean;
+    /**
+     * Gets or sets a value indicating whether to inlcude the venues opportunity offers.
+     */
+    includeOpportunityOffers?: boolean;
+    /**
+     * Gets or sets a value indicating whether to inlcude the venues opportunity next availability.
+     */
+    includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets Distance.
+     */
+    distance?: number;
+    /**
+     * Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
+     */
+    dashboardRequest?: boolean;
+    /**
+     * Gets or sets the programme ids.
+     */
+    programmeIds?: Array<string>;
+    /**
+     * Gets or sets the venue type ids.
+     */
+    venueTypeIds?: Array<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<VenuePage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/venues/network/optimized',
+      query: {
+        Ids: ids,
+        Wildcard: wildcard,
+        Name: name,
+        StreetAddress: streetAddress,
+        AddressPostalcode: addressPostalcode,
+        NameLike: nameLike,
+        Slug: slug,
+        AssignedTo: assignedTo,
+        StripeAccountId: stripeAccountId,
+        SearchGeoCenter: searchGeoCenter,
+        PublishedOnWeb: publishedOnWeb,
+        Archived: archived,
+        NetworkId: networkId,
+        TenantStatus: tenantStatus,
+        ProgrammeId: programmeId,
+        IncludeOpportunityImages: includeOpportunityImages,
+        IncludeOpportunityOffers: includeOpportunityOffers,
+        IncludeNextOpportunity: includeNextOpportunity,
+        Distance: distance,
+        DashboardRequest: dashboardRequest,
+        ProgrammeIds: programmeIds,
+        VenueTypeIds: venueTypeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -672,6 +903,7 @@ export class PublicVenuesService {
     distance,
     dashboardRequest,
     programmeIds,
+    venueTypeIds,
     pageNumber,
     take,
     skip,
@@ -772,6 +1004,10 @@ export class PublicVenuesService {
      * Gets or sets the programme ids.
      */
     programmeIds?: Array<string>;
+    /**
+     * Gets or sets the venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -845,6 +1081,7 @@ export class PublicVenuesService {
         Distance: distance,
         DashboardRequest: dashboardRequest,
         ProgrammeIds: programmeIds,
+        VenueTypeIds: venueTypeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,