ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.455.3

.speakeasy/gen.yaml

@@ -20,6 +20,11 @@ info:
   description: Packagist library which integrates with Shippo Multi Carrier Shipping API. This library provides access to Shippo (goshippo.com) API capabilities. Including label generation, rating, tracking and more.
 php:
   version: 3.0.0-alpha
+  additionalDependencies:
+    autoload: {}
+    autoload-dev: {}
+    require: {}
+    require-dev: {}
   author: Shippo
   clientServerStatusCodesAsErrors: true
   defaultErrorName: SDKError
@@ -39,6 +44,7 @@ php:
     svcName: openapi
   license: MIT License
   maxMethodParams: 3
+  methodArguments: infer-optional-args
   namespace: Shippo\API
   outputModelSuffix: output
   packageName: shippo/shippo-php

.speakeasy/workflow.lock

@@ -1,18 +1,26 @@
-speakeasyVersion: 1.310.0
+speakeasyVersion: 1.455.3
 sources:
     openapi:
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:3099fc4c926ab05099ea5c4cbb918e6423a03874cea38c8791efa7efbe6c5706
-        sourceBlobDigest: sha256:234f83b39101f22af624857db75abc2440fbe9c279d457ab0a7c8a393245cab1
+        sourceRevisionDigest: sha256:3bfca8ec7ce4dabc78868a2b04619d457a166888c343e06a260469d50a0873b3
+        sourceBlobDigest: sha256:1b88a763bf9a88c705175433cac246f726297ba1d331abf5d03334a6e25e9b89
         tags:
             - latest
+            - speakeasy-sdk-regen-1731434842
+            - "2018-02-08"
 targets:
     my-first-target:
         source: openapi
         sourceNamespace: openapi
         sourceRevisionDigest: sha256:3099fc4c926ab05099ea5c4cbb918e6423a03874cea38c8791efa7efbe6c5706
         sourceBlobDigest: sha256:234f83b39101f22af624857db75abc2440fbe9c279d457ab0a7c8a393245cab1
-        outLocation: /Users/mike.lueders/dev/shippo-php-sdk
+    php:
+        source: openapi
+        sourceNamespace: openapi
+        sourceRevisionDigest: sha256:3bfca8ec7ce4dabc78868a2b04619d457a166888c343e06a260469d50a0873b3
+        sourceBlobDigest: sha256:1b88a763bf9a88c705175433cac246f726297ba1d331abf5d03334a6e25e9b89
+        codeSamplesNamespace: openapi-php-code-samples
+        codeSamplesRevisionDigest: sha256:038bd0a1688e17d9559aadb8b2af5254b9558f61a472842de277f4b034c6215c
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -23,6 +31,14 @@ workflow:
             registry:
                 location: registry.speakeasyapi.dev/shippo/shippo/openapi
     targets:
-        my-first-target:
+        php:
             target: php
             source: openapi
+            publish:
+                packagist:
+                    username: [email protected]
+                    token: $packagist_token
+            codeSamples:
+                registry:
+                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-php-code-samples
+                blocking: false

.speakeasy/workflow.yaml

@@ -14,3 +14,7 @@ targets:
             packagist:
                 username: [email protected]
                 token: $packagist_token
+        codeSamples:
+            registry:
+                location: registry.speakeasyapi.dev/shippo/shippo/openapi-php-code-samples
+            blocking: false

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to This Repository
+
+Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
+
+## How to Report Issues
+
+If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected and actual behavior
+- Any relevant logs, screenshots, or error messages
+- Information about your environment (e.g., operating system, software versions)
+    - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
+
+## Issue Triage and Upstream Fixes
+
+We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
+
+## Contact
+
+If you have any questions or need further assistance, please feel free to reach out by opening an issue.
+
+Thank you for your understanding and cooperation!
+
+The Maintainers

README.md

@@ -21,39 +21,28 @@ Shippo external API.: Use this API to integrate with the Shippo service
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [<img src="https://docs.goshippo.com/images/Logo.png" width="30" alt="Shippo logo"> Shippo PHP SDK](#img-srchttpsdocsgoshippocomimageslogopng-width30-altshippo-logo-shippo-php-sdk)
+  * [SDK Installation](#sdk-installation)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+  * [About Shippo](#about-shippo)
 
-* [SDK Installation](#sdk-installation)
-* [SDK Example Usage](#sdk-example-usage)
-* [Available Resources and Operations](#available-resources-and-operations)
-* [Error Handling](#error-handling)
-* [Server Selection](#server-selection)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
 The SDK relies on [Composer](https://getcomposer.org/) to manage its dependencies.
 
-To install the SDK first add the below to your `composer.json` file:
-
-```json
-{
-    "repositories": [
-        {
-            "type": "github",
-            "url": "<UNSET>.git"
-        }
-    ],
-    "require": {
-        "Shippo": "*"
-    }
-}
-```
-
-Then run the following command:
-
+To install the SDK and add it as a dependency to an existing `composer.json` file:
 ```bash
-composer update
+composer require "shippo/shippo-php"
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -68,23 +57,19 @@ declare(strict_types=1);
 require 'vendor/autoload.php';
 
 use Shippo\API;
-
-$security = '<YOUR_API_KEY_HERE>';
+use Shippo\API\Models\Components;
 
 $sdk = API\Shippo::builder()
     ->setShippoApiVersion('2018-02-08')
-    ->setSecurity($security)->build();
+    ->build();
 
+$request = new Components\WebhookPayloadBatch();
 
-
-$response = $sdk->addresses->list(
-    page: 1,
-    results: 5,
-    shippoApiVersion: '2018-02-08'
-
+$response = $sdk->batch(
+    request: $request
 );
 
-if ($response->addressPaginatedList !== null) {
+if ($response->statusCode === 200) {
     // handle response
 }
 ```
@@ -314,7 +299,7 @@ use Shippo\API;
 $security = '<YOUR_API_KEY_HERE>';
 
 $sdk = API\Shippo::builder()
-    ->setServerURL("https://api.goshippo.com")
+    ->setServerURL('https://api.goshippo.com')
     ->setShippoApiVersion('2018-02-08')
     ->setSecurity($security)->build();
 

RELEASES.md

@@ -0,0 +1,11 @@
+
+
+## 2024-12-16 00:31:56
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.455.3 (2.479.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [php v3.0.0-alpha] .
+### Releases
+- [Composer v3.0.0-alpha] https://packagist.org/packages/shippo/shippo-php#v3.0.0-alpha - .

USAGE.md

@@ -1,32 +1,28 @@
 <!-- Start SDK Example Usage [usage] -->
 ```php
-<?php
-
 declare(strict_types=1);
 
 require 'vendor/autoload.php';
 
 use Shippo\API;
-use Shippo\API\Models\Components;
-use Shippo\API\Models\Operations;
 
-$security = new Components\Security();
-$security->apiKeyHeader = '<YOUR_API_KEY_HERE>';
+$security = '<YOUR_API_KEY_HERE>';
 
-$sdk = API\ShippoSDK::builder()
+$sdk = API\Shippo::builder()
     ->setShippoApiVersion('2018-02-08')
-    ->setSecurity($security)
-    ->build();
+    ->setSecurity($security)->build();
 
-try {
-    $response = $sdk->addresses->list(768578, 99895, '2018-02-08');
 
-    if ($response->addressPaginatedList !== null) {
-        // handle response
-    }
-} catch (Throwable $e) {
-    // handle exception
-}
 
+$response = $sdk->addresses->list(
+    page: 1,
+    results: 5,
+    shippoApiVersion: '2018-02-08'
+
+);
+
+if ($response->addressPaginatedList !== null) {
+    // handle response
+}
 ```
 <!-- End SDK Example Usage [usage] -->

composer.json

@@ -1,5 +1,5 @@
 {
-  "name": "shippo/api",
+  "name": "shippo/shippo-php",
   "type": "library",
   "autoload": {
     "psr-4": {
@@ -9,29 +9,34 @@
   "license": "MIT",
   "require": {
     "php": "^8.2",
+    "galbar/jsonpath": "^3.0",
     "guzzlehttp/guzzle": "^7.0",
-    "jms/serializer": "^3.22"
+    "speakeasy/serializer": "^4.0.0",
+    "brick/date-time": "^0.7.0",
+    "phpdocumentor/type-resolver": "^1.8",
+    "brick/math": "^0.12.1"
   },
   "require-dev": {
-    "laravel/pint": "^1.15",
-    "phpstan/phpstan": "^1.9",
+    "laravel/pint": "^1.18.1",
+    "phpstan/phpstan": "^1.12",
     "phpunit/phpunit": "^10",
-    "rector/rector": "^0.18.13",
+    "rector/rector": "^0.19",
     "roave/security-advisories": "dev-latest"
   },
   "minimum-stability": "stable",
   "prefer-stable": true,
   "config": {
     "optimize-autoloader": true,
     "classmap-authoritative": true,
-    "sort-packages": true
+    "sort-packages": true,
+    "process-timeout": 60
   },
   "scripts": {
     "test": [
-      "./vendor/bin/phpunit --testdox"
+      "./vendor/bin/phpunit --testdox --display-warnings --colors=always"
     ],
     "stan": [
-      "./vendor/bin/phpstan analyse --memory-limit=2g"
+      "./vendor/bin/phpstan analyse --memory-limit=2g --error-format=table"
     ]
   },
   "script-descriptions": {