@oystehr/sdk
Version:
Oystehr SDK
72 lines (71 loc) • 3.07 kB
TypeScript
import { OystehrClientRequest, PaymentMethodDeleteParams, PaymentMethodListParams, PaymentMethodListResponse, PaymentMethodSetDefaultParams, PaymentMethodSetUpParams, PaymentMethodSetUpResponse } from '../..';
import { SDKResource } from '../../client/client';
import { OystehrConfig } from '../../config';
export declare class PaymentMethod extends SDKResource {
#private;
constructor(config: OystehrConfig);
/**
* Enter a new credit card or other payment method for the user.
*
* Access Policy Requirements:
* Action: `Payment:Setup`
* Access Policy Resource: `Payment:PaymentMethod`
* Actions: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Coverage:*`
* Action: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Account:*`
*
* Also need to be able to read the patients' details. For example:
* Action: `FHIR:Read`
* Access Policy Resource: `FHIR:Patient`
*/
setUp(params: PaymentMethodSetUpParams, request?: OystehrClientRequest): Promise<PaymentMethodSetUpResponse>;
/**
* Set a specified payment method for the user as default.
*
* Access Policy Requirements:
* Action: `Payment:SetDefault`
* Access Policy Resource: `Payment:PaymentMethod`
* Actions: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Coverage:*`
* Action: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Account:*`
*
* Also need to be able to read the patients' details. For example:
* Action: `FHIR:Read`
* Access Policy Resource: `FHIR:Patient`
*/
setDefault(params: PaymentMethodSetDefaultParams, request?: OystehrClientRequest): Promise<void>;
/**
* Delete a specified payment method for the beneficiary.
*
* Access Policy Requirements:
* Action: `Payment:Delete`
* Access Policy Resource: `Payment:PaymentMethod`
* Actions: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Coverage:*`
* Action: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Account:*`
*
* Also need to be able to read the patients' details. For example:
* Action: `FHIR:Read`
* Access Policy Resource: `FHIR:Patient`
*/
delete(params: PaymentMethodDeleteParams, request?: OystehrClientRequest): Promise<void>;
/**
* List all payment methods for the patient.
*
* Access Policy Requirements:
* Action: `Payment:Setup`
* Access Policy Resource: `Payment:PaymentMethod`
* Actions: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Coverage:*`
* Action: `FHIR:Read,FHIR:Create,FHIR:Update`
* Access Policy Resource: `FHIR:Account:*`
*
* Also need to be able to read the patients' details. For example:
* Action: `FHIR:Read`
* Access Policy Resource: `FHIR:Patient`
*/
list(params: PaymentMethodListParams, request?: OystehrClientRequest): Promise<PaymentMethodListResponse>;
}