Class CustomerTermsService

Manage customer-wide term acceptances and term documents

Hierarchy (View Summary)

CustomerTermsQueryService
- CustomerTermsService

Index

Constructors

Properties

customerDocumentQueryService s3Bucket s3Client

Methods

get getAcceptances getStream upsert

Constructors

constructor

new CustomerTermsService(
    __namedParameters: {
        customerDocumentQueryService:
            | CustomerDocumentQueryService
            | CustomerDocumentService;
        db: B2bDatabase;
        eventPublisher: EventPublisher;
        s3Bucket: string;
        s3Client: S3Client;
        valkeyClient: ValkeyClient
        | null;
    },
): CustomerTermsService
Parameters
- __namedParameters: {
      customerDocumentQueryService:
          | CustomerDocumentQueryService
          | CustomerDocumentService;
      db: B2bDatabase;
      eventPublisher: EventPublisher;
      s3Bucket: string;
      s3Client: S3Client;
      valkeyClient: ValkeyClient
      | null;
  }
Returns CustomerTermsService
Overrides CustomerTermsQueryService.constructor
- Defined in packages/customer-services/src/CustomerTermsService.ts:179

Properties

`Protected` `Readonly`customerDocumentQueryService

customerDocumentQueryService: CustomerDocumentQueryService

`Protected` `Readonly`s3Bucket

s3Bucket: string

`Protected` `Readonly`s3Client

s3Client: S3Client

Methods

get

get(
    __namedParameters: {
        customerId: string;
        termType:
            | "MOVEUSD_TERMS_OF_USE"
            | "COOKIES_POLICY"
            | "ESIGN_POLICY"
            | "PRIVACY_POLICY";
    },
): Promise<{ ok: true; value: CustomerTermDocument | null }>
Parameters
- __namedParameters: {
      customerId: string;
      termType:
          | "MOVEUSD_TERMS_OF_USE"
          | "COOKIES_POLICY"
          | "ESIGN_POLICY"
          | "PRIVACY_POLICY";
  }
Returns Promise<{ ok: true; value: CustomerTermDocument | null }>
Inherited from CustomerTermsQueryService.get
- Defined in packages/customer-services/src/CustomerTermsService.ts:83

getAcceptances

getAcceptances(
__namedParameters: { customerId: string },
): Promise<{ ok: true; value: CustomerTermAcceptance[] }>
All term-acceptance records for the customer (defaults filled in for any not yet acted on).
Parameters
- __namedParameters: { customerId: string }
Returns Promise<{ ok: true; value: CustomerTermAcceptance[] }>
- Defined in packages/customer-services/src/CustomerTermsService.ts:271

getStream

getStream(
    __namedParameters: {
        customerId: string;
        termType:
            | "MOVEUSD_TERMS_OF_USE"
            | "COOKIES_POLICY"
            | "ESIGN_POLICY"
            | "PRIVACY_POLICY";
    },
): Promise<{ ok: true; value: CustomerTermDocumentStream | null }>
Parameters
- __namedParameters: {
      customerId: string;
      termType:
          | "MOVEUSD_TERMS_OF_USE"
          | "COOKIES_POLICY"
          | "ESIGN_POLICY"
          | "PRIVACY_POLICY";
  }
Returns Promise<{ ok: true; value: CustomerTermDocumentStream | null }>
Inherited from CustomerTermsQueryService.getStream
- Defined in packages/customer-services/src/CustomerTermsService.ts:126

upsert

upsert(
    __namedParameters: {
        customerId: string;
        terms: CustomerTermAcceptance[] | null;
    },
): Promise<{ ok: true; value: CustomerTermAcceptance[] }>
Create or update a customer term acceptance

The term acceptance in the db is replaced completely if present, i.e. if accepted terms are supplied, it overrides the persisted values.
Parameters
- __namedParameters: { customerId: string; terms: CustomerTermAcceptance[] | null }
Returns Promise<{ ok: true; value: CustomerTermAcceptance[] }>
- Defined in packages/customer-services/src/CustomerTermsService.ts:213