emmelaineglz/orchextra-coupons-generation

SDK para consumo de servicios de Generación de Cupones

dev-master 2017-07-07 16:59 UTC

Requires

• emmelaineglz/orchextra-client-php: dev-master
• guzzlehttp/guzzle: ~6.0
• guzzlehttp/promises: ^1.3
• guzzlehttp/psr7: ^1.4
• illuminate/database: ^5.4
• illuminate/support: ^5.4

MIT

• Ethel E. Gonzalez

• generation
• cupones
• orchextra

README

SDK para consumo de servicios de Generación de Cupones

Instalación por composer

composer require emmelaineglz/orchextra-coupons-generation-php

Para poder tener acceso a este SDK, es necesario autenticarse.

composer require emmelaineglz/orchextra-client-php

Ejemplo de uso con autenticación

require "vendor/autoload.php";
use Gigigo\Orchextra\Auth;
use Gigigo\Orchextra\Generation;

Instanciamos la clase

$auth = new Auth('https://ejemplo.com.mx');

Hacemos referencia al método de Autentucación del Cliente y llamamos al metodo "getToken()" para obtener el token de acceso.

$client = $auth->authClient('cliente1', '12345');
$token = $auth->getToken();

Ahora instanciamos la clase, a la cual vamos a enviar url, version y el token.

$campaign = new Generation\Campaign('https://ejemplo.com.mx', 'v1', $token);

Ya con la intancia, podemos acceder a sus metodos, para settera nuestros parametros, se puede hacer uso de los setters o enviar un arreglo que contenga lo que necesitamos.

$campaign->setWith ( [
    'user',
    'user.clients'
  ]);
$campaign->setFields ( [
    'name',
    'description'
  ]);
$campaign->setFilters ( [
    'name' => 'Campaña 1',
    'description' => 'Campaña de promoción'
  ]);
$campaign->setPagination ( [
  'perPage' => 3,
  'page' => 2
]);
$collection = $campaign->all ([
    'with' => [
      'user',
      'user.clients'
    ],
    'fields' => [
      'name',
      'description',
      'user.email',
      'user.clients.clientSecret'
    ],
    'filters' => [
      'name' => 'Campaña de Prueba Ethel Replace 2',
    ],
    'pagination' => [
        'perPage' => 3
        'page' => 2
        ]
  ]);

Las posibles respuestas obtenidas, serán una colleccion de instancias de objetos, una instancia sencilla, o un Array.

Accediendo a las colecciones de la siguiente manera:

$collection->first();

Convertir en un array

$collection->first()->toArray();

Aplicar acciones

$collection->first()->replace();
$collection->first()->update();
$collection->first()->delete();

Acceder a las propiedades de manera directa

$collection->first()->name;
$collection->first()->description;