Struct zohohorrorshow::client::ZohoClient

pub struct ZohoClient { /* private fields */ }

ZohoClient initialises and manages the details with which we can make a connection to the Zoho API. It holds the information required which is then passed down into the various ModelRequests for use with a specific endpoint.

Implementations

impl ZohoClient

pub fn new(client_id: &str, client_secret: &str) -> Self

Generate new ZohoClient which may be used to make requests

pub fn access_token(&self) -> String

Returns the access token for this Client.

Panics

Will panic if an access token has not been set for this client. As a ZohoClient cannot be constructed other than via new and that calls the necessary API endpoint to set the access token, this is not recoverable.

pub fn set_portal(self, portal_name: &str) -> Result<Self>

Set the Portal to which this ZohoClient should make requests. This takes a Portal name; these are typically human-friendly strings and should be known by the Zoho Portal users.

pub fn set_project(self, project_name: &str) -> Result<Self>

Set the Project to which this ZohoClient should refer when making requests. All entities requested will be within this Project; if multiple Projects are to be queried this can be called a second time to re-use the client. The Project names are typically human-friendly strings and should be known by the Zoho Project users.

pub fn activities(&self) -> ActivityRequest

Construct a Request for retrieving multiple Activities. Activities cannot be requested singly, therefore there is no id-parameterised counterpart.

pub fn bug(&self, id: i64) -> BugRequest

Construct a Request for retrieving a Bug by numeric ID

pub fn bugs(&self) -> BugRequest

Construct a Request for retrieving multiple Bugs

pub fn category(&self, id: i64) -> CategoryRequest

Construct a Request for retrieving a Category by ID

pub fn categories(&self) -> CategoryRequest

Construct a Request for retrieving multiple Categories

pub fn event(&self, id: i64) -> EventRequest

Construct a Request for retrieving an Event by ID

pub fn events(&self) -> EventRequest

Construct a Request for retrieving multiple Events

pub fn forum(&self, id: i64) -> ForumRequest

Construct a Request for retrieving a Forum by ID

pub fn forums(&self) -> ForumRequest

Construct a Request for retrieving multiple Fora

pub fn forum_comment(&self, forum_id: i64, id: i64) -> CommentRequest

Construct a Request for retrieving a Comment within a Forum, referencing the ID of both the Forum and Comment

pub fn forum_comments(&self, forum_id: i64) -> CommentRequest

Construct a Request for retrieving multiple Comments within a Forum, referencing the Forum ID

pub fn milestone(&self, id: i64) -> MilestoneRequest

Construct a Request for retrieving a Milestone by ID

pub fn milestones(&self) -> MilestoneRequest

Construct a Request for retrieving multiple Milestones

pub fn portals(&self) -> PortalRequest

Construct a Request for retrieving the available Portals for this Client. Used when initializing a new Client.

pub fn portal_users(&self) -> PortalUserRequest

Construct a Request for retrieving the users with access to this Client’s Portal.

pub fn project(&self, id: i64) -> ProjectRequest

Construct a Request for retrieving a Project by ID

pub fn projects(&self) -> ProjectRequest

Construct a Request for retrieving multiple Projects

pub fn project_users(&self) -> ProjectUserRequest

Construct a Request for retrieving the Users with access to this Client’s Project

pub fn statuses(&self) -> StatusRequest

Construct a Request for retrieving multiple Statuses. There is no singular counterpart.

pub fn task(&self, id: i64) -> TaskRequest

Construct a Request for retrieving a Task by ID

pub fn tasks(&self) -> TaskRequest

Construct a Request for retrieving multiple Tasks

pub fn tasklist(&self, id: i64) -> TasklistRequest

Construct a Request for retrieving a Tasklist by ID

pub fn tasklists(&self) -> TasklistRequest

Construct a Request for retrieving multiple Tasklists

pub fn tasklist_task(&self, tasklist_id: usize, id: i64) -> TasklistTaskRequest

Construct a Request for retrieving a Task belonging to a specific Tasklist

pub fn tasklist_tasks(&self, tasklist_id: usize) -> TasklistTaskRequest

Construct a Request for retrieving Tasks belonging to a specific Tasklist

pub fn timesheet(&self, id: i64) -> TimesheetRequest

Construct a Request for retrieving a Timesheet by ID

pub fn timesheets(&self) -> TimesheetRequest

Construct a Request for retrieving multiple Timesheets

Trait Implementations

impl Clone for ZohoClient

fn clone(&self) -> ZohoClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZohoClient

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

Formats the value using the given formatter.