Struct espocrm_rs::EspoApiClient [−][src]
pub struct EspoApiClient { /* fields omitted */ }
Implementations
impl EspoApiClient
[src]
impl EspoApiClient
[src]pub fn new(url: &str) -> EspoApiClient
[src]
pub fn new(url: &str) -> EspoApiClient
[src]Create an instance of EspoApiClient.
pub fn build(&self) -> Self
[src]
pub fn set_url<'a>(&'a mut self, url: &'a str) -> &'a mut EspoApiClient
[src]
pub fn set_url<'a>(&'a mut self, url: &'a str) -> &'a mut EspoApiClient
[src]Set the URL where EspoCRM is located.
pub fn set_username<'a>(
&'a mut self,
username: &'a str
) -> &'a mut EspoApiClient
[src]
pub fn set_username<'a>(
&'a mut self,
username: &'a str
) -> &'a mut EspoApiClient
[src]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<'a>(
&'a mut self,
password: &'a str
) -> &'a mut EspoApiClient
[src]
pub fn set_password<'a>(
&'a mut self,
password: &'a str
) -> &'a mut EspoApiClient
[src]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<'a>(&'a mut self, api_key: &'a str) -> &'a mut EspoApiClient
[src]
pub fn set_api_key<'a>(&'a mut self, api_key: &'a str) -> &'a mut EspoApiClient
[src]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<'a>(
&'a mut self,
secret_key: &'a str
) -> &'a mut EspoApiClient
[src]
pub fn set_secret_key<'a>(
&'a mut self,
secret_key: &'a str
) -> &'a mut EspoApiClient
[src]Set the Secret Key to use for HMAC authorization
If you use this you must also call Self::set_api_key()
pub async fn request<T: Serialize + Clone>(
&self,
method: Method,
action: String,
data_get: Option<Params>,
data_post: Option<T>
) -> Result<Response>
[src]
pub async fn request<T: Serialize + Clone>(
&self,
method: Method,
action: String,
data_get: Option<Params>,
data_post: Option<T>
) -> Result<Response>
[src]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
[src]
impl Clone for EspoApiClient
[src]fn clone(&self) -> EspoApiClient
[src]
fn clone(&self) -> EspoApiClient
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for EspoApiClient
[src]
impl Debug for EspoApiClient
[src]impl PartialEq<EspoApiClient> for EspoApiClient
[src]
impl PartialEq<EspoApiClient> for EspoApiClient
[src]fn eq(&self, other: &EspoApiClient) -> bool
[src]
fn eq(&self, other: &EspoApiClient) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &EspoApiClient) -> bool
[src]
fn ne(&self, other: &EspoApiClient) -> bool
[src]This method tests for !=
.
impl Eq for EspoApiClient
[src]
impl StructuralEq for EspoApiClient
[src]
impl StructuralPartialEq for EspoApiClient
[src]
Auto Trait Implementations
impl RefUnwindSafe for EspoApiClient
impl Send for EspoApiClient
impl Sync for EspoApiClient
impl Unpin for EspoApiClient
impl UnwindSafe for EspoApiClient
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more