reach-api-sdk 1.0.210 → 1.0.211

package/src/services/IntegrationDotDigitalSettingsService.ts

@@ -0,0 +1,708 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { AddressBookItem } from '../models/AddressBookItem';
+import type { IntegrationDotdigitalSettings } from '../models/IntegrationDotdigitalSettings';
+import type { IntegrationDotdigitalSettingsCreate } from '../models/IntegrationDotdigitalSettingsCreate';
+import type { IntegrationDotdigitalSettingsPage } from '../models/IntegrationDotdigitalSettingsPage';
+import type { IntegrationDotdigitalSettingsPatch } from '../models/IntegrationDotdigitalSettingsPatch';
+import type { IntegrationDotdigitalSettingsPost } from '../models/IntegrationDotdigitalSettingsPost';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class IntegrationDotDigitalSettingsService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Creates or updates Dotdigital integration settings for the tenant.
+   * If settings do not exist, creates them; otherwise updates the existing settings.
+   * @returns IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public upsert({
+    requestBody,
+  }: {
+    /**
+     * The settings data (create model).
+     */
+    requestBody?: IntegrationDotdigitalSettingsCreate;
+  }): CancelablePromise<IntegrationDotdigitalSettings> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/integration-dotdigital/upsert',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets the tenant's address books from Dotdigital using stored settings.
+   * @returns AddressBookItem OK
+   * @throws ApiError
+   */
+  public getAddressBooks(): CancelablePromise<Array<AddressBookItem>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/integration-dotdigital/address-books',
+      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 IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public post({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: IntegrationDotdigitalSettingsPost;
+  }): CancelablePromise<IntegrationDotdigitalSettings> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/integration-dotdigital/v2-temporary-route',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public patch({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: IntegrationDotdigitalSettingsPatch;
+  }): CancelablePromise<IntegrationDotdigitalSettings> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/integration-dotdigital/v2-temporary-route',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Inserts a list of resources.
+   * @returns IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public postList({
+    requestBody,
+  }: {
+    /**
+     * The list of <typeparamref name="TObject" />.
+     */
+    requestBody?: Array<IntegrationDotdigitalSettingsPost>;
+  }): CancelablePromise<Array<IntegrationDotdigitalSettings>> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/integration-dotdigital/v2-temporary-route/list',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public patchWithReferences({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: IntegrationDotdigitalSettingsPatch;
+  }): CancelablePromise<IntegrationDotdigitalSettings> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/integration-dotdigital/v2-temporary-route/with-references',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public deleteByObject({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: IntegrationDotdigitalSettings;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/integration-dotdigital',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources.
+   * @returns IntegrationDotdigitalSettingsPage OK
+   * @throws ApiError
+   */
+  public getPage({
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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<IntegrationDotdigitalSettingsPage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/integration-dotdigital',
+      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 deleteById({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/integration-dotdigital/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets the resource by its Id.
+   * @returns IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<IntegrationDotdigitalSettings> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/integration-dotdigital/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Returns a value indicating whether the resource is deletable.
+   * @returns boolean OK
+   * @throws ApiError
+   */
+  public canDelete({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<boolean> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/integration-dotdigital/{id}/deletable',
+      path: {
+        id: id,
+      },
+      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({
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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/integration-dotdigital/exists',
+      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`,
+      },
+    });
+  }
+
+  /**
+   * Returns the number of results in the database given the provided search params.
+   * @returns number OK
+   * @throws ApiError
+   */
+  public count({
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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<number> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/integration-dotdigital/count',
+      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`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources unpaged and without references.
+   * @returns IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public getListWithoutReferences({
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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<IntegrationDotdigitalSettings>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/integration-dotdigital/without-references',
+      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`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources.
+   * @returns IntegrationDotdigitalSettings OK
+   * @throws ApiError
+   */
+  public getListIdName({
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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<IntegrationDotdigitalSettings>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/integration-dotdigital/id-name',
+      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`,
+      },
+    });
+  }
+}