support for send_invite

[treii28]

I added a bare-bones definition in mine:

    'SendInvite' => [

            'httpMethod'    => 'POST',
            'uri'           => 'admin/customers/{id}/send_invite.json',
            'responseModel' => 'GenericModel',
            'summary'       => 'Send an account invite to a customer',
            'data'          => ['root_key' => 'customer_invite'],
            'parameters'    => [
                'id' => [
                    'description' => 'Customer ID',
                    'location'    => 'uri',
                    'type'        => 'integer',
                    'required'    => true,
                ],
            ],
            'additionalParameters' => [
                'location' => 'json',
            ],
        ],

With nothing but the id, it sends a standard invite. Otherwise you can include additional details to customize it:

// fed with an array similar to the return value of getCustomer
function send_invite($customer) {
    global $shopifyClient;
    $command = $shopifyClient->getCommand(
        'SendInvite',
        [
            'id' => $customer['id'],
            "to" => $customer['email'],
            "from" => "[email protected]",
            "subject" => "Some subject line",
            "custom_message" => <<<EOT
<p>Hello Everyone,</p>
<p>Please join my website</p>
<p>other custom message stuffs</p>
EOT

        ]
    );

    try {
        $results = $shopifyClient->execute($command);
        return $results;
    } catch (Exception $e) {
        $message = $e->getMessage();
        return $message;
    }
}

[bakura10]

Hi !

Thanks a lot. If you're sending us a PR with this change, I would be very happy to merge this into the library!

[treii28]

I wasn't sure of what reasoning you use for the parameters you include in your definitions. For a customized invite, for example, you'd probably want a minimum of a customerId (id) and customerEmail (to) fields and likely the subject and custom_message also. But since it can technically be done with just the id on the url to send the stock message, I left those to the additional parameters in my definition

[bakura10]

The rule I have adopted in that library is that you must set explicitly ONLY the parameters that are absolutely required. So, in this case, if an ID is sufficient to make the call works, then all other parameters should be set as additioalParameters as you did :). You can threfore submit this as a PR. If there are any problem I'll let you know which change needs to be done.

[treii28]

that's what I figured