reach-api-sdk 1.0.221 → 1.0.222

package/src/index.ts

@@ -441,6 +441,10 @@ export type { TemplatePatch } from './models/TemplatePatch';
 export type { TemplatePost } from './models/TemplatePost';
 export type { TemplateUseResponse } from './models/TemplateUseResponse';
 export type { Tenant } from './models/Tenant';
+export type { TenantFaq } from './models/TenantFaq';
+export type { TenantFaqPage } from './models/TenantFaqPage';
+export type { TenantFaqPatch } from './models/TenantFaqPatch';
+export type { TenantFaqPost } from './models/TenantFaqPost';
 export type { TenantPage } from './models/TenantPage';
 export type { TenantPatch } from './models/TenantPatch';
 export type { TenantPost } from './models/TenantPost';
@@ -630,6 +634,7 @@ export { PublicStripeWebhookService } from './services/PublicStripeWebhookServic
 export { PublicSurveyCompletionLogsService } from './services/PublicSurveyCompletionLogsService';
 export { PublicSurveyQuestionsService } from './services/PublicSurveyQuestionsService';
 export { PublicSurveysService } from './services/PublicSurveysService';
+export { PublicTenantFaqsService } from './services/PublicTenantFaqsService';
 export { PublicTenantsService } from './services/PublicTenantsService';
 export { PublicVenuesService } from './services/PublicVenuesService';
 export { PublicVenueTypesService } from './services/PublicVenueTypesService';
@@ -658,6 +663,7 @@ export { TemplateDetailsService } from './services/TemplateDetailsService';
 export { TemplateFieldPermissionsService } from './services/TemplateFieldPermissionsService';
 export { TemplateOffersService } from './services/TemplateOffersService';
 export { TemplatesService } from './services/TemplatesService';
+export { TenantFaqsService } from './services/TenantFaqsService';
 export { TenantsService } from './services/TenantsService';
 export { TenantWebsiteSettingsService } from './services/TenantWebsiteSettingsService';
 export { TimezoneService } from './services/TimezoneService';

package/src/models/TenantFaq.ts

@@ -0,0 +1,54 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a single Frequently Asked Question entry owned by a tenant.
+ */
+export type TenantFaq = {
+  /**
+   * 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 question text.
+   */
+  question?: string | null;
+  /**
+   * Gets or sets the answer text. Stored as sanitized HTML (basic formatting only - paragraphs, bullets, links).
+   */
+  answer?: string | null;
+  /**
+   * Gets or sets the display order for the FAQ within the tenant list. Lower values appear first.
+   */
+  sortOrder?: number;
+  /**
+   * Gets or sets a value indicating whether this FAQ is shown on the public storefront.
+   */
+  showOnStorefront?: boolean;
+  /**
+   * Gets or sets a value indicating whether this FAQ is shown on the customer portal.
+   */
+  showOnCustomerPortal?: boolean;
+};

package/src/models/TenantFaqPage.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Pagination } from './Pagination';
+import type { TenantFaq } from './TenantFaq';
+
+export type TenantFaqPage = {
+  pagination: Pagination;
+  readonly items: Array<TenantFaq>;
+};

package/src/models/TenantFaqPatch.ts

@@ -0,0 +1,42 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for a tenant FAQ entry.
+ */
+export type TenantFaqPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the question text.
+   */
+  question?: string | null;
+  /**
+   * Gets or sets the answer text (sanitized HTML).
+   */
+  answer?: string | null;
+  /**
+   * Gets or sets the display order for the FAQ within the tenant list.
+   */
+  sortOrder?: number;
+  /**
+   * Gets or sets a value indicating whether this FAQ is shown on the public storefront.
+   */
+  showOnStorefront?: boolean;
+  /**
+   * Gets or sets a value indicating whether this FAQ is shown on the customer portal.
+   */
+  showOnCustomerPortal?: boolean;
+  /**
+   * Gets or sets a value indicating whether this FAQ is live (published).
+   */
+  isLive?: boolean;
+};

package/src/models/TenantFaqPost.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for a tenant FAQ entry.
+ */
+export type TenantFaqPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the question text.
+   */
+  question?: string | null;
+  /**
+   * Gets or sets the answer text (sanitized HTML).
+   */
+  answer?: string | null;
+  /**
+   * Gets or sets the display order for the FAQ within the tenant list.
+   */
+  sortOrder?: number;
+  /**
+   * Gets or sets a value indicating whether this FAQ is shown on the public storefront.
+   */
+  showOnStorefront?: boolean;
+  /**
+   * Gets or sets a value indicating whether this FAQ is shown on the customer portal.
+   */
+  showOnCustomerPortal?: boolean;
+  /**
+   * Gets or sets a value indicating whether this FAQ is live (published).
+   */
+  isLive?: boolean;
+};

package/src/services/PublicTenantFaqsService.ts

@@ -0,0 +1,264 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+import type { TenantFaq } from '../models/TenantFaq';
+import type { TenantFaqPage } from '../models/TenantFaqPage';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class PublicTenantFaqsService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * @returns TenantFaq OK
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+    xTenantSubdomain,
+  }: {
+    id: string;
+    xTenantSubdomain?: string;
+  }): CancelablePromise<TenantFaq> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/tenant-faqs/{id}',
+      path: {
+        id: id,
+      },
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * @returns TenantFaqPage OK
+   * @throws ApiError
+   */
+  public getPage({
+    xTenantSubdomain,
+    ids,
+    showOnStorefront,
+    showOnCustomerPortal,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    xTenantSubdomain?: string;
+    /**
+     * Gets or sets the queryable tenant FAQ ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable ShowOnStorefront value.
+     */
+    showOnStorefront?: boolean;
+    /**
+     * Gets or sets the queryable ShowOnCustomerPortal value.
+     */
+    showOnCustomerPortal?: boolean;
+    /**
+     * 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<TenantFaqPage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/tenant-faqs',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        Ids: ids,
+        ShowOnStorefront: showOnStorefront,
+        ShowOnCustomerPortal: showOnCustomerPortal,
+        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`,
+      },
+    });
+  }
+
+  /**
+   * Returns a value indicating whether the resource exists in the database given the provided search params.
+   * @returns boolean OK
+   * @throws ApiError
+   */
+  public exists({
+    xTenantSubdomain,
+    ids,
+    showOnStorefront,
+    showOnCustomerPortal,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * Gets or sets the queryable tenant FAQ ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable ShowOnStorefront value.
+     */
+    showOnStorefront?: boolean;
+    /**
+     * Gets or sets the queryable ShowOnCustomerPortal value.
+     */
+    showOnCustomerPortal?: boolean;
+    /**
+     * 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/tenant-faqs/exists',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        Ids: ids,
+        ShowOnStorefront: showOnStorefront,
+        ShowOnCustomerPortal: showOnCustomerPortal,
+        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`,
+      },
+    });
+  }
+}