Download the PHP package offline-agency/laravel-webex without Composer

On this page you can find all versions of the php package offline-agency/laravel-webex. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of offline-agency/laravel-webex

Informations about the package laravel-webex

Laravel Webex

CI Release Latest Stable Version Total Downloads codecov

A Laravel client for the Webex REST APIs: Meetings, Messaging, Admin, Calling and Devices modules, returned as typed entities or an Error.

Supported platforms

Package PHP Laravel
2.x 8.4, 8.5 12 (from 12.69.2), 13 (from 13.32)
1.x see the 1.x README

Policy: the package supports the Laravel majors that still receive security fixes and the PHP branches the selected Laravel majors support, starting from PHP 8.4. Laravel 11, PHP 8.3 and older are not supported by 2.x (PHP 8.3 is still maintained upstream, but outside this package's policy). Pre-release PHP or Laravel versions are never added to the supported set. Both floors and both majors run in CI.

Installation

The service provider and the LaravelWebex facade are auto-discovered. Publish the configuration:

and set in .env (never commit tokens):

Variable Purpose
WEBEX_BEARER bearer token sent with every request (required)
WEBEX_TIMEOUT request timeout in seconds (default 30)
WEBEX_CLIENT_ID, WEBEX_CLIENT_SECRET, WEBEX_CLIENT_CODE, WEBEX_REDIRECT_URI OAuth integration values
WEBEX_AUTH_ROUTE_ENABLED true to register the package's GET /auth route (off by default)

Tokens

The bearer token is resolved for every request, in this order:

  1. a token bound to the client: LaravelWebex::forToken($token)->messages()->... (one client per Webex account);
  2. the webex.token_resolver class, a Offlineagency\LaravelWebex\Contracts\TokenResolver whose token() is called before each request (refresh OAuth tokens there; safe in queue workers and Octane);
  3. config('webex.bearer').

Events

When a client is created, AuthenticationRequested is dispatched (a listener may set the token), then WebexClientConfigured. Neither means that Webex accepted the token: a rejected token comes back as an Error with status 401. SuccessfulAuthentication is still dispatched after WebexClientConfigured but is deprecated.

Retries

GET, PUT and DELETE are retried after a network failure, a 429 or a 503, waiting for Retry-After (seconds or HTTP date, capped by webex.retry.max_delay_seconds, default 30) or an exponential delay; webex.retry.times is the number of attempts (default 3, 1 disables retries). POST and PATCH are never retried. When Webex still answers 429, the Error carries status and retryAfter.

The /auth route

GET /auth (route name auth) is registered only when WEBEX_AUTH_ROUTE_ENABLED=true; it dispatches WebexClientConfigured. Change its path and name with webex.auth_route.

Usage

Every example below is executed by tests/Feature/ReadmeExamplesTest.php, which checks the HTTP method and path against the official Webex OpenAPI specification.

Results and errors

A method returns its entity (or a list of entities, true for deletions) when Webex answers with a 2xx status, and an Error otherwise:

Situation Result
2xx with a JSON document entity / list
204 (or empty 2xx) on a deletion true
2xx without a document where an entity is expected Error "Webex returned no document (HTTP 200)."
2xx with malformed JSON or a JSON scalar Error
4xx / 5xx with a Webex error document Error with message, errors, trackingId
4xx / 5xx with another body Error "Webex request failed (HTTP n)." (the body is not echoed)
network failure (after the retries) Error "Connection to Webex failed: ..."
a bug in your code (TypeError, ...) the exception is thrown, not converted

Error exposes message, errors, trackingId, status (HTTP status, null for network failures) and retryAfter.

Entity properties are typed from the official Webex OpenAPI schemas where every response agrees on a primitive type (?string, ?int, int|float|null, ?bool, ?array); the others are mixed. A field whose value does not fit the declared type is ignored (the property stays null).

Pagination

cursor() iterates every page lazily (a LazyCollection), so take(50) only reads the pages it needs:

The next page is the Link: rel="next" URL, followed only on the scheme, host and port of webex.base_url, so your token is never sent to another host. A failed page throws WebexRequestException (its error property is the Error); a repeated link or more than $maxPages pages (default 100) throws WebexPaginationException. listWithPagination() still returns one page with its nextLink.

API coverage

The implemented operations and the known gaps are listed in Webex OpenAPI specification: each request it sends must exist in the API.

Development

CI runs PHP 8.4/8.5 x Laravel 12/13, the lowest supported versions, 100 % line coverage of src and Http, Composer validation and audit, and actionlint.

Releases

Every pull request merged into main is released automatically once the CI run of its merge commit has passed: one stable tag (MAJOR.MINOR.PATCH, no v prefix) and one GitHub Release with the pull request's description. The version bump comes from a release:major|minor|patch label or the Conventional Commit title (feat → minor, !/BREAKING CHANGE → major, anything else → patch). See CONTRIBUTING.md.

Upgrading from 1.x: GitHub Releases.

Documentation

docs.offlineagency.com/laravel-webex

Security

Please report vulnerabilities privately to SECURITY.md.

Credits

License

MIT. See LICENSE.md.

All versions of laravel-webex with dependencies

PHP Build Version
Package Version
Requires php Version ~8.4.0 || ~8.5.0
ext-json Version *
laravel/framework Version ^12.69.2 || ^13.32
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package offline-agency/laravel-webex contains the following files

Loading the files please wait ...