@naturalpay/sdk 1.1.0 → 1.2.1

package/reference.md

@@ -830,7 +830,7 @@ await client.customers.get({
 <dl>
 <dd>
 
-List pending customer invitations
+List pending invitations addressed to specific customers
 </dd>
 </dl>
 </dd>
@@ -893,7 +893,7 @@ await client.customers.listInvitations();
 <dl>
 <dd>
 
-Invite customers to connect with an agent
+Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits
 </dd>
 </dl>
 </dd>
@@ -972,7 +972,7 @@ await client.customers.createInvitations({
 <dl>
 <dd>
 
-Revoke a pending customer invitation
+Revoke a pending invitation addressed to a specific customer, so it can no longer be accepted
 </dd>
 </dl>
 </dd>
@@ -1087,6 +1087,272 @@ await client.customers.revokeAgent({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Invitation Links
+<details><summary><code>client.invitationLinks.<a href="/src/api/resources/invitationLinks/client/Client.ts">list</a>({ ...params }) -> Natural.ListInvitationLinksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List the invitation links you have created, with masked tokens
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.invitationLinks.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.ListInvitationLinksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `InvitationLinksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.invitationLinks.<a href="/src/api/resources/invitationLinks/client/Client.ts">create</a>({ ...params }) -> Natural.CreateInvitationLinksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.invitationLinks.create({
+    proposedAgents: [{
+            agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
+            permissions: ["payments.create"],
+            limits: {
+                perTransaction: 50000
+            }
+        }],
+    name: "Carrier Payment Integration"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CreateInvitationLinksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `InvitationLinksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.invitationLinks.<a href="/src/api/resources/invitationLinks/client/Client.ts">get</a>({ ...params }) -> Natural.GetInvitationLinksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get an invitation link and its offered agents, with a masked token
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.invitationLinks.get({
+    linkId: "linkId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.GetInvitationLinksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `InvitationLinksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.invitationLinks.<a href="/src/api/resources/invitationLinks/client/Client.ts">revoke</a>({ ...params }) -> Natural.RevokeInvitationLinksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Revoke an invitation link so it stops connecting new customers
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.invitationLinks.revoke({
+    linkId: "linkId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.RevokeInvitationLinksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `InvitationLinksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3658,7 +3924,7 @@ await client.wallets.update({
 <dl>
 <dd>
 
-Make a wallet the default. Payments sent to the party's email, phone number, or handle land in the default wallet.
+Set the party's default wallet, where payments addressed to their email, phone number, or handle land
 </dd>
 </dl>
 </dd>
@@ -5477,3 +5743,602 @@ await client.events.get({
 </dl>
 </details>
 
+## Simulations
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">inviteCustomer</a>({ ...params }) -> Natural.InviteCustomerSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a test customer and a pending invitation for each agent you name
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.inviteCustomer({
+    idempotencyKey: "Idempotency-Key",
+    agentIds: ["agt_550e8400e29b41d4a716446655440000"],
+    type: "ORG"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.InviteCustomerSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">fundCustomer</a>({ ...params }) -> Natural.FundCustomerSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Add test funds to a connected customer's wallet
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.fundCustomer({
+    idempotencyKey: "Idempotency-Key",
+    customerId: "customerId",
+    amount: 250000,
+    currency: "USD"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.FundCustomerSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">linkExternalAccount</a>({ ...params }) -> Natural.LinkExternalAccountSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Link a test bank account to your own party
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.linkExternalAccount({
+    idempotencyKey: "Idempotency-Key"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.LinkExternalAccountSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">completePaymentClaim</a>({ ...params }) -> Natural.CompletePaymentClaimSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Simulate the recipient of a held payment joining Natural and receiving the funds
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.completePaymentClaim({
+    paymentId: "paymentId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CompletePaymentClaimSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">fulfillPaymentRequest</a>({ ...params }) -> Natural.FulfillPaymentRequestSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fulfill an open payment request addressed to your test payer
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.fulfillPaymentRequest({
+    idempotencyKey: "Idempotency-Key",
+    paymentRequestId: "paymentRequestId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.FulfillPaymentRequestSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">declinePaymentRequest</a>({ ...params }) -> Natural.DeclinePaymentRequestSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Decline an open payment request addressed to your test payer
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.declinePaymentRequest({
+    idempotencyKey: "Idempotency-Key",
+    paymentRequestId: "paymentRequestId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.DeclinePaymentRequestSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">acceptCustomerInvitation</a>({ ...params }) -> Natural.AcceptCustomerInvitationSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Accept a pending customer invitation as the test customer it is addressed to
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.acceptCustomerInvitation({
+    idempotencyKey: "Idempotency-Key",
+    invitationId: "invitationId",
+    partyId: "pty_7c9e6679e29b41d4a716446655440001"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.AcceptCustomerInvitationSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">declineCustomerInvitation</a>({ ...params }) -> Natural.DeclineCustomerInvitationSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Decline a pending customer invitation as the test customer it is addressed to
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.declineCustomerInvitation({
+    idempotencyKey: "Idempotency-Key",
+    invitationId: "invitationId",
+    partyId: "pty_7c9e6679e29b41d4a716446655440001"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.DeclineCustomerInvitationSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">revokeAgentConnection</a>({ ...params }) -> Natural.RevokeAgentConnectionSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Remove an agent's access to a test customer, acting as the customer
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.revokeAgentConnection({
+    idempotencyKey: "Idempotency-Key",
+    customerId: "customerId",
+    agentId: "agentId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.RevokeAgentConnectionSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+