feat(api): add network, bridge fields to accounts

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 23
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-5a8ac7b545c48dc892e5c680303e305254921554dabee848e40a808659dbcf1e.yml
-openapi_spec_hash: 0103975601aac1445d3a4ef418c5d17a
-config_hash: 7d85c0b454fc78a59db6474c5c4d73c6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-611aa7641fbca8cf31d626bf86f9efd3c2b92778e897ebbb25c6ea44185ed1ed.yml
+openapi_spec_hash: d6c0a1776048dab04f6c5625c9893c9c
+config_hash: 39ed0717b5f415499aaace2468346e1a

README.md

@@ -2,8 +2,6 @@
 
 The Beeper Desktop PHP library provides convenient access to the Beeper Desktop REST API from any PHP 8.1.0+ application.
 
-It is generated with [Stainless](https://www.stainless.com/).
-
 ## Documentation
 
 The REST API documentation can be found on [developers.beeper.com](https://developers.beeper.com/desktop-api/).
@@ -40,7 +38,9 @@ Parameters with a default value must be set by name.
 
 use BeeperDesktop\Client;
 
-$client = new Client();
+$client = new Client(
+  accessToken: getenv('BEEPER_ACCESS_TOKEN') ?: 'My Access Token'
+);
 
 $page = $client->chats->search(includeMuted: true, limit: 3, type: 'single');
 
@@ -65,7 +65,9 @@ This library provides auto-paginating iterators with each list response, so you
 
 use BeeperDesktop\Client;
 
-$client = new Client();
+$client = new Client(
+  accessToken: getenv('BEEPER_ACCESS_TOKEN') ?: 'My Access Token'
+);
 
 $page = $client->messages->search(
   accountIDs: ['local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI'],

src/Accounts/Account.php

@@ -4,6 +4,7 @@
 
 namespace BeeperDesktop\Accounts;
 
+use BeeperDesktop\Accounts\Account\Bridge;
 use BeeperDesktop\Core\Attributes\Required;
 use BeeperDesktop\Core\Concerns\SdkModel;
 use BeeperDesktop\Core\Contracts\BaseModel;
@@ -12,9 +13,15 @@
 /**
  * A chat account added to Beeper.
  *
+ * @phpstan-import-type BridgeShape from \BeeperDesktop\Accounts\Account\Bridge
  * @phpstan-import-type UserShape from \BeeperDesktop\User
  *
- * @phpstan-type AccountShape = array{accountID: string, user: User|UserShape}
+ * @phpstan-type AccountShape = array{
+ *   accountID: string,
+ *   bridge: Bridge|BridgeShape,
+ *   network: string,
+ *   user: User|UserShape,
+ * }
  */
 final class Account implements BaseModel
 {
@@ -27,6 +34,18 @@ final class Account implements BaseModel
     #[Required]
     public string $accountID;
 
+    /**
+     * Bridge metadata for the account. Available from Beeper Desktop v.4.2.719+.
+     */
+    #[Required]
+    public Bridge $bridge;
+
+    /**
+     * Human-friendly network name for the account.
+     */
+    #[Required]
+    public string $network;
+
     /**
      * User the account belongs to.
      */
@@ -38,13 +57,17 @@ final class Account implements BaseModel
      *
      * To enforce required parameters use
      * ```
-     * Account::with(accountID: ..., user: ...)
+     * Account::with(accountID: ..., bridge: ..., network: ..., user: ...)
      * ```
      *
      * Otherwise ensure the following setters are called
      *
      * ```
-     * (new Account)->withAccountID(...)->withUser(...)
+     * (new Account)
+     *   ->withAccountID(...)
+     *   ->withBridge(...)
+     *   ->withNetwork(...)
+     *   ->withUser(...)
      * ```
      */
     public function __construct()
@@ -57,13 +80,20 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      *
+     * @param Bridge|BridgeShape $bridge
      * @param User|UserShape $user
      */
-    public static function with(string $accountID, User|array $user): self
-    {
+    public static function with(
+        string $accountID,
+        Bridge|array $bridge,
+        string $network,
+        User|array $user
+    ): self {
         $self = new self;
 
         $self['accountID'] = $accountID;
+        $self['bridge'] = $bridge;
+        $self['network'] = $network;
         $self['user'] = $user;
 
         return $self;
@@ -80,6 +110,30 @@ public function withAccountID(string $accountID): self
         return $self;
     }
 
+    /**
+     * Bridge metadata for the account. Available from Beeper Desktop v.4.2.719+.
+     *
+     * @param Bridge|BridgeShape $bridge
+     */
+    public function withBridge(Bridge|array $bridge): self
+    {
+        $self = clone $this;
+        $self['bridge'] = $bridge;
+
+        return $self;
+    }
+
+    /**
+     * Human-friendly network name for the account.
+     */
+    public function withNetwork(string $network): self
+    {
+        $self = clone $this;
+        $self['network'] = $network;
+
+        return $self;
+    }
+
     /**
      * User the account belongs to.
      *

src/Accounts/Account/Bridge.php

@@ -0,0 +1,118 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BeeperDesktop\Accounts\Account;
+
+use BeeperDesktop\Accounts\Account\Bridge\Provider;
+use BeeperDesktop\Core\Attributes\Required;
+use BeeperDesktop\Core\Concerns\SdkModel;
+use BeeperDesktop\Core\Contracts\BaseModel;
+
+/**
+ * Bridge metadata for the account. Available from Beeper Desktop v.4.2.719+.
+ *
+ * @phpstan-type BridgeShape = array{
+ *   id: string, provider: Provider|value-of<Provider>, type: string
+ * }
+ */
+final class Bridge implements BaseModel
+{
+    /** @use SdkModel<BridgeShape> */
+    use SdkModel;
+
+    /**
+     * Bridge instance identifier.
+     */
+    #[Required]
+    public string $id;
+
+    /**
+     * Bridge provider for the account.
+     *
+     * @var value-of<Provider> $provider
+     */
+    #[Required(enum: Provider::class)]
+    public string $provider;
+
+    /**
+     * Bridge type.
+     */
+    #[Required]
+    public string $type;
+
+    /**
+     * `new Bridge()` is missing required properties by the API.
+     *
+     * To enforce required parameters use
+     * ```
+     * Bridge::with(id: ..., provider: ..., type: ...)
+     * ```
+     *
+     * Otherwise ensure the following setters are called
+     *
+     * ```
+     * (new Bridge)->withID(...)->withProvider(...)->withType(...)
+     * ```
+     */
+    public function __construct()
+    {
+        $this->initialize();
+    }
+
+    /**
+     * Construct an instance from the required parameters.
+     *
+     * You must use named parameters to construct any parameters with a default value.
+     *
+     * @param Provider|value-of<Provider> $provider
+     */
+    public static function with(
+        string $id,
+        Provider|string $provider,
+        string $type
+    ): self {
+        $self = new self;
+
+        $self['id'] = $id;
+        $self['provider'] = $provider;
+        $self['type'] = $type;
+
+        return $self;
+    }
+
+    /**
+     * Bridge instance identifier.
+     */
+    public function withID(string $id): self
+    {
+        $self = clone $this;
+        $self['id'] = $id;
+
+        return $self;
+    }
+
+    /**
+     * Bridge provider for the account.
+     *
+     * @param Provider|value-of<Provider> $provider
+     */
+    public function withProvider(Provider|string $provider): self
+    {
+        $self = clone $this;
+        $self['provider'] = $provider;
+
+        return $self;
+    }
+
+    /**
+     * Bridge type.
+     */
+    public function withType(string $type): self
+    {
+        $self = clone $this;
+        $self['type'] = $type;
+
+        return $self;
+    }
+}

src/Accounts/Account/Bridge/Provider.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BeeperDesktop\Accounts\Account\Bridge;
+
+/**
+ * Bridge provider for the account.
+ */
+enum Provider: string
+{
+    case CLOUD = 'cloud';
+
+    case SELF_HOSTED = 'self-hosted';
+
+    case LOCAL = 'local';
+
+    case PLATFORM_SDK = 'platform-sdk';
+}