reach-api-sdk 1.0.228 → 1.0.230

package/src/services/CustomerAccountInviteSchedulesService.ts

@@ -0,0 +1,859 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CustomerAccountInviteSchedule } from '../models/CustomerAccountInviteSchedule';
+import type { CustomerAccountInviteSchedulePage } from '../models/CustomerAccountInviteSchedulePage';
+import type { CustomerAccountInviteSchedulePatch } from '../models/CustomerAccountInviteSchedulePatch';
+import type { CustomerAccountInviteSchedulePost } from '../models/CustomerAccountInviteSchedulePost';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class CustomerAccountInviteSchedulesService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Sends due customer account invite emails.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public sendDueInvites(): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/customer-account-invite-schedules/send-batch',
+      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 CustomerAccountInviteSchedule OK
+   * @throws ApiError
+   */
+  public post({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: CustomerAccountInviteSchedulePost;
+  }): CancelablePromise<CustomerAccountInviteSchedule> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/customer-account-invite-schedules/v2-temporary-route',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns CustomerAccountInviteSchedule OK
+   * @throws ApiError
+   */
+  public patch({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: CustomerAccountInviteSchedulePatch;
+  }): CancelablePromise<CustomerAccountInviteSchedule> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/customer-account-invite-schedules/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 CustomerAccountInviteSchedule OK
+   * @throws ApiError
+   */
+  public postList({
+    requestBody,
+  }: {
+    /**
+     * The list of <typeparamref name="TObject" />.
+     */
+    requestBody?: Array<CustomerAccountInviteSchedulePost>;
+  }): CancelablePromise<Array<CustomerAccountInviteSchedule>> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/customer-account-invite-schedules/v2-temporary-route/list',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns CustomerAccountInviteSchedule OK
+   * @throws ApiError
+   */
+  public patchWithReferences({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: CustomerAccountInviteSchedulePatch;
+  }): CancelablePromise<CustomerAccountInviteSchedule> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/customer-account-invite-schedules/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?: CustomerAccountInviteSchedule;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/customer-account-invite-schedules',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources.
+   * @returns CustomerAccountInviteSchedulePage OK
+   * @throws ApiError
+   */
+  public getPage({
+    customerId,
+    walletCreditPeriodId,
+    dateScheduledGte,
+    dateScheduledLte,
+    sent,
+    errored,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable customer id.
+     */
+    customerId?: string;
+    /**
+     * Gets or sets the queryable wallet credit period id.
+     */
+    walletCreditPeriodId?: string;
+    /**
+     * Gets or sets the queryable date scheduled greater than or equal to.
+     */
+    dateScheduledGte?: string;
+    /**
+     * Gets or sets the queryable date scheduled less than or equal to.
+     */
+    dateScheduledLte?: string;
+    /**
+     * Gets or sets the queryable sent flag.
+     */
+    sent?: boolean;
+    /**
+     * Gets or sets the queryable errored flag.
+     */
+    errored?: 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<CustomerAccountInviteSchedulePage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/customer-account-invite-schedules',
+      query: {
+        CustomerId: customerId,
+        WalletCreditPeriodId: walletCreditPeriodId,
+        DateScheduledGTE: dateScheduledGte,
+        DateScheduledLTE: dateScheduledLte,
+        Sent: sent,
+        Errored: errored,
+        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/customer-account-invite-schedules/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets the resource by its Id.
+   * @returns CustomerAccountInviteSchedule OK
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<CustomerAccountInviteSchedule> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/customer-account-invite-schedules/{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/customer-account-invite-schedules/{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({
+    customerId,
+    walletCreditPeriodId,
+    dateScheduledGte,
+    dateScheduledLte,
+    sent,
+    errored,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable customer id.
+     */
+    customerId?: string;
+    /**
+     * Gets or sets the queryable wallet credit period id.
+     */
+    walletCreditPeriodId?: string;
+    /**
+     * Gets or sets the queryable date scheduled greater than or equal to.
+     */
+    dateScheduledGte?: string;
+    /**
+     * Gets or sets the queryable date scheduled less than or equal to.
+     */
+    dateScheduledLte?: string;
+    /**
+     * Gets or sets the queryable sent flag.
+     */
+    sent?: boolean;
+    /**
+     * Gets or sets the queryable errored flag.
+     */
+    errored?: 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/customer-account-invite-schedules/exists',
+      query: {
+        CustomerId: customerId,
+        WalletCreditPeriodId: walletCreditPeriodId,
+        DateScheduledGTE: dateScheduledGte,
+        DateScheduledLTE: dateScheduledLte,
+        Sent: sent,
+        Errored: errored,
+        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({
+    customerId,
+    walletCreditPeriodId,
+    dateScheduledGte,
+    dateScheduledLte,
+    sent,
+    errored,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable customer id.
+     */
+    customerId?: string;
+    /**
+     * Gets or sets the queryable wallet credit period id.
+     */
+    walletCreditPeriodId?: string;
+    /**
+     * Gets or sets the queryable date scheduled greater than or equal to.
+     */
+    dateScheduledGte?: string;
+    /**
+     * Gets or sets the queryable date scheduled less than or equal to.
+     */
+    dateScheduledLte?: string;
+    /**
+     * Gets or sets the queryable sent flag.
+     */
+    sent?: boolean;
+    /**
+     * Gets or sets the queryable errored flag.
+     */
+    errored?: 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<number> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/customer-account-invite-schedules/count',
+      query: {
+        CustomerId: customerId,
+        WalletCreditPeriodId: walletCreditPeriodId,
+        DateScheduledGTE: dateScheduledGte,
+        DateScheduledLTE: dateScheduledLte,
+        Sent: sent,
+        Errored: errored,
+        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 CustomerAccountInviteSchedule OK
+   * @throws ApiError
+   */
+  public getListWithoutReferences({
+    customerId,
+    walletCreditPeriodId,
+    dateScheduledGte,
+    dateScheduledLte,
+    sent,
+    errored,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable customer id.
+     */
+    customerId?: string;
+    /**
+     * Gets or sets the queryable wallet credit period id.
+     */
+    walletCreditPeriodId?: string;
+    /**
+     * Gets or sets the queryable date scheduled greater than or equal to.
+     */
+    dateScheduledGte?: string;
+    /**
+     * Gets or sets the queryable date scheduled less than or equal to.
+     */
+    dateScheduledLte?: string;
+    /**
+     * Gets or sets the queryable sent flag.
+     */
+    sent?: boolean;
+    /**
+     * Gets or sets the queryable errored flag.
+     */
+    errored?: 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<Array<CustomerAccountInviteSchedule>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/customer-account-invite-schedules/without-references',
+      query: {
+        CustomerId: customerId,
+        WalletCreditPeriodId: walletCreditPeriodId,
+        DateScheduledGTE: dateScheduledGte,
+        DateScheduledLTE: dateScheduledLte,
+        Sent: sent,
+        Errored: errored,
+        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 CustomerAccountInviteSchedule OK
+   * @throws ApiError
+   */
+  public getListIdName({
+    customerId,
+    walletCreditPeriodId,
+    dateScheduledGte,
+    dateScheduledLte,
+    sent,
+    errored,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable customer id.
+     */
+    customerId?: string;
+    /**
+     * Gets or sets the queryable wallet credit period id.
+     */
+    walletCreditPeriodId?: string;
+    /**
+     * Gets or sets the queryable date scheduled greater than or equal to.
+     */
+    dateScheduledGte?: string;
+    /**
+     * Gets or sets the queryable date scheduled less than or equal to.
+     */
+    dateScheduledLte?: string;
+    /**
+     * Gets or sets the queryable sent flag.
+     */
+    sent?: boolean;
+    /**
+     * Gets or sets the queryable errored flag.
+     */
+    errored?: 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<Array<CustomerAccountInviteSchedule>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/customer-account-invite-schedules/id-name',
+      query: {
+        CustomerId: customerId,
+        WalletCreditPeriodId: walletCreditPeriodId,
+        DateScheduledGTE: dateScheduledGte,
+        DateScheduledLTE: dateScheduledLte,
+        Sent: sent,
+        Errored: errored,
+        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`,
+      },
+    });
+  }
+}