Skip to content

Commit 5d113d4

Browse files
authored
Merge pull request #36 from apideck-libraries/speakeasy-sdk-regen-1743420867
chore: 🐝 Update SDK - Generate 0.21.0
2 parents 99e1cee + bb27f43 commit 5d113d4

File tree

447 files changed

+11936
-4413
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

447 files changed

+11936
-4413
lines changed

.speakeasy/gen.lock

Lines changed: 385 additions & 104 deletions
Large diffs are not rendered by default.

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ generation:
1818
oAuth2ClientCredentialsEnabled: true
1919
oAuth2PasswordEnabled: true
2020
typescript:
21-
version: 0.20.1
21+
version: 0.21.0
2222
additionalDependencies:
2323
dependencies: {}
2424
devDependencies: {}

.speakeasy/workflow.lock

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.523.0
1+
speakeasyVersion: 1.529.1
22
sources:
33
Apideck-OAS:
44
sourceNamespace: apideck-oas
5-
sourceRevisionDigest: sha256:19bcc0c88a46e37273f9a3c83a8cd769dded5dde226642447daf5758de511a91
6-
sourceBlobDigest: sha256:53708e30587d09cdcd934b6c7bf237861ff24b79984d14715567cda1bfe57379
5+
sourceRevisionDigest: sha256:7873299d787f9b94492230daf8f25de03db6ea28195d6af54e6c8a33024f069e
6+
sourceBlobDigest: sha256:129f9bc0d8b29efd7db3b87ac4fe87de06d8bc3060a12340799861913382fe05
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1741788466
10-
- 10.12.4
9+
- speakeasy-sdk-regen-1743420867
10+
- 10.14.1
1111
targets:
1212
apideck:
1313
source: Apideck-OAS
1414
sourceNamespace: apideck-oas
15-
sourceRevisionDigest: sha256:19bcc0c88a46e37273f9a3c83a8cd769dded5dde226642447daf5758de511a91
16-
sourceBlobDigest: sha256:53708e30587d09cdcd934b6c7bf237861ff24b79984d14715567cda1bfe57379
15+
sourceRevisionDigest: sha256:7873299d787f9b94492230daf8f25de03db6ea28195d6af54e6c8a33024f069e
16+
sourceBlobDigest: sha256:129f9bc0d8b29efd7db3b87ac4fe87de06d8bc3060a12340799861913382fe05
1717
codeSamplesNamespace: apideck-oas-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:4461acba57e911414c93de7b4a9d857dc7c8fc411db2134000df789df0942c95
18+
codeSamplesRevisionDigest: sha256:08847a8c8b5e51a4eab887a6ff673ba6ab6f1a69ffd7fec39f16a431ce769721
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

README.md

Lines changed: 68 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ For more information about the API: [Apideck Developer Docs](https://developers.
2828
* [Available Resources and Operations](#available-resources-and-operations)
2929
* [Standalone functions](#standalone-functions)
3030
* [Pagination](#pagination)
31+
* [File uploads](#file-uploads)
3132
* [Retries](#retries)
3233
* [Error Handling](#error-handling)
3334
* [Server Selection](#server-selection)
@@ -129,13 +130,18 @@ run();
129130
### [accounting](docs/sdks/accounting/README.md)
130131

131132

133+
#### [accounting.agedCreditors](docs/sdks/agedcreditors/README.md)
134+
135+
* [get](docs/sdks/agedcreditors/README.md#get) - Get Aged Creditors
136+
132137
#### [accounting.agedDebtors](docs/sdks/ageddebtors/README.md)
133138

134139
* [get](docs/sdks/ageddebtors/README.md#get) - Get Aged Debtors
135140

136141
#### [accounting.attachments](docs/sdks/attachments/README.md)
137142

138143
* [list](docs/sdks/attachments/README.md#list) - List Attachments
144+
* [upload](docs/sdks/attachments/README.md#upload) - Upload attachment
139145
* [get](docs/sdks/attachments/README.md#get) - Get Attachment
140146
* [delete](docs/sdks/attachments/README.md#delete) - Delete Attachment
141147
* [download](docs/sdks/attachments/README.md#download) - Download Attachment
@@ -396,6 +402,10 @@ run();
396402
#### [crm.pipelines](docs/sdks/pipelines/README.md)
397403

398404
* [list](docs/sdks/pipelines/README.md#list) - List pipelines
405+
* [create](docs/sdks/pipelines/README.md#create) - Create pipeline
406+
* [get](docs/sdks/pipelines/README.md#get) - Get pipeline
407+
* [update](docs/sdks/pipelines/README.md#update) - Update pipeline
408+
* [delete](docs/sdks/pipelines/README.md#delete) - Delete pipeline
399409

400410
#### [crm.users](docs/sdks/users/README.md)
401411

@@ -476,6 +486,7 @@ run();
476486

477487
* [create](docs/sdks/uploadsessions/README.md#create) - Start Upload Session
478488
* [get](docs/sdks/uploadsessions/README.md#get) - Get Upload Session
489+
* [upload](docs/sdks/uploadsessions/README.md#upload) - Upload part of File to Upload Session
479490
* [delete](docs/sdks/uploadsessions/README.md#delete) - Abort Upload Session
480491
* [finish](docs/sdks/uploadsessions/README.md#finish) - Finish Upload Session
481492

@@ -662,11 +673,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
662673

663674
<summary>Available standalone functions</summary>
664675

676+
- [`accountingAgedCreditorsGet`](docs/sdks/agedcreditors/README.md#get) - Get Aged Creditors
665677
- [`accountingAgedDebtorsGet`](docs/sdks/ageddebtors/README.md#get) - Get Aged Debtors
666678
- [`accountingAttachmentsDelete`](docs/sdks/attachments/README.md#delete) - Delete Attachment
667679
- [`accountingAttachmentsDownload`](docs/sdks/attachments/README.md#download) - Download Attachment
668680
- [`accountingAttachmentsGet`](docs/sdks/attachments/README.md#get) - Get Attachment
669681
- [`accountingAttachmentsList`](docs/sdks/attachments/README.md#list) - List Attachments
682+
- [`accountingAttachmentsUpload`](docs/sdks/attachments/README.md#upload) - Upload attachment
670683
- [`accountingBalanceSheetGet`](docs/sdks/balancesheet/README.md#get) - Get BalanceSheet
671684
- [`accountingBillPaymentsCreate`](docs/sdks/billpayments/README.md#create) - Create Bill Payment
672685
- [`accountingBillPaymentsDelete`](docs/sdks/billpayments/README.md#delete) - Delete Bill Payment
@@ -805,7 +818,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
805818
- [`crmOpportunitiesGet`](docs/sdks/opportunities/README.md#get) - Get opportunity
806819
- [`crmOpportunitiesList`](docs/sdks/opportunities/README.md#list) - List opportunities
807820
- [`crmOpportunitiesUpdate`](docs/sdks/opportunities/README.md#update) - Update opportunity
821+
- [`crmPipelinesCreate`](docs/sdks/pipelines/README.md#create) - Create pipeline
822+
- [`crmPipelinesDelete`](docs/sdks/pipelines/README.md#delete) - Delete pipeline
823+
- [`crmPipelinesGet`](docs/sdks/pipelines/README.md#get) - Get pipeline
808824
- [`crmPipelinesList`](docs/sdks/pipelines/README.md#list) - List pipelines
825+
- [`crmPipelinesUpdate`](docs/sdks/pipelines/README.md#update) - Update pipeline
809826
- [`crmUsersCreate`](docs/sdks/users/README.md#create) - Create user
810827
- [`crmUsersDelete`](docs/sdks/users/README.md#delete) - Delete user
811828
- [`crmUsersGet`](docs/sdks/users/README.md#get) - Get user
@@ -849,6 +866,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
849866
- [`fileStorageUploadSessionsDelete`](docs/sdks/uploadsessions/README.md#delete) - Abort Upload Session
850867
- [`fileStorageUploadSessionsFinish`](docs/sdks/uploadsessions/README.md#finish) - Finish Upload Session
851868
- [`fileStorageUploadSessionsGet`](docs/sdks/uploadsessions/README.md#get) - Get Upload Session
869+
- [`fileStorageUploadSessionsUpload`](docs/sdks/uploadsessions/README.md#upload) - Upload part of File to Upload Session
852870
- [`hrisCompaniesCreate`](docs/sdks/apideckcompanies/README.md#create) - Create Company
853871
- [`hrisCompaniesDelete`](docs/sdks/apideckcompanies/README.md#delete) - Delete Company
854872
- [`hrisCompaniesGet`](docs/sdks/apideckcompanies/README.md#get) - Get Company
@@ -973,6 +991,49 @@ run();
973991
```
974992
<!-- End Pagination [pagination] -->
975993

994+
<!-- Start File uploads [file-upload] -->
995+
## File uploads
996+
997+
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
998+
999+
> [!TIP]
1000+
>
1001+
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
1002+
>
1003+
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
1004+
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
1005+
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
1006+
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
1007+
1008+
```typescript
1009+
import { Apideck } from "@apideck/unify";
1010+
import { openAsBlob } from "node:fs";
1011+
1012+
const apideck = new Apideck({
1013+
apiKey: process.env["APIDECK_API_KEY"] ?? "",
1014+
consumerId: "test-consumer",
1015+
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
1016+
});
1017+
1018+
async function run() {
1019+
const result = await apideck.accounting.attachments.upload({
1020+
referenceType: "invoice",
1021+
referenceId: "123456",
1022+
xApideckMetadata:
1023+
"{\"name\":\"document.pdf\",\"description\":\"Invoice attachment\"}",
1024+
serviceId: "salesforce",
1025+
requestBody: await openAsBlob("example.file"),
1026+
});
1027+
1028+
// Handle the result
1029+
console.log(result);
1030+
}
1031+
1032+
run();
1033+
1034+
```
1035+
<!-- End File uploads [file-upload] -->
1036+
9761037
<!-- Start Retries [retries] -->
9771038
## Retries
9781039

@@ -1234,6 +1295,7 @@ run();
12341295
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
12351296
```typescript
12361297
import { Apideck } from "@apideck/unify";
1298+
import { openAsBlob } from "node:fs";
12371299

12381300
const apideck = new Apideck({
12391301
apiKey: process.env["APIDECK_API_KEY"] ?? "",
@@ -1242,58 +1304,13 @@ const apideck = new Apideck({
12421304
});
12431305

12441306
async function run() {
1245-
const result = await apideck.fileStorage.uploadSessions.create({
1307+
const result = await apideck.accounting.attachments.upload({
1308+
referenceType: "invoice",
1309+
referenceId: "123456",
1310+
xApideckMetadata:
1311+
"{\"name\":\"document.pdf\",\"description\":\"Invoice attachment\"}",
12461312
serviceId: "salesforce",
1247-
createUploadSessionRequest: {
1248-
name: "Documents",
1249-
parentFolderId: "1234",
1250-
driveId: "1234",
1251-
size: 1810673,
1252-
passThrough: [
1253-
{
1254-
serviceId: "<id>",
1255-
extendPaths: [
1256-
{
1257-
path: "$.nested.property",
1258-
value: {
1259-
"TaxClassificationRef": {
1260-
"value": "EUC-99990201-V1-00020000",
1261-
},
1262-
},
1263-
},
1264-
{
1265-
path: "$.nested.property",
1266-
value: {
1267-
"TaxClassificationRef": {
1268-
"value": "EUC-99990201-V1-00020000",
1269-
},
1270-
},
1271-
},
1272-
],
1273-
},
1274-
{
1275-
serviceId: "<id>",
1276-
extendPaths: [
1277-
{
1278-
path: "$.nested.property",
1279-
value: {
1280-
"TaxClassificationRef": {
1281-
"value": "EUC-99990201-V1-00020000",
1282-
},
1283-
},
1284-
},
1285-
{
1286-
path: "$.nested.property",
1287-
value: {
1288-
"TaxClassificationRef": {
1289-
"value": "EUC-99990201-V1-00020000",
1290-
},
1291-
},
1292-
},
1293-
],
1294-
},
1295-
],
1296-
},
1313+
requestBody: await openAsBlob("example.file"),
12971314
}, {
12981315
serverURL: "https://upload.apideck.com",
12991316
});

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,4 +208,14 @@ Based on:
208208
### Generated
209209
- [typescript v0.20.1] .
210210
### Releases
211-
- [NPM v0.20.1] https://www.npmjs.com/package/@apideck/unify/v/0.20.1 - .
211+
- [NPM v0.20.1] https://www.npmjs.com/package/@apideck/unify/v/0.20.1 - .
212+
213+
## 2025-04-04 11:59:26
214+
### Changes
215+
Based on:
216+
- OpenAPI Doc
217+
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
218+
### Generated
219+
- [typescript v0.21.0] .
220+
### Releases
221+
- [NPM v0.21.0] https://www.npmjs.com/package/@apideck/unify/v/0.21.0 - .

docs/models/components/activity.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,7 @@ let value: Activity = {
8080
id: "2389328923893298",
8181
name: "employee_level",
8282
description: "Employee Level",
83-
value: [
84-
{},
85-
],
83+
value: 10,
8684
},
8785
],
8886
attendees: [

docs/models/components/activityinput.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,9 @@ let value: ActivityInput = {
7777
id: "2389328923893298",
7878
name: "employee_level",
7979
description: "Employee Level",
80-
value: 10,
80+
value: [
81+
"<value>",
82+
],
8183
},
8284
],
8385
attendees: [
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# AgedCreditors
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { AgedCreditors } from "@apideck/unify/models/components";
7+
import { RFCDate } from "@apideck/unify/types";
8+
9+
let value: AgedCreditors = {
10+
reportGeneratedAt: new Date("2024-11-14T12:00:00.000Z"),
11+
reportAsOfDate: new RFCDate("2024-11-13"),
12+
outstandingBalances: [
13+
{
14+
supplierId: "123",
15+
supplierName: "Super Store",
16+
outstandingBalancesByCurrency: [
17+
{
18+
currency: "USD",
19+
balancesByPeriod: [
20+
{
21+
startDate: new RFCDate("2024-01-01"),
22+
endDate: new RFCDate("2024-01-30"),
23+
totalAmount: 1500,
24+
balancesByTransaction: [
25+
{
26+
transactionId: "INV-1001",
27+
transactionDate: new RFCDate("2024-01-15"),
28+
transactionType: "invoice",
29+
dueDate: new RFCDate("2024-02-15"),
30+
originalAmount: 1000,
31+
outstandingBalance: 800,
32+
transactionNumber: "INV-1001",
33+
},
34+
],
35+
},
36+
],
37+
},
38+
],
39+
},
40+
],
41+
};
42+
```
43+
44+
## Fields
45+
46+
| Field | Type | Required | Description | Example |
47+
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
48+
| `reportGeneratedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The exact date and time the report was generated. | 2024-11-14T12:00:00.000Z |
49+
| `reportAsOfDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The cutoff date for transactions included in the report. | 2024-11-13 |
50+
| `periodCount` | *number* | :heavy_minus_sign: | Number of aging periods shown in the report. | 4 |
51+
| `periodLength` | *number* | :heavy_minus_sign: | Length of each aging period in days. | 30 |
52+
| `outstandingBalances` | [components.OutstandingBalanceBySupplier](../../models/components/outstandingbalancebysupplier.md)[] | :heavy_minus_sign: | N/A | |

docs/models/components/allocationtype.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Type of entity this payment should be attributed to.
77
```typescript
88
import { AllocationType } from "@apideck/unify/models/components";
99

10-
let value: AllocationType = "credit_memo";
10+
let value: AllocationType = "invoice";
1111
```
1212

1313
## Values

docs/models/components/allowactions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
```typescript
66
import { AllowActions } from "@apideck/unify/models/components";
77

8-
let value: AllowActions = "delete";
8+
let value: AllowActions = "disable";
99
```
1010

1111
## Values

0 commit comments

Comments
 (0)