Synctera 'Applications' endpoints.
Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do
not edit by hand — re-run mix generate (or python3 scripts/generate.py)
to regenerate.
Summary
Functions
Create a credit application. — Create a credit application.
Like create_application/2 but returns the value directly and raises on error.
Get Application — Get application by ID.
Like get_application/3 but returns the value directly and raises on error.
List credit applications. — List credit applications.
Like list_applications/2 but returns the value directly and raises on error.
Patch Application — Patch Application.
Like patch_application/3 but returns the value directly and raises on error.
Functions
@spec create_application( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Create a credit application. — Create a credit application.
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec create_application!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like create_application/2 but returns the value directly and raises on error.
@spec get_application(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Get Application — Get application by ID.
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec get_application!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like get_application/3 but returns the value directly and raises on error.
@spec list_applications( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List credit applications. — List credit applications.
Options
Query options: :customer_id, :status
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_applications!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like list_applications/2 but returns the value directly and raises on error.
@spec patch_application(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Patch Application — Patch Application.
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec patch_application!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like patch_application/3 but returns the value directly and raises on error.