@acceleratxr/core_sdk / PaymentService
Class: PaymentService#
Hierarchy#
-
↳ PaymentService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new PaymentService(apiClient: ApiClient, config: Configuration): PaymentService
Overrides ServiceBase.constructor
Defined in src/services/PaymentService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: PaymentService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “f7a51679-5685-41a4-962e-d73afdbd223c”
Defined in src/services/PaymentService.ts:16
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/PaymentService.ts:45
Returns the count of payments
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Payment): Promise<Payment | undefined>
Defined in src/services/PaymentService.ts:33
Create a new payment
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Payment | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/PaymentService.ts:90
Delete an existing payment
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Payment[] | undefined>
Defined in src/services/PaymentService.ts:21
Returns all payments from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Payment[] | undefined>
findById#
▸ findById(id: string): Promise<Payment | undefined>
Defined in src/services/PaymentService.ts:64
Returns a single payment from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Payment | undefined>
update#
▸ update(id: string, obj: Payment): Promise<Payment | undefined>
Defined in src/services/PaymentService.ts:77
Updates a single payment
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Payment | undefined>