Skip to main content

SyncEntityMappingsResource

Struct SyncEntityMappingsResource 

Source
pub struct SyncEntityMappingsResource<'a> { /* private fields */ }
Expand description

client.sync().entity_mappings()

Implementations§

Source§

impl<'a> SyncEntityMappingsResource<'a>

Source

pub fn create( &self, body: &SyncEntityMappingCreate, ) -> Result<SyncEntityMapping>

Create an entity mapping

POST /sync/entitymappings

Registers a relationship without creating either underlying record. Provided ChurchTools or external IDs must not be linked for the same domain and source. Requires “churchcore: administer persons” permission.

§Example
let body = models::SyncEntityMappingCreate {
    domain_id: Some("42".into()),
    domain_type: "status".into(),
    source_entity_id: Some("p-42".into()),
    source_id: 1,
    status: "synced".into(),
    ..Default::default()
};
let result = client.sync().entity_mappings().create(&body)?;
println!("{}", result.id);
Source

pub fn delete(&self, id: impl Display) -> Result<()>

Delete an entity mapping

DELETE /sync/entitymappings/{id}

Removes only the stored relationship; neither the ChurchTools record nor the external record is deleted. A missing mapping also returns 204. Requires “churchcore: administer persons” permission.

§Example
client.sync().entity_mappings().delete(1)?;
Source

pub fn get(&self, id: impl Display) -> Result<SyncEntityMapping>

Get an entity mapping

GET /sync/entitymappings/{id}

Returns a stored relationship. Requires “churchcore: administer persons” permission.

§Example
let entity_mapping = client.sync().entity_mappings().get(1)?;
println!("{}", entity_mapping.id);
Source

pub fn list(&self) -> Result<Vec<SyncEntityMapping>>

List entity mappings

GET /sync/entitymappings

Lists relationships between ChurchTools records and external records, newest mapping ID first. domainId and sourceEntityId are record identifiers; sourceId identifies the external connection. Requires “churchcore: administer persons” permission.

Use Self::list_with to pass query parameters.

§Example
for entity_mapping in client.sync().entity_mappings().list()? {
    println!("{}", entity_mapping.id);
}
Source

pub fn list_with( &self, query: &GetSyncEntitymappingsQuery, ) -> Result<Vec<SyncEntityMapping>>

List entity mappings

Like Self::list, with query parameters.

GET /sync/entitymappings

Lists relationships between ChurchTools records and external records, newest mapping ID first. domainId and sourceEntityId are record identifiers; sourceId identifies the external connection. Requires “churchcore: administer persons” permission.

Source

pub fn list_iter( &self, query: &GetSyncEntitymappingsQuery, ) -> Items<SyncEntityMapping> ⓘ

List entity mappings

Like Self::list_with, but lazy: each page is fetched only when the iteration reaches it. Breaking off early saves the remaining requests.

Source

pub fn update( &self, id: impl Display, body: &SyncEntityMappingUpdate, ) -> Result<SyncEntityMapping>

Update or create an entity mapping

PUT /sync/entitymappings/{id}

Updates the relationship. Requires “churchcore: administer persons” permission.

§Example
let body = models::SyncEntityMappingUpdate {
    domain_id: Some("42".into()),
    domain_type: "status".into(),
    source_entity_id: Some("p-42".into()),
    source_id: 1,
    status: "synced".into(),
    ..Default::default()
};
let result = client.sync().entity_mappings().update(1, &body)?;
println!("{}", result.id);

Trait Implementations§

Source§

impl<'a> Clone for SyncEntityMappingsResource<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SyncEntityMappingsResource<'a>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more