@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/customer-services
CustomerDocumentQueryService
Class CustomerDocumentQueryService
Query customer documents stored in S3
Hierarchy (
View Summary
)
CustomerDocumentQueryService
CustomerDocumentService
Index
Constructors
constructor
Properties
customer
Service
s3
Bucket
s3
Client
Methods
get
get
Download
Url
get
Stream
search
Constructors
constructor
new
CustomerDocumentQueryService
(
__namedParameters
:
{
customerService
:
CustomerService
;
s3Bucket
:
string
;
s3Client
:
S3Client
;
}
,
)
:
CustomerDocumentQueryService
Parameters
__namedParameters
:
{
customerService
:
CustomerService
;
s3Bucket
:
string
;
s3Client
:
S3Client
}
Returns
CustomerDocumentQueryService
Properties
Protected
Readonly
customer
Service
customerService
:
CustomerService
Protected
Readonly
s3
Bucket
s3Bucket
:
string
Protected
Readonly
s3
Client
s3Client
:
S3Client
Methods
get
get
(
__namedParameters
:
{
customerId
:
string
;
fileName
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
;
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
CustomerDocument
|
null
}
>
Parameters
__namedParameters
:
{
customerId
:
string
;
fileName
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
;
}
Returns
Promise
<
{
ok
:
true
;
value
:
CustomerDocument
|
null
}
>
get
Download
Url
getDownloadUrl
(
__namedParameters
:
{
customerId
:
string
;
fileName
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
;
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
string
|
null
}
>
Parameters
__namedParameters
:
{
customerId
:
string
;
fileName
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
;
}
Returns
Promise
<
{
ok
:
true
;
value
:
string
|
null
}
>
get
Stream
getStream
(
__namedParameters
:
{
customerId
:
string
;
fileName
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
;
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
CustomerDocumentStream
|
null
}
>
Parameters
__namedParameters
:
{
customerId
:
string
;
fileName
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
;
}
Returns
Promise
<
{
ok
:
true
;
value
:
CustomerDocumentStream
|
null
}
>
search
search
(
__namedParameters
:
{
customerId
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
;
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
CustomerDocument
[]
}
>
Parameters
__namedParameters
:
{
customerId
:
string
;
type
:
"CUSTOM"
|
"LOGO"
|
"PRICING_SCHEDULE"
|
"TERMS"
}
Returns
Promise
<
{
ok
:
true
;
value
:
CustomerDocument
[]
}
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
customer
Service
s3
Bucket
s3
Client
Methods
get
get
Download
Url
get
Stream
search
@cfxlabsinc/b2b-services
Loading...
Query customer documents stored in S3