refactored code

Signed-off-by: Maurice Preuß (envoyr) <hello@envoyr.com>

src/Id/Concerns/ManagesBalance.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Request;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesBalance
+{
+    use Request;
+
+    /**
+     * Get balance from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function balance(): float
+    {
+        return $this->getUserData()->current_balance;
+    }
+
+    /**
+     * Get charges from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function charges(): float
+    {
+        return $this->getUserData()->current_charges;
+    }
+
+    /**
+     * Charge given amount from bank to current user.
+     *
+     * @param float $amount Amount to charge in euros.
+     * @param string $paymentMethodId Payment method ID.
+     * @param array $options Additional options for the charge.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function charge(float $amount, string $paymentMethodId, array $options = []): Result
+    {
+        return $this->request('POST', 'billing/charge', [
+            'amount' => $amount,
+            'payment_method_id' => $paymentMethodId,
+            'options' => $options,
+        ]);
+    }
+}

src/Id/Concerns/ManagesInvoices.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Request;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesInvoices
+{
+    use Request;
+
+    /**
+     * Get invoices from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function invoices(): Result
+    {
+        return $this->request('GET', 'v1/invoices');
+    }
+
+    /**
+     * Get given invoice from the current user.
+     *
+     * @param string $invoiceId The invoice ID
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function invoice(string $invoiceId): Result
+    {
+        return $this->request('GET', sprintf('v1/invoices/%s', $invoiceId));
+    }
+
+    /**
+     * Get download url from given invoice.
+     *
+     * @param string $invoiceId The invoice ID
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function getInvoiceDownloadUrl(string $invoiceId): string
+    {
+        return $this->request('PUT', sprintf('v1/invoices/%s', $invoiceId))->data->download_url;
+    }
+}

src/Id/Concerns/ManagesOrders.php

@@ -0,0 +1,260 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Request;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesOrders
+{
+    use Request;
+
+    /**
+     * Get orders from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function orders(): Result
+    {
+        return $this->request('GET', 'v1/orders');
+    }
+
+    /**
+     * Creates a new order for the current user.
+     *
+     * VAT is calculated based on the billing address and shown in the order response.
+     *
+     * @param array{
+     *     billing_address: array{
+     *          company_name: null|string,
+     *          first_name:  null|string,
+     *          last_name: null|string,
+     *          address: null|string,
+     *          address_2: null|string,
+     *          house_number: null|string,
+     *          city: null|string,
+     *          state: null|string,
+     *          postal_code: null|string,
+     *          country_iso: string,
+     *          phone_number: null|string,
+     *          email: null|string
+     *     },
+     *     shipping_address: null|array{
+     *          company_name: null|string,
+     *          first_name:  string,
+     *          last_name: string,
+     *          address: null|string,
+     *          address_2: string,
+     *          house_number: null|string,
+     *          city: string,
+     *          state: string,
+     *          postal_code: string,
+     *          country_iso: string,
+     *          phone_number: null|string,
+     *          email: null|string
+     *     },
+     *     items: array<array{
+     *         type:        string,
+     *         name:        string,
+     *         description: string,
+     *         price:       float|int,
+     *         unit:        string,
+     *         units:       int
+     *     }>
+     * } $attributes The order data:
+     *   - billing_address:  Billing address (ISO 3166-1 alpha-2 country code)
+     *   - shipping_address: Shipping address (first name, last name, ISO 3166-1 alpha-2 country code)
+     *   - items:            Array of order items (each with type, name, price, unit, units, and quantity)
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function createOrder(array $attributes = []): Result
+    {
+        return $this->request('POST', 'v1/orders', $attributes);
+    }
+
+    /**
+     * Get given order from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function order(string $orderId): Result
+    {
+        return $this->request('GET', sprintf('v1/orders/%s', $orderId));
+    }
+
+    /**
+     * Update given order from the current user.
+     *
+     * VAT is calculated based on the billing address and shown in the order response.
+     *
+     * @param string $orderId The order ID.
+     * @param array{
+     *      billing_address: array{
+     *           company_name: null|string,
+     *           first_name:  null|string,
+     *           last_name: null|string,
+     *           address: null|string,
+     *           address_2: null|string,
+     *           house_number: null|string,
+     *           city: null|string,
+     *           state: null|string,
+     *           postal_code: null|string,
+     *           country_iso: string,
+     *           phone_number: null|string,
+     *           email: null|string
+     *      },
+     *      shipping_address: null|array{
+     *           company_name: null|string,
+     *           first_name:  string,
+     *           last_name: string,
+     *           address: null|string,
+     *           address_2: string,
+     *           house_number: null|string,
+     *           city: string,
+     *           state: string,
+     *           postal_code: string,
+     *           country_iso: string,
+     *           phone_number: null|string,
+     *           email: null|string
+     *      }
+     *  } $attributes The order data:
+     *    - billing_address:  Billing address (ISO 3166-1 alpha-2 country code)
+     *    - shipping_address: Shipping address (first name, last name, ISO 3166-1 alpha-2 country code)
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function updateOrder(string $orderId, array $attributes = []): Result
+    {
+        return $this->request('PUT', sprintf('v1/orders/%s', $orderId), $attributes);
+    }
+
+    /**
+     * Checkout given order from the current user.
+     *
+     * @param string $orderId The order ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function checkoutOrder(string $orderId): Result
+    {
+        return $this->request('PUT', sprintf('v1/orders/%s/checkout', $orderId));
+    }
+
+    /**
+     * Revoke given order from the current user.
+     *
+     * @param string $orderId The order ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function revokeOrder(string $orderId): Result
+    {
+        return $this->request('PUT', sprintf('v1/orders/%s/revoke', $orderId));
+    }
+
+    /**
+     * Delete given order from the current user.
+     *
+     * @param string $orderId The order ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function deleteOrder(string $orderId): Result
+    {
+        return $this->request('DELETE', sprintf('v1/orders/%s', $orderId));
+    }
+
+    /**
+     * Get order items from given order.
+     *
+     * @param string $orderId The order ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function orderItems(string $orderId): Result
+    {
+        return $this->request('GET', sprintf('v1/orders/%s/items', $orderId));
+    }
+
+    /**
+     * Create a new order item for given order.
+     *
+     * VAT is calculated based on the billing address and shown in the order item response.
+     *
+     * @param string $orderId The order ID.
+     * @param array{
+     *      items: array<array{
+     *          type:        string,
+     *          name:        string,
+     *          description: string,
+     *          price:       float|int,
+     *          unit:        string,
+     *          units:       int
+     *      }>
+     *  } $attributes The order data:
+     *    - items:           Array of order items, each with type, name, description, price, unit, and quantity
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function createOrderItem(string $orderId, array $attributes = []): Result
+    {
+        return $this->request('POST', sprintf('v1/orders/%s', $orderId), $attributes);
+    }
+
+    /**
+     * Get given order item from given order.
+     *
+     * @param string $orderId The order ID.
+     * @param string $orderItemId The order item ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function orderItem(string $orderId, string $orderItemId): Result
+    {
+        return $this->request('GET', sprintf('v1/orders/%s/items/%s', $orderId, $orderItemId));
+    }
+
+    /**
+     * Update given order item from given order.
+     *
+     * VAT is calculated based on the billing address and shown in the order item response.
+     *
+     * @param string $orderId The order ID.
+     * @param string $orderItemId The order item ID.
+     * @param array{
+     *       items: array<array{
+     *           type:        string,
+     *           name:        string,
+     *           description: string,
+     *           price:       float|int,
+     *           unit:        string,
+     *           units:       int
+     *       }>
+     *   } $attributes The order data:
+     *     - items:           Array of order items, each with type, name, description, price, unit, and quantity
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function updateOrderItem(string $orderId, string $orderItemId, array $attributes = []): Result
+    {
+        return $this->request('PUT', sprintf('v1/orders/%s/items/%s', $orderId, $orderItemId), $attributes);
+    }
+
+    /**
+     * Delete given order item from given order.
+     *
+     * @param string $orderId The order ID.
+     * @param string $orderItemId The order item ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function deleteOrderItem(string $orderId, string $orderItemId): Result
+    {
+        return $this->request('DELETE', sprintf('v1/orders/%s/items/%s', $orderId, $orderItemId));
+    }
+}

src/Id/Concerns/ManagesPaymentMethods.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Request;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesPaymentMethods
+{
+    use Request;
+
+    /**
+     * Check if current user has at least one payment method.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function hasPaymentMethod(): bool
+    {
+        return $this->paymentMethods()->count() > 0;
+    }
+
+    /**
+     * Get payment methods from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function paymentMethods(): Result
+    {
+        return $this->request('GET', 'v1/payment-methods');
+    }
+
+    /**
+     * Get default payment method from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function hasDefaultPaymentMethod(): bool
+    {
+        return $this->defaultPaymentMethod()->count() > 0;
+    }
+
+    /**
+     * Get default payment method from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function defaultPaymentMethod(): Result
+    {
+        return $this->request('GET', 'v1/payment-methods/default');
+    }
+
+    /**
+     * Get billing portal URL for the current user.
+     *
+     * @param string $returnUrl The URL to redirect to after the user has finished in the billing portal.
+     * @param array $options Additional options for the billing portal.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function billingPortalUrl(string $returnUrl, array $options): string
+    {
+        return $this->request('POST', 'v1/stripe/billing-portal', [
+            'return_url' => $returnUrl,
+            'options' => $options,
+        ])->data->url;
+    }
+
+    /**
+     * Create a new setup intent.
+     *
+     * @param array $options Additional options for the setup intent.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function createSetupIntent(array $options = []): Result
+    {
+        return $this->request('POST', 'v1/payment-methods', [
+            'options' => $options,
+        ]);
+    }
+}

src/Id/Concerns/ManagesPricing.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Post;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesPricing
+{
+    use Post;
+
+    /**
+     * Make a new order preview (will not be stored into the database).
+     *
+     * VAT is calculated based on the billing address and shown in the order response.
+     *
+     * @param array{
+     *     country_iso: string,
+     *     items: array<array{
+     *         type:        string,
+     *         name:        string,
+     *         description: string,
+     *         price:       float|int,
+     *         unit:        string,
+     *         units:       int
+     *     }>
+     * } $attributes The order data:
+     *   - country_iso:     ISO 3166-1 alpha-2 country code
+     *   - items:           Array of order items (each with type, name, price, unit, units, and quantity)
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function createOrderPreview(array $attributes = []): Result
+    {
+        return $this->post('v1/orders/preview', $attributes);
+    }
+}

src/Id/Concerns/ManagesSshKeys.php

@@ -0,0 +1,54 @@
+<?php
+
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Delete;
+use Anikeen\Id\ApiOperations\Get;
+use Anikeen\Id\ApiOperations\Post;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesSshKeys
+{
+    use Get, Post, Delete;
+
+    /**
+     * Get currently authed user with Bearer Token.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function sshKeysByUserId(string $sskKeyId): Result
+    {
+        return $this->get(sprintf('v1/users/%s/ssh-keys/json', $sskKeyId));
+    }
+
+    /**
+     * Creates ssh key for the currently authed user.
+     *
+     * @param string $publicKey The public key to be added
+     * @param string|null $name The name of the key (optional)
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function createSshKey(string $publicKey, string $name = null): Result
+    {
+        return $this->post('v1/ssh-keys', [
+            'public_key' => $publicKey,
+            'name' => $name,
+        ]);
+    }
+
+    /**
+     * Deletes a given ssh key for the currently authed user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function deleteSshKey(int $sshKeyId): Result
+    {
+        return $this->delete(sprintf('v1/ssh-keys/%s', $sshKeyId));
+    }
+}

src/Id/Concerns/ManagesSubscriptions.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Request;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesSubscriptions
+{
+    use Request;
+
+    /**
+     * Get subscriptions from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function subscriptions(): Result
+    {
+        return $this->request('GET', 'v1/subscriptions');
+    }
+
+    /**
+     * Get given subscription from the current user.
+     *
+     * @param string $subscriptionId The subscription ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function subscription(string $subscriptionId): Result
+    {
+        return $this->request('GET', sprintf('v1/subscriptions/%s', $subscriptionId));
+    }
+
+    /**
+     * Create a new subscription for the current user.
+     *
+     * @param array{
+     *      name: null,
+     *      description: string,
+     *      unit: string,
+     *      price: float,
+     *      vat: null|float,
+     *      payload: null|array,
+     *      ends_at: null|string,
+     *      webhook_url: null|string,
+     *      webhook_secret: null|string
+     *  } $attributes The subscription data:
+     *    - name:           The name
+     *    - description:    The description
+     *    - unit:           The unit (e.g. "hour", "day", "week", "month", "year")
+     *    - price:          The price per unit
+     *    - vat:            The VAT (optional)
+     *    - payload:        The payload (optional)
+     *    - ends_at:        The end date (optional)
+     *    - webhook_url:     The webhook URL (optional)
+     *    - webhook_secret:  The webhook secret (optional)
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function createSubscription(array $attributes): Result
+    {
+        return $this->request('POST', 'v1/subscriptions', $attributes);
+    }
+
+    /**
+     * Force given subscription to check out (trusted apps only).
+     *
+     * @param string $subscriptionId The subscription ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function checkoutSubscription(string $subscriptionId): Result
+    {
+        return $this->request('PUT', sprintf('v1/subscriptions/%s/checkout', $subscriptionId));
+    }
+
+    /**
+     * Revoke a given running subscription from the current user.
+     *
+     * @param string $subscriptionId The subscription ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function revokeSubscription(string $subscriptionId): Result
+    {
+        return $this->request('PUT', sprintf('v1/subscriptions/%s/revoke', $subscriptionId));
+    }
+
+    /**
+     * Resume a given running subscription from the current user.
+     *
+     * @param string $subscriptionId The subscription ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function resumeSubscription(string $subscriptionId): Result
+    {
+        return $this->request('PUT', sprintf('v1/subscriptions/%s/resume', $subscriptionId));
+    }
+}

src/Id/Concerns/ManagesTaxation.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Request;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesTaxation
+{
+    use Request;
+
+    /**
+     * Get VAT for the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function vat(): float
+    {
+        return $this->getUserData()->vat;
+    }
+}

src/Id/Concerns/ManagesTransactions.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Request;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesTransactions
+{
+    use Request;
+
+    /**
+     * Get transactions from the current user.
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function transactions(): Result
+    {
+        return $this->request('GET', 'v1/transactions');
+    }
+
+    /**
+     * Create a new transaction for the current user.
+     *
+     * @param array $attributes The attributes for the transaction.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     * @todo Add type hinting for the attributes array.
+     */
+    public function createTransaction(array $attributes = []): Result
+    {
+        return $this->request('POST', 'v1/transactions', $attributes);
+    }
+
+    /**
+     * Get given transaction from current current user.
+     *
+     * @param string $transactionId The transaction ID.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function transaction(string $transactionId): Result
+    {
+        return $this->request('GET', sprintf('v1/transactions/%s', $transactionId));
+    }
+}

src/Id/Concerns/ManagesUsers.php

@@ -0,0 +1,63 @@
+<?php
+
+
+namespace Anikeen\Id\Concerns;
+
+use Anikeen\Id\ApiOperations\Get;
+use Anikeen\Id\ApiOperations\Post;
+use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
+use Anikeen\Id\Result;
+use GuzzleHttp\Exception\GuzzleException;
+
+trait ManagesUsers
+{
+    use Get, Post;
+
+    /**
+     * Get currently authed user with Bearer Token
+     *
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function getAuthedUser(): Result
+    {
+        return $this->get('v1/user');
+    }
+
+    /**
+     * Creates a new user on behalf of the current user.
+     *
+     * @param array{
+     *       first_name: null|string,
+     *       last_name: null|string,
+     *       username: null|string,
+     *       email: string,
+     *       password: null|string
+     *   } $attributes The user data
+     *     - first_name:  The first name (optional)
+     *     - last_name:   The last name (optional)
+     *     - username:    The username (optional)
+     *     - email:       The email (required)
+     *     - password:    The password (optional, can be reset by the user if not provided)
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function createUser(array $attributes): Result
+    {
+        return $this->post('v1/users', $attributes);
+    }
+
+    /**
+     * Checks if the given email exists.
+     *
+     * @param string $email The email to check.
+     * @throws RequestRequiresClientIdException
+     * @throws GuzzleException
+     */
+    public function isEmailExisting(string $email): Result
+    {
+        return $this->post('v1/users/check', [
+            'email' => $email,
+        ]);
+    }
+}