← All changes | app/Api/Classes/Agents.php +3 -15 2.2.0 → 2.4.5 View file →

		@@ -5,15 +5,11 @@
5	5	use FluentSupport\App\Http\Controllers\AuthController;
6	6	use FluentSupport\App\Models\Agent;
7	7
8	8	/**
9		- * Agent class for PHP API
	9	+ * Agents PHP API.
10	10	*
11	11	* Example Usage: $agentsApi = FluentSupportApi('agents');
12		- *
13		- * @package FluentSupport\App\Api\Classes
14		- *
15		- * @version 1.0.0
16	12	*/
17	13	class Agents
18	14	{
19	15	private $instance = null;
		@@ -31,9 +27,9 @@
31	27	$this->instance = $instance;
32	28	}
33	29
34	30	/**
35		- * getAgents method will return a all available customers
	31	+ * Paginated list of agents.
36	32	*
37	33	* @return object
38	34	*/
39	35
		@@ -42,10 +38,8 @@
42	38	return Agent::paginate();
43	39	}
44	40
45	41	/**
46		- * getAgent method will return a specific agent by id
47		- *
48	42	* @param int $agentId
49	43	* @return mixed
50	44	*/
51	45
		@@ -57,10 +51,8 @@
57	51	return false;
58	52	}
59	53
60	54	/**
61		- * updateAgent method will update the specific agent by id
62		- *
63	55	* @param array $data
64	56	* @param int $agentId
65	57	* @return mixed
66	58	*/
		@@ -76,12 +68,9 @@
76	68	return false;
77	69	}
78	70
79	71	/**
80		- * createAgentWithOrWithoutWpUser method will create a new agent
81		- * also it will create a wp user if you want to create one
82		- * if you want to create a wp user too then the process will be 1st it will create a wp user
83		- * after creating the wp user successfully it will create a fluent support agent
	72	+ * Create an agent, optionally creating the WP user first.
84	73	*
85	74	* @param array $data
86	75	* @param bool $createWpUser
87	76	* @return mixed
		@@ -111,9 +100,8 @@
111	100	return false;
112	101	}
113	102
114	103	/**
115		- * deleteAgent method will delete agent by id
116	104	* @param int $id
117	105	*/
118	106	public function deleteAgent($id)
119	107	{