diff --git a/app/Http/Controllers/OpenAPI/ClientGatewayToken.php b/app/Http/Controllers/OpenAPI/ClientGatewayToken.php index a9b4dd7df9b6..2a2492fdfaf9 100644 --- a/app/Http/Controllers/OpenAPI/ClientGatewayToken.php +++ b/app/Http/Controllers/OpenAPI/ClientGatewayToken.php @@ -3,13 +3,13 @@ * @OA\Schema( * schema="ClientGatewayToken", * type="object", - * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"), - * @OA\Property(property="company_id", type="string", example="2", description="______"), - * @OA\Property(property="client_id", type="string", example="2", description="______"), - * @OA\Property(property="token", type="string", example="2", description="______"), - * @OA\Property(property="routing_number", type="string", example="2", description="______"), - * @OA\Property(property="company_gateway_id", type="string", example="2", description="______"), - * @OA\Property(property="is_default", type="boolean", example="true", description="______"), + * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the client gateway token"), + * @OA\Property(property="company_id", type="string", example="2", description="The hashed id of the company"), + * @OA\Property(property="client_id", type="string", example="2", description="The hashed_id of the client"), + * @OA\Property(property="token", type="string", example="2", description="The payment token"), + * @OA\Property(property="routing_number", type="string", example="2", description="THe bank account routing number"), + * @OA\Property(property="company_gateway_id", type="string", example="2", description="The hashed id of the company gateway"), + * @OA\Property(property="is_default", type="boolean", example="true", description="Flag determining if the token is the default payment method"), * * ) */ diff --git a/app/Http/Controllers/OpenAPI/ClientSchema.php b/app/Http/Controllers/OpenAPI/ClientSchema.php index 41cc79a9a59f..9d034b4b6643 100644 --- a/app/Http/Controllers/OpenAPI/ClientSchema.php +++ b/app/Http/Controllers/OpenAPI/ClientSchema.php @@ -3,9 +3,9 @@ * @OA\Schema( * schema="Client", * type="object", - * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="_________"), - * @OA\Property(property="user_id", type="string", example="", description="__________"), - * @OA\Property(property="company_id", type="string", example="", description="________"), + * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the client"), + * @OA\Property(property="user_id", type="string", example="", description="The hashed id of the user"), + * @OA\Property(property="company_id", type="string", example="", description="The hashed id of the company"), * @OA\Property( * property="contacts", * type="array", @@ -13,35 +13,35 @@ * ref="#/components/schemas/ClientContact", * ), * ), - * @OA\Property(property="name", type="string", example="", description="________"), - * @OA\Property(property="website", type="string", example="", description="________"), - * @OA\Property(property="private_notes", type="string", example="", description="________"), - * @OA\Property(property="client_hash", type="string", example="", description="________"), - * @OA\Property(property="industry_id", type="string", example="", description="________"), - * @OA\Property(property="size_id", type="string", example="", description="________"), - * @OA\Property(property="address1", type="string", example="", description="________"), - * @OA\Property(property="address2", type="string", example="", description="________"), - * @OA\Property(property="city", type="string", example="", description="________"), - * @OA\Property(property="state", type="string", example="", description="________"), - * @OA\Property(property="postal_code", type="string", example="", description="________"), + * @OA\Property(property="name", type="string", example="Jims housekeeping", description="The client name"), + * @OA\Property(property="website", type="string", example="www.jims.com", description="The client website"), + * @OA\Property(property="private_notes", type="string", example="These are very private notes", description="Private notes on the client"), + * @OA\Property(property="client_hash", type="string", example="asdfkjhk342hjhbfdvmnfb1", description="The client hash"), + * @OA\Property(property="industry_id", type="number", example="5", description="The industry id of the client"), + * @OA\Property(property="size_id", type="number", example="2", description="The size id of the client"), + * @OA\Property(property="address1", type="string", example="", description="Address line 1"), + * @OA\Property(property="address2", type="string", example="", description="Address line 2"), + * @OA\Property(property="city", type="string", example="Beverley Hills", description="City"), + * @OA\Property(property="state", type="string", example="Californnia", description="State/Locality"), + * @OA\Property(property="postal_code", type="string", example="90210", description="Zip / Postal code"), * @OA\Property(property="phone", type="string", example="555-3434-3434", description="The client phone number"), - * @OA\Property(property="country_id", type="number", format="integer", example="1", description="________"), - * @OA\Property(property="custom_value1", type="string", example="", description="________"), - * @OA\Property(property="custom_value2", type="string", example="", description="________"), - * @OA\Property(property="custom_value3", type="string", example="", description="________"), - * @OA\Property(property="custom_value4", type="string", example="", description="________"), - * @OA\Property(property="vat_number", type="string", example="", description="________"), - * @OA\Property(property="id_number", type="string", example="", description="________"), - * @OA\Property(property="number", type="string", example="", description="________"), - * @OA\Property(property="shipping_address1", type="string", example="", description="________"), - * @OA\Property(property="shipping_address2", type="string", example="", description="________"), - * @OA\Property(property="shipping_city", type="string", example="", description="________"), - * @OA\Property(property="shipping_state", type="string", example="", description="________"), - * @OA\Property(property="shipping_postal_code", type="string", example="", description="________"), - * @OA\Property(property="shipping_country_id", type="number", format="integer", example="", description="________"), - * @OA\Property(property="is_deleted", type="boolean", example=true, description="________"), - * @OA\Property(property="balance", type="number", format="float", example="10.00", description="________"), - * @OA\Property(property="paid_to_date", type="number", format="float", example="10.00", description="________"), + * @OA\Property(property="country_id", type="number", format="integer", example="1", description="The client country id"), + * @OA\Property(property="custom_value1", type="string", example="Something custom", description="A custom value"), + * @OA\Property(property="custom_value2", type="string", example="2002-01-01", description="A custom value"), + * @OA\Property(property="custom_value3", type="string", example="Something custom", description="A custom value"), + * @OA\Property(property="custom_value4", type="string", example="Something custom", description="A custom value"), + * @OA\Property(property="vat_number", type="string", example="VAT123", description="The client VAT number"), + * @OA\Property(property="id_number", type="string", example="CLIENT_ID_NUMBER", description=" The client id number"), + * @OA\Property(property="number", type="string", example="", description="The client number - assigned by the system typically"), + * @OA\Property(property="shipping_address1", type="string", example="5 Wallaby Way", description="The shipping address line 1"), + * @OA\Property(property="shipping_address2", type="string", example="Suite 5", description="The shipping address line 2"), + * @OA\Property(property="shipping_city", type="string", example="Perth", description="The shipping city"), + * @OA\Property(property="shipping_state", type="string", example="Western Australia", description="The shipping state"), + * @OA\Property(property="shipping_postal_code", type="string", example="6110", description="The shipping postal code"), + * @OA\Property(property="shipping_country_id", type="number", format="integer", example="4", description="The shipping country id"), + * @OA\Property(property="is_deleted", type="boolean", example=true, description="Boolean flagged determining if the client has been deleted"), + * @OA\Property(property="balance", type="number", format="float", example="10.00", description="The client balance"), + * @OA\Property(property="paid_to_date", type="number", format="float", example="10.00", description="The amount the client has paid to date."), * @OA\Property(property="credit_balance", type="number", format="float", example="10.00", description="An amount which is available to the client for future use."), * @OA\Property(property="last_login", type="number", format="integer", example="134341234234", description="Timestamp"), * @OA\Property(property="created_at", type="number", format="integer", example="134341234234", description="Timestamp"),