magicbell-js 0.0.1

package/LICENSE

@@ -0,0 +1,194 @@
+LICENSE AGREEMENT
+
+By downloading or using this software made available by MagicBell, Inc.
+("MagicBell") or any documentation that accompanies it (collectively, the
+"Software"), you and the company or entity that you represent (collectively,
+"you" or "your") are consenting to be bound by and are becoming a party to this
+License Agreement (this "Agreement").  You hereby represent and warrant that you
+are authorized and lawfully able to bind such company or entity that you
+represent to this Agreement.  If you do not have such authority or do not agree
+to all of the terms of this Agreement, you may not download or use the Software.  
+
+LICENSE GRANT.  Subject to your compliance with and the terms and conditions of
+this Agreement, MagicBell, Inc. ("MagicBell") hereby grants you a limited,
+personal, non-exclusive, non-sublicensable, non-transferable license to (a) use,
+install, and run the Software solely to create and display a customized user
+interface in connection with your internal use of MagicBell’s embeddable
+notification inbox product (the "MagicBell Product"); and (b) modify the
+Software (the results thereof, "Modifications") solely to customize your user
+interface in connection with your use of the MagicBell Product; (c) compile and
+execute object code versions of the Software (including as incorporating your
+Modifications) solely to use internally your customized MagicBell Product user
+interface; and (d) make electronic copies of the Software and any Modifications
+as required for backup or archival purposes.  You acknowledge that your use of
+any components provided with the Software that are licensed under an open source
+software license ("Open Source Components") are not part of the Software
+licensed hereunder and are subject to and governed solely by the terms of the
+applicable license(s) for that software, and not by this Agreement.
+
+RESTRICTIONS.  You are responsible for all activities that occur in connection
+with the Software.  Except as otherwise expressly authorized by MagicBell, you
+may not directly or indirectly: (a) sublicense, sell, assign, distribute,
+modify, make derivative works of, make any commercial use of, use on a timeshare
+or service bureau basis, use for the benefit of a third party or otherwise
+commercialize the Software (or any Modifications); (b) allow third parties to
+access or use the source code of the Software (or any Modifications); use the
+Software (or any Modifications) to create or facilitate the creation of, or
+otherwise incorporate any portion of the Software (or any Modifications) in,
+any product or service that is competitive with the MagicBell Product; (c) use
+the Software (or any Modifications) to perform comparisons or other
+"benchmarking" activities; (d) remove any proprietary notices or branding from
+the Software; and/or (e) use the Software (or any Modifications) in violation
+of any applicable laws or regulations or outside of the scope of the license
+granted in Section 1.  You shall ensure that there is no direct or indirect use
+of, or sharing of, the Software (or any Modifications), or other information
+based upon or derived from the Software (or any Modifications) to develop such
+competitive products.  Without derogating the generality of the foregoing,
+development of any competitive product shall include having direct or indirect
+access to, supervising, consulting or assisting in the development of, or
+product any specifications, documentations, object code or source code for, all
+or part of any competitive product.
+
+AUTHORIZED USERS.  Subject to the rights granted to you under this Agreement,
+you may permit your employees, contractors and agents to exercise the rights
+granted herein in accordance with the Agreement solely on behalf of you to
+provide services to you, provided that you are liable for all acts and omissions
+thereof to the extent that any such acts and omissions, if performed by you,
+would constitute a breach or, or otherwise giver right to liability to you,
+under this Agreement.  You represent and warrant that you shall not permit any
+third party to access or use the Software (or any Modifications) except as
+expressly permitted under this Agreement.
+
+OPEN SOURCE COMPONENTS.  You and your authorized users shall not use any Open
+Source Components in connection with the Software or any Modifications or in any
+way that could subject the Software to an open source license.
+
+OWNERSHIP.  As between MagicBell and you, MagicBell or its licensors shall own
+and retain all proprietary rights, including all patent, copyright, trade
+secret, trademark and other intellectual property rights, in and to the Software
+and any Modifications and you hereby irrevocably transfer, convey and assign to
+MagicBell all right, title, and interest in any Modifications regardless of
+whether such Modifications are actually delivered to MagicBell.  MagicBell shall
+have the exclusive right to apply for or register any patents, mask work rights,
+copyrights, and such other proprietary protections with respect thereto. You
+acknowledge that the license granted under Section 2 of this Agreement does not
+provide you with title or ownership to the Software or any such Modifications,
+but only a right of limited use under the terms and conditions of this
+Agreement.
+
+You represent and warrant to MagicBell that you have the full right, and have
+obtained all consents, approvals, authorizations, permits and licenses required
+or necessary, to allow you to grant to MagicBell the assignments and rights
+provided for herein and otherwise fully perform this Agreement (and have written
+enforceable agreements with all persons necessary to give you the rights to do
+the foregoing).
+
+LIMITATIONS ON MODIFICATIONS TO SOFTWARE.  Notwithstanding any provision in this
+Agreement, Modifications may only be created and used by you as permitted by
+this Agreement.  You are solely responsible for all use of Modifications and,
+without limiting anything herein, MagicBell will have no liability with respect
+to Modifications.  You will not assert against MagicBell, its affiliates or
+their customers, direct or indirect, agents and contractors, in any way, any
+intellectual property rights that you may obtain relating to any Modifications
+for the Software.
+
+SUPPORT AND UPGRADES.  If MagicBell provides you with any upgrades, patches,
+enhancements or fixes for the Software that it makes generally available free
+of charge in connection with the Software, then the items that are provided will
+become part of the Software and subject to this Agreement.  MagicBell shall have
+no obligation, however, under this Agreement or otherwise to provide any
+upgrades, patches, enhancements, fixes or any other support to you for the
+Software. 
+
+WARRANTY AND DISCLAIMER.  USE OF THE SOFTWARE IS ENTIRELY AT YOUR OWN RISK.
+MAGICBELL PROVIDES THE SOFTWARE "AS IS" AND "AS AVAILABLE" WITHOUT ANY WARRANTY
+OF ANY KIND AND HEREBY DISCLAIMS, FOR ITSELF AND ITS LICENSORS AND SUPPLIERS,
+ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING WITHOUT LIMITATION WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, PERFORMANCE, ACCURACY,
+RELIABILITY, NON-INFRINGEMENT, AND WARRANTIES ARISING OUT OF COURSE OF
+PERFORMANCE, COURSE OF DEALING OR USAGE IN TRADE.  MAGICBELL DOES NOT WARRANT
+THAT THE SOFTWARE IS ERROR-FREE, WILL FUNCTION WITHOUT INTERRUPTION, WILL MEET
+ANY SPECIFIC NEED THAT YOU MAY HAVE, THAT ALL DEFECTS WILL BE CORRECTED OR THAT
+IT IS SUFFICIENTLY DOCUMENTED TO BE USEABLE BY YOU.  THIS DISCLAIMER OF WARRANTY
+CONSTITUTES AN ESSENTIAL PART OF THE AGREEMENT.
+
+LIMITATION OF LIABILITY.  NOTWITHSTANDING ANYTHING ELSE, UNDER NO CIRCUMSTANCES
+SHALL MAGICBELL OR ITS LICENSORS OR SUPPLIERS, BE LIABLE TO YOU OR ANY OTHER
+PERSON WITH RESPECT TO THE SUBJECT MATTER OF THIS AGREEMENT UNDER ANY CONTRACT,
+TORT, NEGLIGENCE, STRICT LIABILITY, WARRANTY OR OTHER LEGAL OR EQUITABLE THEORY,
+FOR ANY INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND
+INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOST PROFITS, LOSS OF GOODWILL,
+LOSS OF DATA, COSTS OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES, TECHNOLOGY OR
+RIGHTS, INTERRUPTION OF BUSINESS, ACCURACY OF RESULTS, COMPUTER FAILURE OR
+MALFUNCTION, OR OTHER DAMAGES IN EXCESS OF ONE HUNDRED DOLLARS (US$100), EVEN IF
+AWARE OF THE POSSIBILITY OF SUCH DAMAGES.
+
+BASIS OF BARGAIN.  YOU AND MAGICBELL EACH RECOGNIZE AND AGREE THAT THE WARRANTY
+DISCLAIMERS AND LIABILITY AND REMEDY LIMITATIONS IN THIS AGREEMENT ARE MATERIAL,
+BARGAINED FOR BASES FOR THIS AGREEMENT AND THAT THEY HAVE BEEN TAKEN INTO
+ACCOUNT AND REFLECTED IN DETERMINING THE CONSIDERATION TO BE GIVEN BY EACH PARTY
+UNDER THIS AGREEMENT AND IN THE DECISION BY EACH PARTY TO ENTER INTO THIS
+AGREEMENT.
+
+TERM AND TERMINATION.  The term of this Agreement will begin when the Software
+is downloaded or accessed and shall continue until terminated pursuant to this
+section. Either party may terminate this Agreement and the licenses granted
+herein at any time.  MagicBell may terminate this Agreement and the licenses
+granted in this Agreement immediately if you breach any provision of this
+Agreement, including but not limited to, if you are or become a competitor of
+the MagicBell or make or sell any competitive products, in additional to all
+other available remedies.  Upon termination, all of your rights and licenses
+under this Agreement cease to exist, including, for the avoidance of doubt, any
+rights in any Modifications you may have developed; you must cease exercise of
+the licensed rights herein; you must destroy or remove from all hard drives,
+networks, and storage media, all copies and extracts of the Software and all
+Modifications in your possession or control; and this sentence, all remedies for
+breach, and Sections 2 through 10 and 12 through 14 shall survive any
+termination of this Agreement.  Any continued use of the Software by you or
+attempt by you to exercise any rights under this Agreement after this Agreement
+has been terminated will be considered copyright infringement and you will be
+subject to all applicable remedies.  
+
+FEEDBACK.  You agree that MagicBell may collect or you may provide to MagicBell
+comments, feedback, suggestions or other information related to the Software, or
+modifications, corrections, improvements, derivatives and extensions to the
+Software (collectively, "Feedback"), and you hereby grant MagicBell the
+perpetual and irrevocable right (and the perpetual and irrevocable right to
+permit others) to use and fully exercise and exploit the Feedback in any manner
+to improve, develop and otherwise exploit applications, services or technology,
+and otherwise in connection with its business during and after the term of this
+Agreement. 
+
+GOVERNMENT RESTRICTED RIGHTS.  All software, technology, and accompanying
+documentation are deemed to be "commercial computer software" and "commercial
+computer software documentation," respectively, pursuant to DFAR Section
+227.7202 and FAR Section 12.212, as applicable. Any use, modification,
+reproduction, release, performance, display, transfer or disclosure of the
+Software and accompanying documentation by any agency, department or other
+entity of any government, shall be governed solely by the terms of this
+Agreement and shall be prohibited except to the extent expressly permitted by
+the terms herein or in a writing signed by an authorized signatory on behalf of
+MagicBell. No other rights are granted. 
+
+MISCELLANEOUS.  You may not assign or transfer this Agreement, by operation of
+law or otherwise, or any of your rights under this Agreement (including any
+license rights granted to you), to any third party without MagicBell’s prior
+written consent, which consent will not be unreasonably withheld or delayed.
+
+MagicBell may assign this Agreement, without consent, including, but not limited
+to, affiliates or any successor to all or substantially all of its business or
+assets to which this Agreement relates, whether by merger, sale of assets, sale
+of stock, reorganization or otherwise.  Any attempted assignment or transfer in
+violation of the foregoing will be null and void.  This Agreement contains the
+complete agreement between you and MagicBell regarding the Software and
+supersedes all prior agreements and representations between you and MagicBell
+regarding the Software.  This Agreement may only be amended and any provision
+may only be waived by a writing executed by both parties.  You agree to promptly
+provide MagicBell with all information and documentation that MagicBell requests
+to verify your compliance with this Agreement.  If any provision of this
+Agreement is held to be invalid or unenforceable, it shall be reformed to the
+limited extent necessary to make it enforceable.  This Agreement shall be
+governed by and construed in accordance with the laws of California, without
+regard to its conflicts of laws provisions.  California will have exclusive
+jurisdiction and venue under this Agreement.  The United Nations Convention on
+Contracts for the International Sale of Goods does not apply to this Agreement.

package/README.md

@@ -0,0 +1,309 @@
+# MagicBell JavaScript SDK
+
+Welcome to the `magicbell-js` SDK documentation. This guide will help you get started with integrating and using the JavaScript SDK in your project.
+
+# Setup & Configuration
+
+## Installation
+
+To get started with the SDK, we recommend installing using `npm`:
+
+```bash
+npm install magicbell-js
+```
+
+# MagicBell JavaScript ProjectClient
+
+<!-- AUTO-GENERATED-CONTENT:START (project-client) -->
+
+## Authentication
+
+### Access Token Authentication
+
+The Client API uses an Access Token for authentication.
+
+This token must be provided to authenticate your requests to the API.
+
+#### Setting the Access Token
+
+When you initialize the SDK, you can set the access token as follows:
+
+```ts
+const sdk = new Client({ token: 'YOUR_TOKEN' });
+```
+
+If you need to set or update the access token after initializing the SDK, you can use:
+
+```ts
+const sdk = new Client();
+sdk.token = 'YOUR_TOKEN';
+```
+
+## Setting a Custom Timeout
+
+You can set a custom timeout for the SDK's HTTP requests as follows:
+
+```ts
+const client = new Client({ timeout: 10000 });
+```
+
+# Sample Usage
+
+Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
+
+```ts
+import { Client } from 'magicbell-js/project-client';
+
+(async () => {
+  const client = new Client({
+    token: 'YOUR_TOKEN',
+  });
+
+  const { data } = await client.broadcasts.listBroadcasts({
+    limit: 5,
+    startingAfter: 'starting_after',
+    endingBefore: 'ending_before',
+  });
+
+  console.log(data);
+})();
+```
+
+## Services
+
+The SDK provides various services to interact with the API.
+
+<details> 
+<summary>Below is a list of all available services with links to their detailed documentation:</summary>
+
+| Name                                                                         |
+| :--------------------------------------------------------------------------- |
+| [BroadcastsService](docs/project-client/services/BroadcastsService.md)       |
+| [ChannelsService](docs/project-client/services/ChannelsService.md)           |
+| [EventsService](docs/project-client/services/EventsService.md)               |
+| [IntegrationsService](docs/project-client/services/IntegrationsService.md)   |
+| [JwtService](docs/project-client/services/JwtService.md)                     |
+| [NotificationsService](docs/project-client/services/NotificationsService.md) |
+| [UsersService](docs/project-client/services/UsersService.md)                 |
+
+</details>
+
+## Models
+
+The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
+
+<details> 
+<summary>Below is a list of all available models with links to their detailed documentation:</summary>
+
+| Name                                                                                       | Description |
+| :----------------------------------------------------------------------------------------- | :---------- |
+| [BroadcastCollection](docs/project-client/models/BroadcastCollection.md)                   |             |
+| [Broadcast](docs/project-client/models/Broadcast.md)                                       |             |
+| [Links](docs/project-client/models/Links.md)                                               |             |
+| [CategoryDeliveryConfig](docs/project-client/models/CategoryDeliveryConfig.md)             |             |
+| [InboxTokenResponseCollection](docs/project-client/models/InboxTokenResponseCollection.md) |             |
+| [InboxTokenResponse](docs/project-client/models/InboxTokenResponse.md)                     |             |
+| [Links](docs/project-client/models/Links.md)                                               |             |
+| [DiscardResult](docs/project-client/models/DiscardResult.md)                               |             |
+| [ApnsTokenCollection](docs/project-client/models/ApnsTokenCollection.md)                   |             |
+| [ApnsToken](docs/project-client/models/ApnsToken.md)                                       |             |
+| [ExpoTokenCollection](docs/project-client/models/ExpoTokenCollection.md)                   |             |
+| [ExpoToken](docs/project-client/models/ExpoToken.md)                                       |             |
+| [FcmTokenCollection](docs/project-client/models/FcmTokenCollection.md)                     |             |
+| [FcmToken](docs/project-client/models/FcmToken.md)                                         |             |
+| [SlackTokenCollection](docs/project-client/models/SlackTokenCollection.md)                 |             |
+| [SlackToken](docs/project-client/models/SlackToken.md)                                     |             |
+| [TeamsTokenCollection](docs/project-client/models/TeamsTokenCollection.md)                 |             |
+| [TeamsToken](docs/project-client/models/TeamsToken.md)                                     |             |
+| [WebPushTokenCollection](docs/project-client/models/WebPushTokenCollection.md)             |             |
+| [WebPushToken](docs/project-client/models/WebPushToken.md)                                 |             |
+| [EventCollection](docs/project-client/models/EventCollection.md)                           |             |
+| [Event](docs/project-client/models/Event.md)                                               |             |
+| [Links](docs/project-client/models/Links.md)                                               |             |
+| [IntegrationConfigCollection](docs/project-client/models/IntegrationConfigCollection.md)   |             |
+| [IntegrationConfig](docs/project-client/models/IntegrationConfig.md)                       |             |
+| [Links](docs/project-client/models/Links.md)                                               |             |
+| [ApnsConfigCollection](docs/project-client/models/ApnsConfigCollection.md)                 |             |
+| [ApnsConfig](docs/project-client/models/ApnsConfig.md)                                     |             |
+| [ApnsConfigPayload](docs/project-client/models/ApnsConfigPayload.md)                       |             |
+| [AwssnsConfigCollection](docs/project-client/models/AwssnsConfigCollection.md)             |             |
+| [AwssnsConfig](docs/project-client/models/AwssnsConfig.md)                                 |             |
+| [AwssnsConfigPayload](docs/project-client/models/AwssnsConfigPayload.md)                   |             |
+| [EventSourceConfigCollection](docs/project-client/models/EventSourceConfigCollection.md)   |             |
+| [EventSourceConfig](docs/project-client/models/EventSourceConfig.md)                       |             |
+| [EventSourceConfigPayload](docs/project-client/models/EventSourceConfigPayload.md)         |             |
+| [ExpoConfigCollection](docs/project-client/models/ExpoConfigCollection.md)                 |             |
+| [ExpoConfig](docs/project-client/models/ExpoConfig.md)                                     |             |
+| [ExpoConfigPayload](docs/project-client/models/ExpoConfigPayload.md)                       |             |
+| [FcmConfigCollection](docs/project-client/models/FcmConfigCollection.md)                   |             |
+| [FcmConfig](docs/project-client/models/FcmConfig.md)                                       |             |
+| [FcmConfigPayload](docs/project-client/models/FcmConfigPayload.md)                         |             |
+| [GithubConfigCollection](docs/project-client/models/GithubConfigCollection.md)             |             |
+| [GithubConfig](docs/project-client/models/GithubConfig.md)                                 |             |
+| [GithubConfigPayload](docs/project-client/models/GithubConfigPayload.md)                   |             |
+| [InboxConfigCollection](docs/project-client/models/InboxConfigCollection.md)               |             |
+| [InboxConfig](docs/project-client/models/InboxConfig.md)                                   |             |
+| [InboxConfigPayload](docs/project-client/models/InboxConfigPayload.md)                     |             |
+| [MailgunConfigCollection](docs/project-client/models/MailgunConfigCollection.md)           |             |
+| [MailgunConfig](docs/project-client/models/MailgunConfig.md)                               |             |
+| [MailgunConfigPayload](docs/project-client/models/MailgunConfigPayload.md)                 |             |
+| [PingConfigCollection](docs/project-client/models/PingConfigCollection.md)                 |             |
+| [PingConfig](docs/project-client/models/PingConfig.md)                                     |             |
+| [PingConfigPayload](docs/project-client/models/PingConfigPayload.md)                       |             |
+| [SendgridConfigCollection](docs/project-client/models/SendgridConfigCollection.md)         |             |
+| [SendgridConfig](docs/project-client/models/SendgridConfig.md)                             |             |
+| [SendgridConfigPayload](docs/project-client/models/SendgridConfigPayload.md)               |             |
+| [SesConfigCollection](docs/project-client/models/SesConfigCollection.md)                   |             |
+| [SesConfig](docs/project-client/models/SesConfig.md)                                       |             |
+| [SesConfigPayload](docs/project-client/models/SesConfigPayload.md)                         |             |
+| [SlackConfigCollection](docs/project-client/models/SlackConfigCollection.md)               |             |
+| [SlackConfig](docs/project-client/models/SlackConfig.md)                                   |             |
+| [SlackConfigPayload](docs/project-client/models/SlackConfigPayload.md)                     |             |
+| [StripeConfigCollection](docs/project-client/models/StripeConfigCollection.md)             |             |
+| [StripeConfig](docs/project-client/models/StripeConfig.md)                                 |             |
+| [StripeConfigPayload](docs/project-client/models/StripeConfigPayload.md)                   |             |
+| [TemplatesConfigCollection](docs/project-client/models/TemplatesConfigCollection.md)       |             |
+| [TemplatesConfig](docs/project-client/models/TemplatesConfig.md)                           |             |
+| [TwilioConfigCollection](docs/project-client/models/TwilioConfigCollection.md)             |             |
+| [TwilioConfig](docs/project-client/models/TwilioConfig.md)                                 |             |
+| [TwilioConfigPayload](docs/project-client/models/TwilioConfigPayload.md)                   |             |
+| [WebpushConfigCollection](docs/project-client/models/WebpushConfigCollection.md)           |             |
+| [WebpushConfig](docs/project-client/models/WebpushConfig.md)                               |             |
+| [WebpushConfigPayload](docs/project-client/models/WebpushConfigPayload.md)                 |             |
+| [AccessTokenCollection](docs/project-client/models/AccessTokenCollection.md)               |             |
+| [AccessToken](docs/project-client/models/AccessToken.md)                                   |             |
+| [Links](docs/project-client/models/Links.md)                                               |             |
+| [CreateProjectTokenRequest](docs/project-client/models/CreateProjectTokenRequest.md)       |             |
+| [CreateTokenResponse](docs/project-client/models/CreateTokenResponse.md)                   |             |
+| [DiscardTokenResponse](docs/project-client/models/DiscardTokenResponse.md)                 |             |
+| [CreateUserTokenRequest](docs/project-client/models/CreateUserTokenRequest.md)             |             |
+| [DeliveryPlanCollection](docs/project-client/models/DeliveryPlanCollection.md)             |             |
+| [DeliveryPlan](docs/project-client/models/DeliveryPlan.md)                                 |             |
+| [Links](docs/project-client/models/Links.md)                                               |             |
+| [UserCollection](docs/project-client/models/UserCollection.md)                             |             |
+| [User](docs/project-client/models/User.md)                                                 |             |
+| [Links](docs/project-client/models/Links.md)                                               |             |
+
+</details>
+
+<!-- AUTO-GENERATED-CONTENT:END (project-client) -->
+
+# MagicBell JavaScript UserClient
+
+<!-- AUTO-GENERATED-CONTENT:START (user-client) -->
+
+## Authentication
+
+### Access Token Authentication
+
+The Client API uses an Access Token for authentication.
+
+This token must be provided to authenticate your requests to the API.
+
+#### Setting the Access Token
+
+When you initialize the SDK, you can set the access token as follows:
+
+```ts
+const sdk = new Client({ token: 'YOUR_TOKEN' });
+```
+
+If you need to set or update the access token after initializing the SDK, you can use:
+
+```ts
+const sdk = new Client();
+sdk.token = 'YOUR_TOKEN';
+```
+
+## Setting a Custom Timeout
+
+You can set a custom timeout for the SDK's HTTP requests as follows:
+
+```ts
+const client = new Client({ timeout: 10000 });
+```
+
+# Sample Usage
+
+Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
+
+```ts
+import { Client } from 'magicbell-js/user-client';
+
+(async () => {
+  const client = new Client({
+    token: 'YOUR_TOKEN',
+  });
+
+  const { data } = await client.channels.getInAppInboxTokens({
+    limit: 8,
+    startingAfter: 'starting_after',
+    endingBefore: 'ending_before',
+  });
+
+  console.log(data);
+})();
+```
+
+## Services
+
+The SDK provides various services to interact with the API.
+
+<details> 
+<summary>Below is a list of all available services with links to their detailed documentation:</summary>
+
+| Name                                                                      |
+| :------------------------------------------------------------------------ |
+| [ChannelsService](docs/user-client/services/ChannelsService.md)           |
+| [IntegrationsService](docs/user-client/services/IntegrationsService.md)   |
+| [NotificationsService](docs/user-client/services/NotificationsService.md) |
+
+</details>
+
+## Models
+
+The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
+
+<details> 
+<summary>Below is a list of all available models with links to their detailed documentation:</summary>
+
+| Name                                                                                            | Description |
+| :---------------------------------------------------------------------------------------------- | :---------- |
+| [InboxTokenResponseCollection](docs/user-client/models/InboxTokenResponseCollection.md)         |             |
+| [InboxTokenResponse](docs/user-client/models/InboxTokenResponse.md)                             |             |
+| [Links](docs/user-client/models/Links.md)                                                       |             |
+| [InboxToken](docs/user-client/models/InboxToken.md)                                             |             |
+| [DiscardResult](docs/user-client/models/DiscardResult.md)                                       |             |
+| [ApnsTokenCollection](docs/user-client/models/ApnsTokenCollection.md)                           |             |
+| [ApnsToken](docs/user-client/models/ApnsToken.md)                                               |             |
+| [ApnsTokenPayload](docs/user-client/models/ApnsTokenPayload.md)                                 |             |
+| [ExpoTokenCollection](docs/user-client/models/ExpoTokenCollection.md)                           |             |
+| [ExpoToken](docs/user-client/models/ExpoToken.md)                                               |             |
+| [ExpoTokenPayload](docs/user-client/models/ExpoTokenPayload.md)                                 |             |
+| [FcmTokenCollection](docs/user-client/models/FcmTokenCollection.md)                             |             |
+| [FcmToken](docs/user-client/models/FcmToken.md)                                                 |             |
+| [FcmTokenPayload](docs/user-client/models/FcmTokenPayload.md)                                   |             |
+| [SlackTokenCollection](docs/user-client/models/SlackTokenCollection.md)                         |             |
+| [SlackToken](docs/user-client/models/SlackToken.md)                                             |             |
+| [SlackTokenPayload](docs/user-client/models/SlackTokenPayload.md)                               |             |
+| [TeamsTokenCollection](docs/user-client/models/TeamsTokenCollection.md)                         |             |
+| [TeamsToken](docs/user-client/models/TeamsToken.md)                                             |             |
+| [TeamsTokenPayload](docs/user-client/models/TeamsTokenPayload.md)                               |             |
+| [WebPushTokenCollection](docs/user-client/models/WebPushTokenCollection.md)                     |             |
+| [WebPushToken](docs/user-client/models/WebPushToken.md)                                         |             |
+| [WebPushTokenPayload](docs/user-client/models/WebPushTokenPayload.md)                           |             |
+| [InboxConfigPayload](docs/user-client/models/InboxConfigPayload.md)                             |             |
+| [SlackInstallation](docs/user-client/models/SlackInstallation.md)                               |             |
+| [SlackFinishInstallResponse](docs/user-client/models/SlackFinishInstallResponse.md)             |             |
+| [SlackStartInstall](docs/user-client/models/SlackStartInstall.md)                               |             |
+| [SlackStartInstallResponseContent](docs/user-client/models/SlackStartInstallResponseContent.md) |             |
+| [TemplatesInstallation](docs/user-client/models/TemplatesInstallation.md)                       |             |
+| [WebPushTokenPayload](docs/user-client/models/WebPushTokenPayload.md)                           |             |
+| [WebPushStartInstallationResponse](docs/user-client/models/WebPushStartInstallationResponse.md) |             |
+| [NotificationCollection](docs/user-client/models/NotificationCollection.md)                     |             |
+| [Notification](docs/user-client/models/Notification.md)                                         |             |
+| [Links](docs/user-client/models/Links.md)                                                       |             |
+
+</details>
+
+<!-- AUTO-GENERATED-CONTENT:END (user-client) -->

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/project-client/http/client.d.ts

@@ -0,0 +1,15 @@
+import { CustomHook } from './hooks/custom-hook.js';
+import { Request } from './transport/request.js';
+import { HttpResponse, SdkConfig } from './types.js';
+export declare class HttpClient {
+    private config;
+    private readonly requestHandlerChain;
+    constructor(config: SdkConfig, hook?: CustomHook);
+    call<T>(request: Request): Promise<HttpResponse<T>>;
+    stream<T>(request: Request): AsyncGenerator<HttpResponse<T>>;
+    callPaginated<FullResponse, Page>(request: Request<Page>): Promise<HttpResponse<Page>>;
+    setBaseUrl(url: string): void;
+    setConfig(config: SdkConfig): void;
+    private getPage;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/commonjs/project-client/http/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/project-client/http/client.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAErD,qBAAa,UAAU;IAGT,OAAO,CAAC,MAAM;IAF1B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA6B;gBAE7C,MAAM,EAAE,SAAS,EAAE,IAAI,aAAmB;IAQ9D,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAI5C,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAItD,aAAa,CAAC,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAanG,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI7B,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAIlC,OAAO,CAAC,OAAO;CAoBhB"}

package/dist/commonjs/project-client/http/client.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = void 0;
+const handler_chain_js_1 = require("./handlers/handler-chain.js");
+const hook_handler_js_1 = require("./handlers/hook-handler.js");
+const request_validation_handler_js_1 = require("./handlers/request-validation-handler.js");
+const response_validation_handler_js_1 = require("./handlers/response-validation-handler.js");
+const retry_handler_js_1 = require("./handlers/retry-handler.js");
+const terminating_handler_js_1 = require("./handlers/terminating-handler.js");
+const custom_hook_js_1 = require("./hooks/custom-hook.js");
+class HttpClient {
+    constructor(config, hook = new custom_hook_js_1.CustomHook()) {
+        Object.defineProperty(this, "config", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: config
+        });
+        Object.defineProperty(this, "requestHandlerChain", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new handler_chain_js_1.RequestHandlerChain()
+        });
+        this.requestHandlerChain.addHandler(new response_validation_handler_js_1.ResponseValidationHandler());
+        this.requestHandlerChain.addHandler(new request_validation_handler_js_1.RequestValidationHandler());
+        this.requestHandlerChain.addHandler(new retry_handler_js_1.RetryHandler());
+        this.requestHandlerChain.addHandler(new hook_handler_js_1.HookHandler(hook));
+        this.requestHandlerChain.addHandler(new terminating_handler_js_1.TerminatingHandler());
+    }
+    call(request) {
+        return this.requestHandlerChain.callChain(request);
+    }
+    async *stream(request) {
+        yield* this.requestHandlerChain.streamChain(request);
+    }
+    async callPaginated(request) {
+        const response = await this.call(request);
+        if (!response.data) {
+            throw new Error('no response data to paginate through');
+        }
+        return {
+            ...response,
+            data: this.getPage(request, response.data),
+        };
+    }
+    setBaseUrl(url) {
+        this.config.baseUrl = url;
+    }
+    setConfig(config) {
+        this.config = config;
+    }
+    getPage(request, data) {
+        var _a, _b, _c, _d;
+        if (!request.pagination) {
+            throw new Error('getPage called for request without pagination property');
+        }
+        let curr = data;
+        for (const segment of ((_a = request.pagination) === null || _a === void 0 ? void 0 : _a.pagePath) || []) {
+            curr = curr[segment];
+        }
+        const page = (_c = (_b = request.pagination) === null || _b === void 0 ? void 0 : _b.pageSchema) === null || _c === void 0 ? void 0 : _c.parse(curr);
+        if (!page) {
+            throw new Error(`error getting page data. Curr: ${JSON.stringify(curr)}. PagePath: ${(_d = request.pagination) === null || _d === void 0 ? void 0 : _d.pagePath}. Data: ${JSON.stringify(data)}`);
+        }
+        return page;
+    }
+}
+exports.HttpClient = HttpClient;
+//# sourceMappingURL=client.js.map

package/dist/commonjs/project-client/http/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/project-client/http/client.ts"],"names":[],"mappings":";;;AAAA,kEAAkE;AAClE,gEAAyD;AACzD,4FAAoF;AACpF,8FAAsF;AACtF,kEAA2D;AAC3D,8EAAuE;AACvE,2DAAoD;AAIpD,MAAa,UAAU;IAGrB,YAAoB,MAAiB,EAAE,IAAI,GAAG,IAAI,2BAAU,EAAE;QAAlD;;;;mBAAQ,MAAM;WAAW;QAFpB;;;;mBAAsB,IAAI,sCAAmB,EAAE;WAAC;QAG/D,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,0DAAyB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,wDAAwB,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,+BAAY,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,6BAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,2CAAkB,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,CAAI,OAAgB;QACtB,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,CAAC,MAAM,CAAI,OAAgB;QAC/B,KAAK,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAqB,OAAsB;QACnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAe,OAAc,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO;YACL,GAAG,QAAQ;YACX,IAAI,EAAE,IAAI,CAAC,OAAO,CAAqB,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,GAAW;QACpB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED,SAAS,CAAC,MAAiB;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEO,OAAO,CAAqB,OAAsB,EAAE,IAAkB;;QAC5E,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,CAAA,MAAA,OAAO,CAAC,UAAU,0CAAE,QAAQ,KAAI,EAAE,EAAE,CAAC;YACzD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAED,MAAM,IAAI,GAAG,MAAA,MAAA,OAAO,CAAC,UAAU,0CAAE,UAAU,0CAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACb,kCAAkC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eACpD,MAAA,OAAO,CAAC,UAAU,0CAAE,QACtB,WAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAClC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5DD,gCA4DC"}

package/dist/commonjs/project-client/http/environment.d.ts

@@ -0,0 +1,4 @@
+export declare enum Environment {
+    DEFAULT = "https://petstore.swagger.io/v2"
+}
+//# sourceMappingURL=environment.d.ts.map

package/dist/commonjs/project-client/http/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../../src/project-client/http/environment.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW;IACrB,OAAO,mCAAmC;CAC3C"}

package/dist/commonjs/project-client/http/environment.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Environment = void 0;
+var Environment;
+(function (Environment) {
+    Environment["DEFAULT"] = "https://petstore.swagger.io/v2";
+})(Environment || (exports.Environment = Environment = {}));
+//# sourceMappingURL=environment.js.map

package/dist/commonjs/project-client/http/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../../src/project-client/http/environment.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAEX;AAFD,WAAY,WAAW;IACrB,yDAA0C,CAAA;AAC5C,CAAC,EAFW,WAAW,2BAAX,WAAW,QAEtB"}

package/dist/commonjs/project-client/http/error.d.ts

@@ -0,0 +1,8 @@
+import { HttpMetadata } from './types.js';
+export declare class HttpError extends Error {
+    readonly error: string;
+    readonly metadata: HttpMetadata;
+    readonly raw?: ArrayBuffer;
+    constructor(metadata: HttpMetadata, raw?: ArrayBuffer, error?: string);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/commonjs/project-client/http/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../src/project-client/http/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,qBAAa,SAAU,SAAQ,KAAK;IAClC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,SAAgB,GAAG,CAAC,EAAE,WAAW,CAAC;gBAEtB,QAAQ,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM;CAMtE"}