Skip to content

Commit

Permalink
Remove available methods section from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeaag authored and cjroebuck committed Sep 25, 2023
1 parent deb37e1 commit fbc372e
Showing 1 changed file with 0 additions and 38 deletions.
38 changes: 0 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,46 +125,8 @@ You can find the full list of available options within the [docs](https://urlbox
| `use_s3` | false | Save the screenshot directly to the S3 bucket configured on your account |
| `webhook_url` | - | Urlbox will send a POST request back to the supplied URL with data about the screenshot in JSON format once it has completed rendering. |

## Available Methods

#### `__construct( string $api_key, string $api_secret, ?string $webhook_secret = null, ?\GuzzleHttp\Client $client = null )`
Returns `\Urlbox\Screenshots\Urlbox`

Throws `\InvalidArgumentException`

Example: `$urlbox = new \Urlbox\Screenshots\Urlbox('key', 'secret', 'webhook', new \GuzzleHttp\Client());`

---

### __construct

```php
public function __construct( string $api_key, string $api_secret, ?string $webhook_secret = null, ?\GuzzleHttp\Client $client = null ): \Urlbox\Screenshots\Urlbox
```

**Parameters:**

| Parameter | Type | Description |
|------------------|----------------------------------|----------------|
| `$apiKey` | **string** | Api Key |
| `$apiSecret` | **string** | Api Secret |
| `$webhookSecret` | **string|null** | Webhook Secret |
| `$client` | **\GuzzleHttp\Client|null** | Guzzle Client |

**Returns:** `\Urlbox\Screenshots\Urlbox`

**Throws:** `\InvalidArgumentException`

**Example:**

```php
$urlbox = new \Urlbox\Screenshots\Urlbox('key', 'secret', 'webhook', new \GuzzleHttp\Client());
```

***



## Other implementations

* [Node.js](https://github.com/urlbox-io/urlbox-screenshots-node)
Expand Down

0 comments on commit fbc372e

Please sign in to comment.