@cfxlabsinc/b2b-services
    Preparing search index...

    Class CustomerService

    Customer service is special: While it can interact with multiple customers like an admin service, when used in a non-admin context, it should only be used to interact with the current customer.

    Index

    Constructors

    constructor

    Methods

    create get getActive getIdFromLegacyId getLegacyId search update

    Constructors

    Methods

    • Parameters

      • legacyId: number
      • refresh: boolean = false

      Returns Promise<string>

      Customer ID for the legacy numerical one

      Only use this method when legacy code is interacting with new code. This method will be removed later.

    • Parameters

      • id: string
      • refresh: boolean = false

      Returns Promise<number>

      numerical ID for the Customer

      Only use this method when interacting with legacy code from new code. This method will be removed later.

    • Parameters

      • __namedParameters: {
            ids?: string[];
            name?: string;
            nameLike?: string;
            propelauthWorkspaceIds?: string[];
        }

      Returns Promise<Customer[]>

    • Parameters

      • __namedParameters: Partial<
            Pick<Customer, "name" | "description" | "organizationId"> & {
                aipriseIdentityPersonProfileAmlTemplateId: string;
                aipriseIdentityPersonProfileIdentityDocumentTemplateId: string;
                aipriseOrganizationBusinessProfileTemplateId: string;
                aiprisePaymentInstrumentBusinessProfileTemplateId: string;
                aiprisePaymentInstrumentPersonProfileTemplateId: string;
                victorAchCompanyId: string;
                victorAchCompanyName: string;
                victorFboAccountNumber: string;
                victorLedgerProgramId: string;
            },
        > & ({ id: string } | { propelauthWorkspaceId: string })

      Returns Promise<Customer>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods