Skip to content

Update documentation links #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2025
Merged

Update documentation links #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Resources/Carrier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ final class Carrier extends Resource
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
* @see https://app.sendy.nl/api/docs#tag/Carriers/operation/getCarriers
* @link https://app.sendy.nl/api/docs#tag/Carriers/operation/api.carriers.index
*/
public function list(): array
{
Expand All @@ -31,7 +31,7 @@ public function list(): array
* @return array<string, mixed|array<string|mixed>>
* @throws ApiException
* @throws GuzzleException
* @see https://app.sendy.nl/api/docs#tag/Carriers/operation/getCarrier
* @link https://app.sendy.nl/api/docs#tag/Carriers/operation/api.carriers.show
*/
public function get(int $id): array
{
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Label.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ final class Label extends Resource
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
* @see https://app.sendy.nl/api/docs#tag/Documents/operation/getLabels
* @link https://app.sendy.nl/api/docs#tag/Documents/operation/api.labels.index
*/
public function get(array $shipmentIds, string $paperType = null, string $startLocation = null): array
{
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Me.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ final class Me extends Resource
*
* Display the currently authenticated user’s profile.
*
* @see https://app.sendy.nl/api/docs#tag/User/operation/getProfileInformation
* @link https://app.sendy.nl/api/docs#tag/User/operation/api.me
* @return array<string, mixed|array<string|mixed>>
*/
public function get(): array
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Parcelshop.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Parcelshop extends Resource
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
* @see https://app.sendy.nl/api/docs#tag/Parcel-shops
* @link https://app.sendy.nl/api/docs#tag/Parcel-shops
*/
public function list(
array $carriers,
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Service.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Service extends Resource
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
* @see https://app.sendy.nl/api/docs#tag/Services/operation/getCarrierServices
* @link https://app.sendy.nl/api/docs#tag/Services/operation/api.carriers.services.index
*/
public function list(int $carrierId): array
{
Expand Down
16 changes: 8 additions & 8 deletions src/Resources/Shipment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ final class Shipment extends Resource
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
* @see https://app.sendy.nl/api/docs#tag/Shipments/operation/shipments.index
* @link https://app.sendy.nl/api/docs#tag/Shipments/operation/api.shipments.index
* @see Meta
*/
public function list(int $page = 1): array
Expand All @@ -34,7 +34,7 @@ public function list(int $page = 1): array
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
* @see https://app.sendy.nl/api/docs#tag/Shipments/operation/shipments.show
* @link https://app.sendy.nl/api/docs#tag/Shipments/operation/api.shipments.show
*/
public function get(string $id): array
{
Expand Down Expand Up @@ -70,7 +70,7 @@ public function update(string $id, array $data): array
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
* @see https://app.sendy.nl/api/docs#tag/Shipments/operation/shipments.destroy
* @link https://app.sendy.nl/api/docs#tag/Shipments/operation/api.shipments.destroy
*/
public function delete(string $id): array
{
Expand All @@ -87,7 +87,7 @@ public function delete(string $id): array
* @return array<string, mixed|array<string|mixed>>
* @throws ApiException
* @throws GuzzleException
* @see https://app.sendy.nl/api/docs#tag/Shipments/operation/shipments.preference
* @link https://app.sendy.nl/api/docs#tag/Shipments/operation/api.shipments.preference
* @see ShippingPreference
*/
public function createFromPreference(array $data, bool $generateDirectly = true): array
Expand All @@ -102,7 +102,7 @@ public function createFromPreference(array $data, bool $generateDirectly = true)
* @return array<string, mixed|array<string|mixed>>
* @throws ApiException
* @throws GuzzleException
* @see https://app.sendy.nl/api/docs#tag/Shipments/operation/shipments.smart-rule
* @link https://app.sendy.nl/api/docs#tag/Shipments/operation/api.shipments.smart-rule
*/
public function createWithSmartRules(array $data): array
{
Expand All @@ -119,7 +119,7 @@ public function createWithSmartRules(array $data): array
* @return array<string, mixed|array<string|mixed>>
* @throws ApiException
* @throws GuzzleException
* @see https://app.sendy.nl/api/docs#tag/Shipments/operation/shipments.generate
* @link https://app.sendy.nl/api/docs#tag/Shipments/operation/api.shipments.generate
*/
public function generate(string $id, bool $asynchronous = true): array
{
Expand All @@ -135,7 +135,7 @@ public function generate(string $id, bool $asynchronous = true): array
* @return array<string, mixed|array<string|mixed>>
* @throws ApiException
* @throws GuzzleException
* @see https://app.sendy.nl/api/docs#tag/Documents/operation/getLabels
* @link https://app.sendy.nl/api/docs#tag/Documents/operation/api.shipments.labels.index
*/
public function labels(string $id): array
{
Expand All @@ -151,7 +151,7 @@ public function labels(string $id): array
* @return array<string, mixed|array<string|mixed>>
* @throws ApiException
* @throws GuzzleException
* @see https://app.sendy.nl/api/docs#tag/Documents/operation/shipments.documents
* @link https://app.sendy.nl/api/docs#tag/Documents/operation/api.shipments.documents.index
*/
public function documents(string $id): array
{
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/ShippingPreference.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class ShippingPreference extends Resource
*
* Display all active shipping preferences for the active company in a list.
*
* @see https://app.sendy.nl/api/docs#tag/Shipping-preferences/operation/shipping_preferences.index
* @link https://app.sendy.nl/api/docs#tag/Shipping-preferences
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
Expand Down
4 changes: 2 additions & 2 deletions src/Resources/Shop.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class Shop extends Resource
*
* Display all shops in a list
*
* @see https://app.sendy.nl/api/docs#tag/Shops/operation/getShops
* @link https://app.sendy.nl/api/docs#tag/Shops/operation/api.shops.index
* @return array<string, mixed|array<string|mixed>>
* @throws GuzzleException
* @throws ApiException
Expand All @@ -27,7 +27,7 @@ public function list(): array
*
* Get a specific shop by its UUID
*
* @see https://app.sendy.nl/api/docs#tag/Shops/operation/getShopByUuid
* @link https://app.sendy.nl/api/docs#tag/Shops/operation/api.shops.show
* @param string $id
* @return array<string, mixed|array<string|mixed>>
* @throws ApiException
Expand Down
4 changes: 2 additions & 2 deletions src/Resources/Webhook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ final class Webhook extends Resource
* @return array<string, mixed|array<string|mixed>>
* @throws \GuzzleHttp\Exception\GuzzleException
* @throws \Sendy\Api\ApiException
* @see https://app.sendy.nl/api/docs#tag/Webhooks/operation/api.webhooks.index
* @link https://app.sendy.nl/api/docs#tag/Webhooks/operation/api.webhooks.index
*/
public function list(): array
{
Expand All @@ -24,7 +24,7 @@ public function list(): array
* @return array<string, mixed|array<string|mixed>>
* @throws \GuzzleHttp\Exception\GuzzleException
* @throws \Sendy\Api\ApiException
* @see https://app.sendy.nl/api/docs#tag/Webhooks/operation/api.webhooks.store
* @link https://app.sendy.nl/api/docs#tag/Webhooks/operation/api.webhooks.store
*/
public function create(array $data): array
{
Expand Down