← All changes | app/Api/Classes/Customers.php +4 -16 2.3.1 → 2.4.5 View file →

		@@ -7,15 +7,11 @@
7	7	use FluentSupport\App\Models\Ticket;
8	8	use FluentSupport\App\Services\Tickets\TicketService;
9	9
10	10	/**
11		- * Customers class for PHP API
	11	+ * Customers PHP API.
12	12	*
13	13	* Example Usage: $customersApi = FluentSupportApi('customers');
14		- *
15		- * @package FluentSupport\App\Api\Classes
16		- *
17		- * @version 1.0.0
18	14	*/
19	15	class Customers
20	16	{
21	17	private $instance = null;
		@@ -33,9 +29,9 @@
33	29	$this->instance = $instance;
34	30	}
35	31
36	32	/**
37		- * getCustomers method will return a all available customers
	33	+ * Paginated list of customers.
38	34	*
39	35	* @return object
40	36	*/
41	37
		@@ -44,10 +40,8 @@
44	40	return Customer::paginate();
45	41	}
46	42
47	43	/**
48		- * getCustomer method will return a specific customer by id
49		- *
50	44	* @param int $customerId
51	45	* @return object|boolean
52	46	*/
53	47
		@@ -59,10 +53,8 @@
59	53	return false;
60	54	}
61	55
62	56	/**
63		- * updateCustomer method will update the specific customer by id
64		- *
65	57	* @param array $data
66	58	* @param int $customer_id
67	59	* @return object|boolean
68	60	*/
		@@ -79,12 +71,9 @@
79	71	return false;
80	72	}
81	73
82	74	/**
83		- * createCustomerWithOrWithoutWpUser method will create a customer
84		- * also it will create a wp user if you want to create one
85		- * if you want to create a wp user too then the process will be 1st it will create a wp user
86		- * after creating the wp user successfully it will create a fluent support customer
	75	+ * Create a customer, optionally creating the WP user first.
87	76	*
88	77	* @param array $data
89	78	* @param bool $createWpUser
90	79	* @return object|boolean
		@@ -113,11 +102,10 @@
113	102	return false;
114	103	}
115	104
116	105	/**
117		- * deleteCustomer method will delete customer with or without customer tickets and attachments
118	106	* @param int $id
119		- * @param bool $withAssociatedData | this will delete all tickets and attachments of this customer
	107	+ * @param bool $withAssociatedData Also delete the customer's tickets and attachments.
120	108	* @return void
121	109	*/
122	110	public function deleteCustomer($id, $withAssociatedData = false)
123	111	{