ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.590.0

Author: speakeasybot

.gitignore

@@ -1,3 +1,5 @@
+**/.speakeasy/temp/
+**/.speakeasy/logs/
 composer.lock
 vendor
 .DS_Store

.speakeasy/gen.lock

@@ -4,14 +4,22 @@ generation:
   maintainOpenAPIOrder: true
   usageSnippets:
     optionalPropertyRendering: withExample
+    sdkInitStyle: constructor
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
+    nameResolutionFeb2025: false
     parameterOrderingFeb2024: true
     requestResponseComponentNamesFeb2024: true
+    securityFeb2025: false
+    sharedErrorComponentsApr2025: false
   auth:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
+  tests:
+    generateTests: true
+    generateNewTests: false
+    skipResponseBodyAssertions: false
 externalDocs:
   version: ""
   url: https://github.com/goshippo/shippo-php-sdk
@@ -20,7 +28,13 @@ 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
+  baseErrorName: ShippoError
   clientServerStatusCodesAsErrors: true
   defaultErrorName: SDKError
   description: Shipping API Python library (USPS, FedEx, UPS and more)
@@ -39,6 +53,7 @@ php:
     svcName: openapi
   license: MIT License
   maxMethodParams: 3
+  methodArguments: infer-optional-args
   namespace: Shippo\API
   outputModelSuffix: output
   packageName: shippo/shippo-php

.speakeasy/gen.yaml

@@ -1,18 +1,26 @@
-speakeasyVersion: 1.310.0
+speakeasyVersion: 1.590.0
 sources:
     openapi:
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:3099fc4c926ab05099ea5c4cbb918e6423a03874cea38c8791efa7efbe6c5706
-        sourceBlobDigest: sha256:234f83b39101f22af624857db75abc2440fbe9c279d457ab0a7c8a393245cab1
+        sourceRevisionDigest: sha256:c7975b03b0e922bd14ceb9f47b00751e5ab098fca449707d2e20845cf7cc50f5
+        sourceBlobDigest: sha256:38d48412b95b3b5c0ed071f4887b46472950b923b239a773d7830c0ee92c6c14
         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:c7975b03b0e922bd14ceb9f47b00751e5ab098fca449707d2e20845cf7cc50f5
+        sourceBlobDigest: sha256:38d48412b95b3b5c0ed071f4887b46472950b923b239a773d7830c0ee92c6c14
+        codeSamplesNamespace: openapi-php-code-samples
+        codeSamplesRevisionDigest: sha256:6b6c9a532885cce09a438edbd29c601ccadd9a40c2a1fcee6024eecfad19e4d2
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -23,6 +31,16 @@ 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
+                labelOverride:
+                    fixedValue: Php (SDK)
+                blocking: false

.speakeasy/workflow.lock

@@ -14,3 +14,9 @@ targets:
             packagist:
                 username: [email protected]
                 token: $packagist_token
+        codeSamples:
+            registry:
+                location: registry.speakeasyapi.dev/shippo/shippo/openapi-php-code-samples
+            labelOverride:
+                fixedValue: Php (SDK)
+            blocking: false

.speakeasy/workflow.yaml

@@ -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

CONTRIBUTING.md

@@ -21,39 +21,29 @@ 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)
+  * [Authentication](#authentication)
+  * [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,27 +58,61 @@ declare(strict_types=1);
 require 'vendor/autoload.php';
 
 use Shippo\API;
+use Shippo\API\Models\Components;
+
+$sdk = API\Shippo::builder()->build();
+
+$request = new Components\WebhookPayloadBatch();
+
+$response = $sdk->batch(
+    request: $request
+);
+
+if ($response->statusCode === 200) {
+    // handle response
+}
+```
+<!-- End SDK Example Usage [usage] -->
 
-$security = '<YOUR_API_KEY_HERE>';
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name           | Type   | Scheme  |
+| -------------- | ------ | ------- |
+| `apiKeyHeader` | apiKey | API key |
+
+To authenticate with the API the `apiKeyHeader` parameter must be set when initializing the SDK. For example:
+```php
+declare(strict_types=1);
+
+require 'vendor/autoload.php';
+
+use Shippo\API;
 
 $sdk = API\Shippo::builder()
+    ->setSecurity(
+        '<YOUR_API_KEY_HERE>'
+    )
     ->setShippoApiVersion('2018-02-08')
-    ->setSecurity($security)->build();
+    ->build();
 
 
 
 $response = $sdk->addresses->list(
     page: 1,
-    results: 5,
-    shippoApiVersion: '2018-02-08'
+    results: 5
 
 );
 
 if ($response->addressPaginatedList !== null) {
     // handle response
 }
 ```
-<!-- End SDK Example Usage [usage] -->
+<!-- End Authentication [security] -->
 
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
@@ -261,18 +285,20 @@ declare(strict_types=1);
 require 'vendor/autoload.php';
 
 use Shippo\API;
+use Shippo\API\Models\Errors;
 use Shippo\API\Models\Operations;
 
-$security = '<YOUR_API_KEY_HERE>';
-
 $sdk = API\Shippo::builder()
     ->setShippoApiVersion('2018-02-08')
-    ->setSecurity($security)->build();
+    ->setSecurity(
+        '<YOUR_API_KEY_HERE>'
+    )
+    ->build();
 
 try {
     $request = new Operations\InitiateOauth2SigninRequest(
         carrierAccountObjectId: '<id>',
-        redirectUri: 'https://enlightened-mortise.com/',
+        redirectUri: 'https://ashamed-reporter.biz',
     );
 
     $response = $sdk->carrierAccounts->initiateOauth2Signin(
@@ -303,27 +329,27 @@ try {
 
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally using the `setServerUrl(string $serverUrl)` builder method when initializing the SDK client instance. For example:
+The default server can be overridden globally using the `setServerUrl(string $serverUrl)` builder method when initializing the SDK client instance. For example:
 ```php
 declare(strict_types=1);
 
 require 'vendor/autoload.php';
 
 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();
+    ->setSecurity(
+        '<YOUR_API_KEY_HERE>'
+    )
+    ->build();
 
 
 
 $response = $sdk->addresses->list(
     page: 1,
-    results: 5,
-    shippoApiVersion: '2018-02-08'
+    results: 5
 
 );
 

README.md

@@ -0,0 +1,11 @@
+
+
+## 2025-07-28 00:37:48
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.590.0 (2.666.0) 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 - .

RELEASES.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>';
 
-$sdk = API\ShippoSDK::builder()
+$sdk = API\Shippo::builder()
     ->setShippoApiVersion('2018-02-08')
-    ->setSecurity($security)
+    ->setSecurity(
+        '<YOUR_API_KEY_HERE>'
+    )
     ->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
+
+);
+
+if ($response->addressPaginatedList !== null) {
+    // handle response
+}
 ```
 <!-- End SDK Example Usage [usage] -->