Merge pull request #15 from clear-street/release-please--branches--ma…

…in--changes--next--components--studio-sdk

release: 0.1.0-alpha.4

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.3"
+  ".": "0.1.0-alpha.4"
 }

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.4 (2024-07-10)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/clear-street/studio-sdk-node/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+### Features
+
+* **api:** update via SDK Studio ([#14](https://github.com/clear-street/studio-sdk-node/issues/14)) ([e36f6f4](https://github.com/clear-street/studio-sdk-node/commit/e36f6f4ec4d991bc59513570285b00edf4847262))
+
 ## 0.1.0-alpha.3 (2024-07-10)
 
 Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/clear-street/studio-sdk-node/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)

README.md

@@ -25,7 +25,7 @@ import StudioSDK from '@clear-street/studio-sdk';
 const studioSDK = new StudioSDK();
 
 async function main() {
-  const entity = await studioSDK.entities.retrieve('REPLACE_ME');
+  const entity = await studioSDK.entities.retrieve('<your-entity-id>');
 
   console.log(entity.entity_id);
 }
@@ -44,7 +44,7 @@ import StudioSDK from '@clear-street/studio-sdk';
 const studioSDK = new StudioSDK();
 
 async function main() {
-  const entity: StudioSDK.Entity = await studioSDK.entities.retrieve('REPLACE_ME');
+  const entity: StudioSDK.Entity = await studioSDK.entities.retrieve('<your-entity-id>');
 }
 
 main();
@@ -61,7 +61,7 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 async function main() {
-  const entity = await studioSDK.entities.retrieve('REPLACE_ME').catch(async (err) => {
+  const entity = await studioSDK.entities.retrieve('<your-entity-id>').catch(async (err) => {
     if (err instanceof StudioSDK.APIError) {
       console.log(err.status); // 400
       console.log(err.name); // BadRequestError
@@ -104,7 +104,7 @@ const studioSDK = new StudioSDK({
 });
 
 // Or, configure per-request:
-await studioSDK.entities.retrieve('REPLACE_ME', {
+await studioSDK.entities.retrieve('<your-entity-id>', {
   maxRetries: 5,
 });
 ```
@@ -121,7 +121,7 @@ const studioSDK = new StudioSDK({
 });
 
 // Override per-request:
-await studioSDK.entities.retrieve('REPLACE_ME', {
+await studioSDK.entities.retrieve('<your-entity-id>', {
   timeout: 5 * 1000,
 });
 ```
@@ -142,11 +142,11 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 ```ts
 const studioSDK = new StudioSDK();
 
-const response = await studioSDK.entities.retrieve('REPLACE_ME').asResponse();
+const response = await studioSDK.entities.retrieve('<your-entity-id>').asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: entity, response: raw } = await studioSDK.entities.retrieve('REPLACE_ME').withResponse();
+const { data: entity, response: raw } = await studioSDK.entities.retrieve('<your-entity-id>').withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(entity.entity_id);
 ```
@@ -252,7 +252,7 @@ const studioSDK = new StudioSDK({
 });
 
 // Override per-request:
-await studioSDK.entities.retrieve('REPLACE_ME', {
+await studioSDK.entities.retrieve('<your-entity-id>', {
   httpAgent: new http.Agent({ keepAlive: false }),
 });
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clear-street/studio-sdk",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.4",
   "description": "The official TypeScript library for the Studio SDK API",
   "author": "Studio SDK <[email protected]>",
   "types": "dist/index.d.ts",

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.3'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.4'; // x-release-please-version