Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeybeninghove/cloudswipe-wp
CloudSwipe WordPress Library
https://github.com/joeybeninghove/cloudswipe-wp
cloudswipe wordpress wordpress-php-library
Last synced: 9 days ago
JSON representation
CloudSwipe WordPress Library
- Host: GitHub
- URL: https://github.com/joeybeninghove/cloudswipe-wp
- Owner: joeybeninghove
- Created: 2017-02-07T03:34:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-07T22:12:43.000Z (almost 8 years ago)
- Last Synced: 2023-08-21T08:53:36.336Z (about 1 year ago)
- Topics: cloudswipe, wordpress, wordpress-php-library
- Language: PHP
- Size: 4.88 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CloudSwipe WordPress Library
This library can be used to interact with the [CloudSwipe API](https://cloudswipe.com).
## Requirements
* WordPress
* [JSON API WP Client](https://github.com/joeybeninghove/json-api-wp-client)
(auto-included via Composer)
## Composer
You can install it via [Composer](https://getcomposer.org). Run the following
command:
```bash
composer require cloudswipe/cloudswipe-wp
```
To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading):
```php
require_once('vendor/autoload.php');
```
## Usage
### Authentication
All API authentication is done using HTTP Authentication with the **Secret Key** available in your CloudSwipe account.
You can set the **Secret Key** for all requests like this:
```php
CloudSwipe_Wp::set_secret_key( "sk_store_12345" );
```
### Invoices
#### Create New Invoice
```php
// bare minimum invoice
$invoice = CloudSwipe_Wp_Invoice::create([
"description" => "T-Shirt",
"total" => 1995,
"currency" => "USD"
]);
// more detailed invoice
$invoice = CloudSwipe_Wp_Invoice::create([
"total" => 2705,
"currency" => "USD",
"customer" => [
"name" => "Bud Abbott",
"email" => "[email protected]"
"billing_address" => [
"name" => "Bud Abbott",
"company" => "Laugh Lines",
"line1" => "123 Anystreet",
"line2" => "Suite A",
"city" => "Anytown",
"state" => "VA",
"zip" => "12345",
"country" => "US",
"phone" => "111-222-3333"
],
"shipping_address" => [
"name" => "Lou Costello",
"company" => "Laugh Lines",
"line1" => "456 Otherstreet",
"line2" => "Suite Z",
"city" => "Othertown",
"state" => "VA",
"zip" => "12345",
"country" => "US",
"phone" => "111-222-3333"
],
"line_items" => [
"header" => ["Item", "Description", "Quantity", "Total"],
"rows" => [
["T-Shirt", "Small, Blue", 1, 1095],
["Mug", "Branded Coffee Mug", 2, 535]
]
],
"line_totals" => [
"rows" => [
["Discount" => 500],
["Tax" => 245],
["Shipping" => 795]
]
],
"metadata" => [
"some-custom-field" => "some-custom-value"
]
]
]);
```
#### Get A Single Invoice
```php
$invoice = CloudSwipe_Wp_Invoice::get_one( "in_12345" );
```
#### Get All Invoices
```php
$invoices = CloudSwipe_Wp_Invoice::get_all();
```