Synctera 'Disclosures' 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 Disclosure — Disclosures to be made to customers
Like create_disclosure1/3 but returns the value directly and raises on error.
Create disclosure record — Record the fact that a regulatory document was disclosed to a customer.
Like create_disclosure/2 but returns the value directly and raises on error.
Get disclosure — Get disclosure by ID.
Like get_disclosure/3 but returns the value directly and raises on error.
List Disclosures — Retrieves paginated list of disclosures associated with the authorized requester
Like list_disclosures1/3 but returns the value directly and raises on error.
List disclosures — Retrieves paginated list of disclosures associated with the authorized requester.
Like list_disclosures/2 but returns the value directly and raises on error.
Functions
@spec create_disclosure1(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Create a Disclosure — Disclosures to be made to customers
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec create_disclosure1!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like create_disclosure1/3 but returns the value directly and raises on error.
@spec create_disclosure( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Create disclosure record — Record the fact that a regulatory document was disclosed to a customer.
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec create_disclosure!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like create_disclosure/2 but returns the value directly and raises on error.
@spec get_disclosure(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Get disclosure — Get disclosure by ID.
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec get_disclosure!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like get_disclosure/3 but returns the value directly and raises on error.
@spec list_disclosures1(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List Disclosures — Retrieves paginated list of disclosures associated with the authorized requester
Options
Query options: :limit, :page_token
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_disclosures1!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like list_disclosures1/3 but returns the value directly and raises on error.
@spec list_disclosures( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List disclosures — Retrieves paginated list of disclosures associated with the authorized requester.
Options
Query options: :id, :person_id, :business_id, :limit, :page_token
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_disclosures!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like list_disclosures/2 but returns the value directly and raises on error.