reach-api-sdk 1.0.210 → 1.0.211

package/src/index.ts

@@ -16,6 +16,8 @@ export type { ActivityPerformancePage } from './models/ActivityPerformancePage';
 export type { ActivityPerformancePatch } from './models/ActivityPerformancePatch';
 export type { ActivityPerformancePost } from './models/ActivityPerformancePost';
 export { ActivityType } from './models/ActivityType';
+export type { AddressBookItem } from './models/AddressBookItem';
+export type { AddressBooksRequest } from './models/AddressBooksRequest';
 export type { AddressComponent } from './models/AddressComponent';
 export { AdvanceBooking } from './models/AdvanceBooking';
 export type { Amenity } from './models/Amenity';
@@ -109,6 +111,8 @@ export type { DiscountCodeUse } from './models/DiscountCodeUse';
 export type { DiscountCodeUsePage } from './models/DiscountCodeUsePage';
 export type { DiscountCodeUsePatch } from './models/DiscountCodeUsePatch';
 export type { DiscountCodeUsePost } from './models/DiscountCodeUsePost';
+export { DotdigitalCanonicalField } from './models/DotdigitalCanonicalField';
+export { DotdigitalSourceType } from './models/DotdigitalSourceType';
 export type { EmailReminderSchedule } from './models/EmailReminderSchedule';
 export type { EmailReminderSchedulePage } from './models/EmailReminderSchedulePage';
 export type { EmailReminderSchedulePatch } from './models/EmailReminderSchedulePatch';
@@ -152,6 +156,25 @@ export type { ImageUploadHistory } from './models/ImageUploadHistory';
 export type { ImageUploadHistoryPage } from './models/ImageUploadHistoryPage';
 export type { ImageUploadHistoryPatch } from './models/ImageUploadHistoryPatch';
 export type { ImageUploadHistoryPost } from './models/ImageUploadHistoryPost';
+export type { IntegrationDotdigitalFieldMap } from './models/IntegrationDotdigitalFieldMap';
+export type { IntegrationDotdigitalFieldMapPage } from './models/IntegrationDotdigitalFieldMapPage';
+export type { IntegrationDotdigitalFieldMapPatch } from './models/IntegrationDotdigitalFieldMapPatch';
+export type { IntegrationDotdigitalFieldMapPost } from './models/IntegrationDotdigitalFieldMapPost';
+export type { IntegrationDotdigitalLog } from './models/IntegrationDotdigitalLog';
+export type { IntegrationDotdigitalLogPage } from './models/IntegrationDotdigitalLogPage';
+export type { IntegrationDotdigitalLogPatch } from './models/IntegrationDotdigitalLogPatch';
+export type { IntegrationDotdigitalLogPost } from './models/IntegrationDotdigitalLogPost';
+export { IntegrationDotdigitalLogStatus } from './models/IntegrationDotdigitalLogStatus';
+export type { IntegrationDotdigitalSettings } from './models/IntegrationDotdigitalSettings';
+export type { IntegrationDotdigitalSettingsCreate } from './models/IntegrationDotdigitalSettingsCreate';
+export type { IntegrationDotdigitalSettingsPage } from './models/IntegrationDotdigitalSettingsPage';
+export type { IntegrationDotdigitalSettingsPatch } from './models/IntegrationDotdigitalSettingsPatch';
+export type { IntegrationDotdigitalSettingsPost } from './models/IntegrationDotdigitalSettingsPost';
+export type { IntegrationQueue } from './models/IntegrationQueue';
+export type { IntegrationQueuePage } from './models/IntegrationQueuePage';
+export type { IntegrationQueuePatch } from './models/IntegrationQueuePatch';
+export type { IntegrationQueuePost } from './models/IntegrationQueuePost';
+export { IntegrationType } from './models/IntegrationType';
 export { InviteStatus } from './models/InviteStatus';
 export type { IOpportunity } from './models/IOpportunity';
 export type { LocationReport } from './models/LocationReport';
@@ -503,6 +526,7 @@ export { CustomFieldsService } from './services/CustomFieldsService';
 export { DealActivitiesService } from './services/DealActivitiesService';
 export { DealsService } from './services/DealsService';
 export { DiscountCodeUsesService } from './services/DiscountCodeUsesService';
+export { DotdigitalService } from './services/DotdigitalService';
 export { EmailReminderSchedulesService } from './services/EmailReminderSchedulesService';
 export { EmailSettingsService } from './services/EmailSettingsService';
 export { EndUserIdentitySecureTokenService } from './services/EndUserIdentitySecureTokenService';
@@ -518,6 +542,10 @@ export { ImageLibraryCategoryService } from './services/ImageLibraryCategoryServ
 export { ImageLibraryImageService } from './services/ImageLibraryImageService';
 export { ImagesService } from './services/ImagesService';
 export { ImageUploadHistoryService } from './services/ImageUploadHistoryService';
+export { IntegrationDotdigitalFieldMapService } from './services/IntegrationDotdigitalFieldMapService';
+export { IntegrationDotdigitalLogService } from './services/IntegrationDotdigitalLogService';
+export { IntegrationDotDigitalSettingsService } from './services/IntegrationDotDigitalSettingsService';
+export { IntegrationQueueService } from './services/IntegrationQueueService';
 export { LeasingService } from './services/LeasingService';
 export { LocationsReportService } from './services/LocationsReportService';
 export { LoqatePlacesService } from './services/LoqatePlacesService';

package/src/models/AddressBookItem.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The AddressBook item response model.
+ */
+export type AddressBookItem = {
+  /**
+   * Gets or sets the response id.
+   */
+  id?: number;
+  /**
+   * Gets or sets the name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the visibility.
+   */
+  visibility?: string | null;
+  /**
+   * Gets or sets the contacts.
+   */
+  contacts?: number;
+};

package/src/models/AddressBooksRequest.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The OpenAI description completion message model.
+ */
+export type AddressBooksRequest = {
+  /**
+   * Gets or sets the message role.
+   */
+  apiUrl?: string | null;
+  /**
+   * Gets or sets the message role.
+   */
+  username?: string | null;
+  /**
+   * Gets or sets the message role.
+   */
+  password?: string | null;
+};

package/src/models/DotdigitalCanonicalField.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Dotdigital canonical field types.
+ */
+export enum DotdigitalCanonicalField {
+  EMAIL = 'Email',
+  FIRST_NAME = 'FirstName',
+  LAST_NAME = 'LastName',
+  FULL_NAME = 'FullName',
+  GENDER = 'Gender',
+  POSTCODE = 'Postcode',
+  MARKETING_OPT_IN = 'MarketingOptIn',
+}

package/src/models/DotdigitalSourceType.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Dotdigital source types.
+ */
+export enum DotdigitalSourceType {
+  CUSTOMER_COLUMN = 'CustomerColumn',
+  ORDER_COLUMN = 'OrderColumn',
+  CUSTOMER_CUSTOM_FIELD = 'CustomerCustomField',
+  ORDER_CUSTOM_FIELD = 'OrderCustomField',
+  STATIC = 'Static',
+}

package/src/models/IntegrationDotdigitalFieldMap.ts

@@ -0,0 +1,55 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DotdigitalCanonicalField } from './DotdigitalCanonicalField';
+import type { DotdigitalSourceType } from './DotdigitalSourceType';
+
+/**
+ * Represents a Dotdigital field mapping configuration within the Reach application.
+ */
+export type IntegrationDotdigitalFieldMap = {
+  /**
+   * 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;
+  canonicalField?: DotdigitalCanonicalField;
+  /**
+   * Gets or sets the Dotdigital field key.
+   */
+  dotdigitalFieldKey?: string | null;
+  sourceType?: DotdigitalSourceType;
+  /**
+   * Gets or sets the source key.
+   */
+  sourceKey?: string | null;
+  /**
+   * Gets or sets the static value.
+   */
+  staticValue?: string | null;
+  /**
+   * Gets or sets a value indicating whether the field is required.
+   */
+  isRequired?: boolean | null;
+};

package/src/models/IntegrationDotdigitalFieldMapPage.ts

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

package/src/models/IntegrationDotdigitalFieldMapPatch.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for Dotdigital field map updates.
+ */
+export type IntegrationDotdigitalFieldMapPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+};

package/src/models/IntegrationDotdigitalFieldMapPost.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for Dotdigital field map inserts.
+ */
+export type IntegrationDotdigitalFieldMapPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+};

package/src/models/IntegrationDotdigitalLog.ts

@@ -0,0 +1,65 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { IntegrationDotdigitalLogStatus } from './IntegrationDotdigitalLogStatus';
+
+/**
+ * Represents a Dotdigital integration log entry within the Reach application.
+ */
+export type IntegrationDotdigitalLog = {
+  /**
+   * 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 order id.
+   */
+  orderId?: string;
+  /**
+   * Gets or sets the customer id.
+   */
+  customerId?: string | null;
+  /**
+   * Gets or sets the email.
+   */
+  email?: string | null;
+  status?: IntegrationDotdigitalLogStatus;
+  /**
+   * Gets or sets the Dotdigital contact id.
+   */
+  dotdigitalContactId?: string | null;
+  /**
+   * Gets or sets the request JSON.
+   */
+  requestJson?: string | null;
+  /**
+   * Gets or sets the response JSON.
+   */
+  responseJson?: string | null;
+  /**
+   * Gets or sets the error message.
+   */
+  errorMessage?: string | null;
+};

package/src/models/IntegrationDotdigitalLogPage.ts

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

package/src/models/IntegrationDotdigitalLogPatch.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for Dotdigital integration log updates.
+ */
+export type IntegrationDotdigitalLogPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+};

package/src/models/IntegrationDotdigitalLogPost.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for Dotdigital integration log inserts.
+ */
+export type IntegrationDotdigitalLogPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+};

package/src/models/IntegrationDotdigitalLogStatus.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Integrations Dotdigital log status.
+ */
+export enum IntegrationDotdigitalLogStatus {
+  QUEUED = 'Queued',
+  SENT = 'Sent',
+  FAILED = 'Failed',
+}

package/src/models/IntegrationDotdigitalSettings.ts

@@ -0,0 +1,66 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents DotDigital integration settings within the Reach application.
+ */
+export type IntegrationDotdigitalSettings = {
+  /**
+   * 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 a value indicating whether the integration is enabled.
+   */
+  enabled?: boolean | null;
+  /**
+   * Gets or sets the API base URL.
+   */
+  apiBaseUrl?: string | null;
+  /**
+   * Gets or sets the API user.
+   */
+  apiUser?: string | null;
+  /**
+   * Gets or sets the encrypted API password.
+   */
+  apiPasswordEncrypted?: string | null;
+  /**
+   * Gets or sets the API password nonce.
+   */
+  apiPasswordNonce?: string | null;
+  /**
+   * Gets or sets the API password key version.
+   */
+  apiPasswordKeyVersion?: string | null;
+  /**
+   * Gets or sets the address book name.
+   */
+  addressBookName?: string | null;
+  /**
+   * Gets or sets the address book id.
+   */
+  addressBookId?: number | null;
+};

package/src/models/IntegrationDotdigitalSettingsCreate.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for deal inserts.
+ */
+export type IntegrationDotdigitalSettingsCreate = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets a value indicating whether the integration is enabled.
+   */
+  enabled: boolean;
+  /**
+   * Gets or sets the API base URL.
+   */
+  apiBaseUrl: string;
+  /**
+   * Gets or sets the API user.
+   */
+  apiUser: string;
+  /**
+   * Gets or sets the API password. Required on create; optional on update (existing password kept if not provided).
+   */
+  apiPassword?: string | null;
+  /**
+   * Gets or sets the address book name.
+   */
+  addressBookName: string;
+  /**
+   * Gets or sets the address book id.
+   */
+  addressBookId: number;
+};

package/src/models/IntegrationDotdigitalSettingsPage.ts

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

package/src/models/IntegrationDotdigitalSettingsPatch.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for Dotdigital integration settings updates.
+ */
+export type IntegrationDotdigitalSettingsPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+};

package/src/models/IntegrationDotdigitalSettingsPost.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for Dotdigital integration settings inserts.
+ */
+export type IntegrationDotdigitalSettingsPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+};

package/src/models/IntegrationQueue.ts

@@ -0,0 +1,57 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { IntegrationType } from './IntegrationType';
+
+/**
+ * Represents an item in the integration queue within the Reach application.
+ */
+export type IntegrationQueue = {
+  /**
+   * 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;
+  integrationType?: IntegrationType;
+  /**
+   * Gets or sets the model id (e.g. entity being synced).
+   */
+  modelId?: string;
+  /**
+   * Gets or sets a value indicating whether the item has been processed.
+   */
+  processed?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the last attempt errored.
+   */
+  errored?: boolean | null;
+  /**
+   * Gets or sets the number of processing attempts.
+   */
+  attemptCount?: number;
+  /**
+   * Gets or sets the last error message if any.
+   */
+  lastError?: string | null;
+};

package/src/models/IntegrationQueuePage.ts

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

package/src/models/IntegrationQueuePatch.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for integration queue updates.
+ */
+export type IntegrationQueuePatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+};

package/src/models/IntegrationQueuePost.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for integration queue inserts.
+ */
+export type IntegrationQueuePost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+};

package/src/models/IntegrationType.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Controls the integration type.
+ */
+export enum IntegrationType {
+  DOTDIGITAL_UPSERT_CONTACT = 'DotdigitalUpsertContact',
+}

package/src/models/OrderItemReport.ts

@@ -45,6 +45,10 @@ export type OrderItemReport = {
    * Gets or sets the activity name.
    */
   activityName?: string | null;
+  /**
+   * Gets or sets the provider name.
+   */
+  providerName?: string | null;
   /**
    * Gets or sets the venue name.
    */