Struct espocrm_rs::EspoApiClient

pub struct EspoApiClient { /* private fields */ }

Implementations

impl EspoApiClient

pub fn new(url: &str) -> EspoApiClient

Create an instance of EspoApiClient.

pub fn build(&self) -> Self

pub fn set_url<S: AsRef<str>>(&mut self, url: S) -> &mut EspoApiClient

Set the URL where EspoCRM is located.

pub fn set_username<S: AsRef<str>>(&mut self, username: S) -> &mut EspoApiClient

Set the username to use for authentication. If you use this you must also call Self::set_password() It is not recommended that you use this. Instead you should use API Key authorization or HMAC

pub fn set_password<S: AsRef<str>>(&mut self, password: S) -> &mut EspoApiClient

Set the password to use for authentication If you use this you must also call Self::set_username() It is not recommended that you use this. Instead you should use API Key authorization or HMAC authorization

pub fn set_api_key<S: AsRef<str>>(&mut self, api_key: S) -> &mut EspoApiClient

Set the API Key to use for authorization If you only provide the API key, and not the secret_key, API Key authorization will be used. If you wish to use HMAC authorization, you must also call Self::set_secret_key()

pub fn set_secret_key<S: AsRef<str>>(
    &mut self,
    secret_key: S
) -> &mut EspoApiClient

Set the Secret Key to use for HMAC authorization If you use this you must also call Self::set_api_key()

pub async fn create_allow_duplicates<T, S>(
    &self,
    action: S,
    data: T
) -> Result<Response>where
    T: Serialize + Clone + Debug,
    S: AsRef<str>,

Make a POST request to EspoCRM to create an entity. This request will skip duplicate checks, which would otherwhise result in a HTTP 409.

For information about what the data and action should be, refer to the EspoCRM API Documentation.

Errors

If the request fails

pub async fn create<T, S>(&self, action: S, data: T) -> Result<Response>where
    T: Serialize + Clone + Debug,
    S: AsRef<str>,

Make a POST request to EspoCRM to create an entity. This request will perform duplicate checks and return a HTTP 409 if one is found. If you want to avoid this use Self::create_allow_duplicates.

For information about what the data and action should be, refer to the EspoCRM API Documentation.

Errors

If the request fails

pub async fn request<T, S>(
    &self,
    method: Method,
    action: S,
    data_get: Option<Params>,
    data_post: Option<T>
) -> Result<Response>where
    T: Serialize + Clone + Debug,
    S: AsRef<str> + Debug,

Make a request to EspoCRM For more information, see the EspoCRM API Documentation

If you are making a GET request, you will still need to provide a type declaration for T. You can use the type NoGeneric for this.

• method: The HTTP method to be used. E.g GET or POST
• action: On what EspoCRM Object should the action be performed on. E.g “Contact” or “Contact/ID”. Essentially this is everything after “/api/v1/” in the URL.
• data_get: The filter to use on a GET request. Will be serialized according to PHP’s http_build_query function.
• data_post: The data to send on everything that is not a GET request. It will be serialized to JSON and send as the request body.

Trait Implementations

impl Clone for EspoApiClient

fn clone(&self) -> EspoApiClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EspoApiClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<EspoApiClient> for EspoApiClient

fn eq(&self, other: &EspoApiClient) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EspoApiClient

impl StructuralEq for EspoApiClient

impl StructuralPartialEq for EspoApiClient