The cl-paymill Reference Manual

This is the cl-paymill Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:31:48 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-paymill

CL-PAYMILL is a common lisp interface to the Paymill payment service API. See https://www.paymill.com/

Author

Peter Wood, email: pete_wood at runbox.com

License

BSD, 2 clause.

Version

0.0.1

Dependencies
  • drakma (system).
  • st-json (system).
  • cl+ssl (system).
Source

cl-paymill.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-paymill/cl-paymill.asd

Source

cl-paymill.asd.

Parent Component

cl-paymill (system).

ASDF Systems

cl-paymill.


3.1.2 cl-paymill/package.lisp

Source

cl-paymill.asd.

Parent Component

cl-paymill (system).

Packages

paymill.


3.1.3 cl-paymill/build.lisp

Dependency

package.lisp (file).

Source

cl-paymill.asd.

Parent Component

cl-paymill (system).

Public Interface
Internals

3.1.4 cl-paymill/paymill.lisp

Dependency

build.lisp (file).

Source

cl-paymill.asd.

Parent Component

cl-paymill (system).

Public Interface

initialize-paymill (macro).


4 Packages

Packages are listed by definition order.


4.1 paymill

Source

package.lisp.

Nickname

pml

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Macros

Macro: initialize-paymill (key)

Until you call this macro, the access functions are not defined. You should call it with a key designating your private test- or live- key. If you use a live key, you get charged by Paymill.

Package

paymill.

Source

paymill.lisp.


5.1.2 Ordinary functions

Function: signal-paymill-error (status reply)
Package

paymill.

Source

build.lisp.


5.1.3 Conditions

Condition: paymill-bad-request
Package

paymill.

Source

build.lisp.

Direct superclasses

paymill-error.

Condition: paymill-error
Package

paymill.

Source

build.lisp.

Direct superclasses

simple-error.

Direct subclasses
Direct methods
Direct slots
Slot: reply
Initargs

:reply

Readers

reply.

Writers

This slot is read-only.

Slot: status
Initargs

:status

Readers

status.

Writers

This slot is read-only.

Condition: paymill-general-error
Package

paymill.

Source

build.lisp.

Direct superclasses

paymill-error.

Condition: paymill-not-found
Package

paymill.

Source

build.lisp.

Direct superclasses

paymill-error.

Condition: paymill-precondition-failed
Package

paymill.

Source

build.lisp.

Direct superclasses

paymill-error.

Condition: paymill-server-error
Package

paymill.

Source

build.lisp.

Direct superclasses

paymill-error.

Condition: paymill-transaction-error
Package

paymill.

Source

build.lisp.

Direct superclasses

paymill-error.

Condition: paymill-unauthorized
Package

paymill.

Source

build.lisp.

Direct superclasses

paymill-error.


5.2 Internals


5.2.1 Special variables

Special Variable: *cookie-jar*
Package

paymill.

Source

build.lisp.

Special Variable: *paymill-host*
Package

paymill.

Source

build.lisp.

Special Variable: *pm-reply*
Package

paymill.

Source

build.lisp.


5.2.2 Macros

Macro: define-resource-access (resource instr-list key)

This macro defines a uniform way of defining access to Paymill API resources. See README for usage.

Package

paymill.

Source

build.lisp.

Macro: with-pm-request (request-form &body body)

Does error checking of the reply from Paymill resulting from REQUEST-FORM. If there are no errors, it binds (per-thread, locally) the variable *PM-REPLY* to the data associated with Paymill’s reply for use in BODY, otherwise it signals ’an appropriate error’.

Package

paymill.

Source

build.lisp.


5.2.3 Ordinary functions

Function: clear-cookie-jar ()
Package

paymill.

Source

build.lisp.

Function: in-pairs (lst)
Package

paymill.

Source

build.lisp.

Function: normalize-interval (interval)
Package

paymill.

Source

build.lisp.

Function: normalize-slot (sl)
Package

paymill.

Source

build.lisp.

Function: pm-quri (resource query)

Like PM-URI, but for designating QUERY (string) parameters when RESOURCE is the target.

Package

paymill.

Source

build.lisp.

Function: pm-uri (resource &optional target)

RESOURCE is a keyword specifying a paymill api interface. TARGET is an optional generalized boolean (must be a string if it is given) which is used to determine if path should end in /TARGET.

Package

paymill.

Source

build.lisp.

Function: resource-from-keyword (keyword)
Package

paymill.

Source

build.lisp.

Function: slots (slotspecs)
Package

paymill.

Source

build.lisp.

Function: webhook-slots (slotspecs)
Package

paymill.

Source

build.lisp.

Function: x-www-form-encode-pairs (slotsp data)
Package

paymill.

Source

build.lisp.


5.2.4 Generic functions

Generic Reader: reply (condition)
Package

paymill.

Methods
Reader Method: reply ((condition paymill-error))
Source

build.lisp.

Target Slot

reply.

Generic Reader: status (condition)
Package

paymill.

Methods
Reader Method: status ((condition paymill-error))
Source

build.lisp.

Target Slot

status.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   G   I   M   N   P   R   S   W   X  
Index Entry  Section

C
clear-cookie-jar: Private ordinary functions

D
define-resource-access: Private macros

F
Function, clear-cookie-jar: Private ordinary functions
Function, in-pairs: Private ordinary functions
Function, normalize-interval: Private ordinary functions
Function, normalize-slot: Private ordinary functions
Function, pm-quri: Private ordinary functions
Function, pm-uri: Private ordinary functions
Function, resource-from-keyword: Private ordinary functions
Function, signal-paymill-error: Public ordinary functions
Function, slots: Private ordinary functions
Function, webhook-slots: Private ordinary functions
Function, x-www-form-encode-pairs: Private ordinary functions

G
Generic Function, reply: Private generic functions
Generic Function, status: Private generic functions

I
in-pairs: Private ordinary functions
initialize-paymill: Public macros

M
Macro, define-resource-access: Private macros
Macro, initialize-paymill: Public macros
Macro, with-pm-request: Private macros
Method, reply: Private generic functions
Method, status: Private generic functions

N
normalize-interval: Private ordinary functions
normalize-slot: Private ordinary functions

P
pm-quri: Private ordinary functions
pm-uri: Private ordinary functions

R
reply: Private generic functions
reply: Private generic functions
resource-from-keyword: Private ordinary functions

S
signal-paymill-error: Public ordinary functions
slots: Private ordinary functions
status: Private generic functions
status: Private generic functions

W
webhook-slots: Private ordinary functions
with-pm-request: Private macros

X
x-www-form-encode-pairs: Private ordinary functions