Class ProofOfDelivery

Hierarchy

Base
- ProofOfDelivery

Index

Constructors

constructor

Methods

createProofOfDelivery deleteProofOfDelivery fetchProofOfDeliveryById listProofOfDelivery patchProofOfDelivery request

Constructors

constructor

new ProofOfDelivery(config): ProofOfDelivery
Constructor function for the Config class.
Parameters
- config: Config
  
  The configuration options for the class.
Returns ProofOfDelivery
Inherited from Base.constructor
- Defined in base.ts:22

Methods

createProofOfDelivery

createProofOfDelivery(pofs): Promise<ProofOfDeliveryCreateResponse>
Creates a proof of delivery.
Parameters
- pofs: ProofOfDeliveryCreateParams
  
  The parameters for creating the proof of delivery.
Returns Promise<ProofOfDeliveryCreateResponse>
- A promise that resolves with the response of the proof of delivery creation.
- Defined in resources/proof-of-delivery.ts:43

deleteProofOfDelivery

deleteProofOfDelivery(id): Promise<ProofOfDeliveryDeleteResponse>
Deletes a proof of delivery by its ID.
Parameters
- id: string
  
  The ID of the proof of delivery to delete.
Returns Promise<ProofOfDeliveryDeleteResponse>
A Promise that resolves to the delete response.
- Defined in resources/proof-of-delivery.ts:69

fetchProofOfDeliveryById

fetchProofOfDeliveryById(id): Promise<ProofOfDeliveryListResponse>
Fetches an ACH transaction by its ID.
Parameters
- id: string
  
  The ID of the proof of delivery to fetch. Starts with pofs-.
Returns Promise<ProofOfDeliveryListResponse>
- A promise that resolves to proof of delivery fetched by id.
- Defined in resources/proof-of-delivery.ts:33

listProofOfDelivery

listProofOfDelivery(queryParams?): Promise<ProofOfDeliveryListResponse>
Retrieves a list of proof of delivery transactions.
Parameters
- Optional queryParams: ProofOfDeliveryQueryParams
  
  The query parameters for the proof of delivery request.
Returns Promise<ProofOfDeliveryListResponse>
A promise that resolves to the response containing a list of proof of delivery transactions.
- Defined in resources/proof-of-delivery.ts:23

patchProofOfDelivery

patchProofOfDelivery(pofs): Promise<ProofOfDeliveryUpdateResponse>
Update a proof of delivery.
Parameters
- pofs: ProofOfDeliveryUpdateParams
  
  The proof of delivery update parameters.
Returns Promise<ProofOfDeliveryUpdateResponse>
- A promise that resolves with the proof of delivery update response.
- Defined in resources/proof-of-delivery.ts:56

`Protected` request

request<T>(endpoint, queryParams?, options?): Promise<T>
Sends a request to the specified endpoint with optional query parameters and options.
Type Parameters
- T
Parameters
- endpoint: string
  
  The endpoint to send the request to.
- Optional queryParams: Record<string, any>
  
  Optional query parameters for the request.
- Optional options: RequestInit
  
  Optional additional options for the request.
Returns Promise<T>
A promise that resolves to the response data.
Inherited from Base.request
- Defined in base.ts:37

Class ProofOfDelivery

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: Config

Returns ProofOfDelivery

Methods

createProofOfDelivery

Parameters

pofs: ProofOfDeliveryCreateParams

Returns Promise<ProofOfDeliveryCreateResponse>

deleteProofOfDelivery

Parameters

id: string

Returns Promise<ProofOfDeliveryDeleteResponse>

fetchProofOfDeliveryById

Parameters

id: string

Returns Promise<ProofOfDeliveryListResponse>

listProofOfDelivery

Parameters

Optional queryParams: ProofOfDeliveryQueryParams

Returns Promise<ProofOfDeliveryListResponse>

patchProofOfDelivery

Parameters

pofs: ProofOfDeliveryUpdateParams

Returns Promise<ProofOfDeliveryUpdateResponse>

Protected request

Type Parameters

T

Parameters

endpoint: string

Optional queryParams: Record<string, any>

Optional options: RequestInit

Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

`Optional` queryParams: ProofOfDeliveryQueryParams

`Protected` request

`Optional` queryParams: Record<string, any>

`Optional` options: RequestInit