Refactor request / response classes to support latest changes to API endpoints

README.md

@@ -54,7 +54,7 @@ The following environment variables are required to be set before using the libr
 Optionally, you may pass these environment variables as well:
 
 - `SERAVO_ENVIRONMENT`
-    - Defines the API environment (`testing`, `staging`, `production`) to be used. Defaults to `production` if omitted from `.env` and/or constructor.
+  - Defines the API environment (`testing`, `staging`, `production`) to be used. Defaults to `production` if omitted from `.env` and/or constructor.
 
 These values must be set in the `/.env` file. See `.env.example`.
 
@@ -146,26 +146,27 @@ use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Billing\PaperInvoice;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Company;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Contact;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Mail;
+use Seravo\SeravoApi\Apis\Order\Response\Order\Domain;
 
 $billing = new PaperInvoice(
-    contactEmail: 'jonh@doe.com',
-    contactName: 'John Doe',
-    contactPhone: '0401234567',
+    contact_email: 'john@doe.com',
+    contact_name: 'John Doe',
+    contact_phone: '0401234567',
     address: 'Testikatu 1',
     city: 'Helsinki',
     postal: '00100',
     name: 'John Doe'
 );
 
 $createOrderRequest = new CreateOrderRequest(
-    acceptServiceTerms: true,
+    accept_service_terms: true,
+    domains: [ new Domain(name: 'mydomainexample123.fi', primary: true) ],
     contact: new Contact(email: 'john@doe.com', name: 'John Doe', phone: '0401234567'),
     migration: false,
-    orderLanguage: 'FI',
-    orderTrialPeriod: 0,
-    primaryDomain: 'example.fi',
-    siteLocation: 'FI',
-    priceData: 'ff67d517-e5a1-4826-b936-5c41cd12853f',
+    order_language: 'fi', // 'fi', 'en_US', 'sv_SE'
+    order_trial_period: 0,
+    site_location: 'FI',
+    price_data: 'd289afc7-b02e-44b5-918b-da66aa3d8858',
     billing: $billing,
     company: new Company(id: '1', name: 'John Doe'),
     mail: new Mail(option: '1'),
@@ -192,4 +193,4 @@ See our documentation for [Order Module API](https://api.seravo.com/order/docs#/
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

examples/orders/CreateOrder.php

@@ -11,26 +11,27 @@
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Company;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Contact;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Mail;
+use Seravo\SeravoApi\Apis\Order\Response\Order\Domain;
 
 $billing = new PaperInvoice(
-    contactEmail: 'jonh@doe.com',
-    contactName: 'John Doe',
-    contactPhone: '0401234567',
+    contact_email: 'john@doe.com',
+    contact_name: 'John Doe',
+    contact_phone: '0401234567',
     address: 'Testikatu 1',
     city: 'Helsinki',
     postal: '00100',
     name: 'John Doe'
 );
 
 $createOrderRequest = new CreateOrderRequest(
-    acceptServiceTerms: true,
+    accept_service_terms: true,
+    domains: [ new Domain(name: 'mydomainexample123.fi', primary: true) ],
     contact: new Contact(email: 'john@doe.com', name: 'John Doe', phone: '0401234567'),
     migration: false,
-    orderLanguage: 'FI',
-    orderTrialPeriod: 0,
-    primaryDomain: 'example.fi',
-    siteLocation: 'FI',
-    priceData: 'ff67d517-e5a1-4826-b936-5c41cd12853f',
+    order_language: 'fi', // 'fi', 'en_US', 'sv_SE'
+    order_trial_period: 0,
+    site_location: 'FI',
+    price_data: 'd289afc7-b02e-44b5-918b-da66aa3d8858',
     billing: $billing,
     company: new Company(id: '1', name: 'John Doe'),
     mail: new Mail(option: '1'),

examples/orders/UpdateOrder.php

@@ -10,12 +10,13 @@
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Company;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Contact;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Mail;
+use Seravo\SeravoApi\Apis\Order\Response\Order\Domain;
 use Seravo\SeravoApi\SeravoAPI;
 
 $billing = new PaperInvoice(
-    contactEmail: 'john@doe.com',
-    contactName: 'John Doe',
-    contactPhone: '0401234567',
+    contact_email: 'john@doe.com',
+    contact_name: 'John Doe',
+    contact_phone: '0401234567',
     address: 'Testikatu 1',
     city: 'Helsinki',
     postal: '00100',
@@ -24,18 +25,23 @@
 
 $updateOrderRequest = new UpdateOrderRequest(
     ...[
-        'acceptServiceTerms' => true,
+        'accept_service_terms' => true,
         'contact' => new Contact(email: 'john@doe.com', name: 'John Doe', phone: '0401234567'),
         'migration' => false,
-        'orderLanguage' => 'FI',
-        'orderTrialPeriod' => 12,
-        'primaryDomain' => 'example.fi',
-        'siteLocation' => 'FI',
-        'priceData' => 'ff67d517-e5a1-4826-b936-5c41cd12853f',
+        'order_language' => 'fi', // 'fi', 'en_US', 'sv_SE'
+        'order_trial_period' => 12,
+        'domains' => [
+            new Domain(
+                name: 'mydomainexample123.fi',
+                primary: true
+            )
+        ],
+        'site_location' => 'FI',
+        'price_data' => 'd289afc7-b02e-44b5-918b-da66aa3d8858',
         'billing' => $billing,
         'company' => new Company(id: '1', name: 'John Doe'),
         'mail' => new Mail(option: '1'),
-        'id' => 'e608fd78-a0e0-4a9d-98db-8e38de79acb7'
+        'id' => '1d3c9e84-9c71-40c7-ba62-fbc5d9b59e96'
     ]
 );
 
@@ -48,7 +54,7 @@
 
 try {
     $result = $api->order->orders()->update(
-        id: 'e608fd78-a0e0-4a9d-98db-8e38de79acb7',
+        id: '1d3c9e84-9c71-40c7-ba62-fbc5d9b59e96',
         request: $updateOrderRequest
     );
     dd($result);

examples/prices/CreatePrice.php

@@ -7,11 +7,16 @@
 
 use Seravo\SeravoApi\SeravoAPI;
 use Seravo\SeravoApi\Apis\Public\Request\Price\CreatePriceRequest;
+use Seravo\SeravoApi\Apis\Public\Request\Price\Domain;
+use Seravo\SeravoApi\Enums\DomainType;
 
 $createPriceRequest = new CreatePriceRequest(
     interval: 1,
     products: [],
     plan: '0e6bb9d4-2c90-4ae7-b876-4e17d5e8ff11',
+    domains: [
+        new Domain(name: 'mydomainexample123.fi', primary: true, type: DomainType::Registration->value),
+    ],
     promotion: null,
 );
 

src/Apis/Order/Request/Order/OrderRequest.php

@@ -9,34 +9,34 @@
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Mail;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Company;
 use Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Contact;
+use Seravo\SeravoApi\Apis\Order\Response\Order\Domain;
 
 abstract readonly class OrderRequest implements \JsonSerializable
 {
     use ArrayTransformer;
 
     /**
      *
-     * @param array<string>|null $additionalDomains
+     * @param array<Domain> $domains
      */
     public function __construct(
-        public bool $acceptServiceTerms,
+        public bool $accept_service_terms,
+        public array $domains,
         public Contact $contact,
         public bool $migration,
-        public string $orderLanguage,
-        public string $primaryDomain,
-        public string $siteLocation,
-        public string $priceData,
+        public string $order_language,
+        public string $site_location,
+        public string $price_data,
         public BillingMethod $billing,
         public Company $company,
         public Mail $mail,
-        public ?array $additionalDomains = [],
-        public ?int $orderTrialPeriod = 0,
-        public ?string $affiliateId = null,
-        public ?string $externalCustomerId = null,
+        public ?int $order_trial_period = 0,
+        public ?string $affiliate_id = null,
+        public ?string $external_customer_id = null,
         public ?string $message = null,
-        public ?string $missAffiliateId = null,
-        public ?string $requestId = null,
-        public ?int $serviceId = null,
+        public ?string $miss_affiliate_id = null,
+        public ?string $request_id = null,
+        public ?int $service_id = null,
     ) {
     }
 

src/Apis/Order/Request/Order/Schema/Billing/BillingMethod.php

@@ -7,9 +7,9 @@
 abstract class BillingMethod
 {
     public function __construct(
-        public string $contactEmail,
-        public string $contactName,
-        public string $contactPhone,
+        public string $contact_email,
+        public string $contact_name,
+        public string $contact_phone,
         public string $option,
     ) {
     }

src/Apis/Order/Request/Order/Schema/Billing/CCInvoice.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Seravo\SeravoApi\Apis\Order\Request\Order\Schema\Billing;
+
+use Seravo\SeravoApi\Enums\BillingMethod as BillingMethodEnum;
+
+class CCInvoice extends BillingMethod
+{
+    public function __construct(
+        public string $contact_email,
+        public string $contact_name,
+        public string $contact_phone,
+        public ?string $invoice = null,
+        public ?string $operator = null,
+        public ?string $address = null,
+        public ?string $address2 = null,
+        public ?string $city = null,
+        public ?string $email = null,
+        public ?string $name = null,
+        public ?string $postal = null,
+    ) {
+        parent::__construct($contact_email, $contact_name, $contact_phone, BillingMethodEnum::CCInvoice->value);
+    }
+}

src/Apis/Order/Request/Order/Schema/Billing/EInvoice.php

@@ -9,9 +9,9 @@
 class EInvoice extends BillingMethod
 {
     public function __construct(
-        public string $contactEmail,
-        public string $contactName,
-        public string $contactPhone,
+        public string $contact_email,
+        public string $contact_name,
+        public string $contact_phone,
         public string $invoice,
         public string $operator,
         public ?string $address = null,
@@ -21,6 +21,6 @@ public function __construct(
         public ?string $name = null,
         public ?string $postal = null,
     ) {
-        parent::__construct($contactEmail, $contactName, $contactPhone, BillingMethodEnum::EInvoice->value);
+        parent::__construct($contact_email, $contact_name, $contact_phone, BillingMethodEnum::EInvoice->value);
     }
 }

src/Apis/Order/Request/Order/Schema/Billing/EmailInvoice.php

@@ -9,9 +9,9 @@
 class EmailInvoice extends BillingMethod
 {
     public function __construct(
-        public string $contactEmail,
-        public string $contactName,
-        public string $contactPhone,
+        public string $contact_email,
+        public string $contact_name,
+        public string $contact_phone,
         public string $email,
         public ?string $invoice = null,
         public ?string $operator = null,
@@ -21,6 +21,6 @@ public function __construct(
         public ?string $name = null,
         public ?string $postal = null
     ) {
-        parent::__construct($contactEmail, $contactName, $contactPhone, BillingMethodEnum::Email->value);
+        parent::__construct($contact_email, $contact_name, $contact_phone, BillingMethodEnum::Email->value);
     }
 }

src/Apis/Order/Request/Order/Schema/Billing/PaperInvoice.php

@@ -9,9 +9,9 @@
 class PaperInvoice extends BillingMethod
 {
     public function __construct(
-        public string $contactEmail,
-        public string $contactName,
-        public string $contactPhone,
+        public string $contact_email,
+        public string $contact_name,
+        public string $contact_phone,
         public string $address,
         public string $city,
         public string $name,
@@ -21,6 +21,6 @@ public function __construct(
         public ?string $operator = null,
         public ?string $address2 = null,
     ) {
-        parent::__construct($contactEmail, $contactName, $contactPhone, BillingMethodEnum::Paper->value);
+        parent::__construct($contact_email, $contact_name, $contact_phone, BillingMethodEnum::Paper->value);
     }
 }

src/Apis/Order/Request/Order/Schema/Mail.php

@@ -10,14 +10,14 @@
      * Undocumented function
      *
      * @param array<string> $boxes
-     * @param array<string> $forwardingFrom
-     * @param array<string> $forwardingTo
+     * @param array<string> $forwarding_from
+     * @param array<string> $forwarding_to
      */
     public function __construct(
         public string $option,
         public array $boxes = [],
-        public array $forwardingFrom = [],
-        public array $forwardingTo = []
+        public array $forwarding_from = [],
+        public array $forwarding_to = []
     ) {
     }
 }

src/Apis/Order/Response/Affiliate.php

@@ -10,11 +10,11 @@
 {
     public function __construct(
         public string $name,
-        public string $partnerId,
-        public \DateTime $createdAt,
+        public string $partner_id,
+        public \DateTime $created_at,
         public string $id,
-        public ?\DateTime $updatedAt = null,
-        public ?\DateTime $deletedAt = null,
+        public ?\DateTime $updated_at = null,
+        public ?\DateTime $deleted_at = null,
     ) {
     }
 }

src/Apis/Order/Response/Coupon.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Seravo\SeravoApi\Apis\Order\Response;
+
+use Seravo\SeravoApi\Apis\AbstractResponse;
+
+readonly class Coupon extends AbstractResponse
+{
+    public function __construct(
+        public string $type,
+        public int $duration,
+        public string $id,
+        public string $promotion_code_id,
+        public string $product_id,
+        public string $product_group_id,
+        public string $discount,
+        public string $amount_off,
+        public string $valid_before,
+        public string $valid_after,
+        public \DateTime $created_at,
+        public ?\DateTime $updated_at = null
+    ) {
+    }
+}

src/Apis/Order/Response/Order/Billing.php

@@ -9,9 +9,9 @@
 readonly class Billing extends AbstractResponse
 {
     public function __construct(
-        public ?string $contactEmail = null,
-        public ?string $contactName = null,
-        public ?string $contactPhone = null,
+        public ?string $contact_email = null,
+        public ?string $contact_name = null,
+        public ?string $contact_phone = null,
         public ?string $option = null,
         public ?string $address = null,
         public ?string $address2 = null,