Synctera 'Relationships' 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 relationship — Create a party relationship.
Like create_relationship/2 but returns the value directly and raises on error.
Delete relationship — Delete party relationship by ID.
Like delete_relationship/3 but returns the value directly and raises on error.
Get relationship — Get relationship by ID.
Like get_relationship/3 but returns the value directly and raises on error.
List relationships — Retrieves paginated list of relationships viewable by the authorized requester.
Like list_relationships/2 but returns the value directly and raises on error.
Update relationship — Update relationship by ID.
Like update_relationship/3 but returns the value directly and raises on error.
Functions
@spec create_relationship( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Create a relationship — Create a party relationship.
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec create_relationship!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like create_relationship/2 but returns the value directly and raises on error.
@spec delete_relationship(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Delete relationship — Delete party relationship by ID.
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec delete_relationship!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like delete_relationship/3 but returns the value directly and raises on error.
@spec get_relationship(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Get relationship — Get relationship by ID.
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec get_relationship!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like get_relationship/3 but returns the value directly and raises on error.
@spec list_relationships( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List relationships — Retrieves paginated list of relationships viewable by the authorized requester.
Options
Query options: :id, :from_person_id, :from_business_id, :to_business_id,
:relationship_type, :limit, :page_token
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_relationships!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like list_relationships/2 but returns the value directly and raises on error.
@spec update_relationship(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Update relationship — Update relationship by ID.
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec update_relationship!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like update_relationship/3 but returns the value directly and raises on error.