charge api

Author: mostafa6765

doc/charge.md

@@ -1,144 +1,39 @@
+## Usage
 
-# Stripe charge
+Here are some common operations you can perform using the `StripeCharge` library:
 
-LaraStripeCharge has charge alias `LaraStripeCharge`.
-
-
-# Methods
-
-## setup()
-
-setup method has `secret_key,public_key,currency` .
-
-```php
-LaraStripeCharge::setup([
-    'secret_key' => '******',
-    'public_key' => '******',
-    'currency'   => 'usd'
-])
-```
-
-## card()
-
-card method parameter will be card token which come from stripe.js with request.
-
-```php
-LaraStripeCharge::card($token);
-```
-
-or direct card
-
-```php
-LaraStripeCharge::card([
-    'number' => '4242424242424242'
-    'exp_month' => '11',
-    'exp_year' => '22',
-    'cvc' => '222'
-]);
-```
-
-## amount()
-
-amount method set charge amount
-
-```php
-LaraStripeCharge::amount(121.50);
-```
-
-## metadata()
-
-metadata methods array parameter you can declare here your `product id`, `customer id` or `similiar` data.
-
-```php
-LaraStripeCharge::metadata(['product_id'=>'p-121','purchase_id' => 'pur-12321']);
-```
-
-## description()
-
-description method declare products/charge details.
-
-```php
-LaraStripeCharge::description('LaraStripeCharge Laravel Stripe payment');
-```
-
-## purchase()
-
-purchase method create charge.
+### Creating a charge
 
 ```php
-LaraStripeCharge::purchase();
-```
-
-## get()
+use Code4mk\LaraStripe\Lib\StripeCharge;
 
-get method return some data . `type object`
+$stripeCharge = new StripeCharge();
 
-```php
-LaraStripeCharge::get();
+$stripeCharge->amount(10,'usd')
+             //->chargeMethod('cus_OnESro2IB5rzv3', 'customer')
+             ->chargeMethod('tok_1O32CXAHZl11YnN0yj3', 'card_token')
+             ->metaData(['id' => '1234', 'name' => 'kamal'])
+             ->create();
 ```
 
-## getAll()
-
-get method return all datas. `type object`
+### Retrieving a Charge
 
 ```php
-LaraStripeCharge::getAll();
-```
+use Code4mk\LaraStripe\Lib\StripeCharge;
 
-# Full code
+$stripeCharge = new StripeCharge();
 
-```php
-$charge = LaraStripeCharge::setup([
-    'secret_key' => '******',
-    'public_key' => '******',
-    'currency'   => 'usd'
-])
-->card($token)
-->amount(121.50)
-->metaData(['product_id'=>'p-121','purchase_id' => 'pur-12321'])
-->description('LaraStripeCharge Laravel Stripe payment')
-->purchase()
-->get()
-// or
-// ->getAll()
-# access response
-// $charge->metadata->product_id
-```
-
-* response
+$id = 'charge_id_here';
 
-```json
-{
-    "charge_id": "ch_1FWHbuAHZl11YnL9fU2BALTS",
-    "amount": 121.50,
-    "currency": "usd",
-    "balance_transaction": "txn_1FVAcYAHZl11YnL9Ld0Fq3lp",
-    "description": "LaraStripeCharge Laravel Stripe payment",
-    "paid": true,
-    "status": "succeeded",
-    "metadata": {
-        "product_id": "p-121",
-        "purchase_id": "pur-12321"
-    },
-    "created": 1571463416
-}
+$stripeCharge->retrieve($id);
 ```
 
-* access response
+### Listing Charge
 
 ```php
-# php file
-$charge->metadata->product_id
-```
+use Code4mk\LaraStripe\Lib\StripeCharge;
 
-# refund
+$stripeCharge = new StripeCharge();
 
-* store charge id  when charge complete.
-
-```php 
-$refund = LaraStripeCharge::setup([
-                    'secret_key'=>'sk_test_mBGoFuccDy2KCD4pobbaixKK00qUW0ghu1',
-                  ])
-                  ->refund('charge id');
-return response()->json($refund);
-```
+$stripeCharge->lists();
+```

doc/coupon.md

@@ -63,12 +63,4 @@ if ($result->isError === true) {
     echo "Error: " . $result->message;
     echo "Stripe Error: " . $result->stripe['message'];
 }
-```
-
-## License
-
-This library is open-source software licensed under the MIT License. You can find the full license text in the [LICENSE](LICENSE) file.
-
-## Author
-
-This library was created by [Your Name] and is maintained by [Your Organization]. Feel free to contribute by submitting issues or pull requests on the [GitHub repository](https://github.com/your-repo-link).
+```