vendasta/sales-orders

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (1.4.0) of this package.

PHP library for Vendasta's SalesOrders service

1.4.0 2021-06-23 21:58 UTC

Requires

• google/protobuf: ^3.6.0
• grpc/grpc: ^v1.1.0
• guzzlehttp/guzzle: ^6.3
• mdanter/ecc: ^0.5.0
• vendasta/vax: ^1.2.0

Requires (Dev)

• phpunit/phpunit: ^7

Unknown License

Published on Packagist.org on 2021-06-23 22:27 UTC

README

Description

This is Vendasta's official PHP SDK for API integration of sales-orders.

Requirements

• PHP 5.5 and above or PHP 7.0 and above
• PECL (may be used to install the required PHP extensions)
• Composer
• PHP gmp extension
• OPTIONAL (but recommended): PHP grpc extension

Installation

Install the requirements from above, then:

composer require vendasta/sales-orders

Authentication

To authenticate your SDK calls, you must provision a service account from within the Vendasta platform.

You must put this file on your server, and set an environment variable to it's path:

export VENDASTA_APPLICATION_CREDENTIALS=<path to credentials.json>

Client Initialization

It is highly recommended that you use a singleton client instance. Each client initilization will open it's own connection, therefore using a singleton results in reusing a connection, saving time and resources.

Set an environment variable:

export ENVIRONMENT=<DEMO or PROD> 

To instantiate the client:

$environment = getenv("ENVIRONMENT");
if ($environment == null) {
    $environment = "DEMO";
}
$client = new Vendasta\SalesOrders\V1\SalesOrdersClient($environment);

Notice that the environment will be set to DEMO if it is not specified.

Creating and activate an order

Creating and activating an order on a business will purchase the appropriate products, included are helper functions which will allow for G Suite and GoDaddy provisioning.

// Create the request
$req = new CreateAndActivateOrderRequest();

// Create the line items
$gSuite = SalesOrdersUtils::buildLineItem('MP-6XDHVMQ84K4THNNP2Z7W2GC28VLHRC4Q');
$goDaddy = SalesOrdersUtils::buildLineItem('MP-NNTJMBF6HPXR5XXC2JKCFWKJ64VZLBFQ');
$lineItems = array($gSuite, $goDaddy);

// Create the custom field
$gSuiteCustomField = SalesOrdersUtils::buildGSuiteCustomField("MP-6XDHVMQ84K4THNNP2Z7W2GC28VLHRC4Q", 'testdomain123.com', 'adminusername', 'First', 'Last', '[e-mail]');
$goDaddyCustomField = SalesOrdersUtils::buildGoDaddyCustomFields("MP-NNTJMBF6HPXR5XXC2JKCFWKJ64VZLBFQ", "testdomain123.com", "[e-mail]", "First", "Last", "3065555555", "[e-mail]", "First", "Last");
$customFields = array($gSuiteCustomField, $goDaddyCustomField);

// Create the order
$order = SalesOrdersUtils::buildOrder("ABC", "AG-123", $lineItems, $customFields);
$req->setOrder($order);

// Call CreateAndActivateOrder
$resp = $client->CreateAndActivateOrder($req);