@paid-ai/paid-node 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +7 -2
- package/dist/cjs/api/resources/checkouts/client/requests/CreateCheckoutRequest.d.ts +2 -0
- package/dist/cjs/api/resources/customers/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/customers/client/Client.js +6 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/valueReceipts/client/Client.d.ts +75 -0
- package/dist/cjs/api/resources/valueReceipts/client/Client.js +347 -0
- package/dist/cjs/api/resources/valueReceipts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/valueReceipts/client/index.js +17 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.d.ts +10 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/valueReceipts/index.d.ts +1 -0
- package/dist/cjs/api/resources/valueReceipts/index.js +17 -0
- package/dist/cjs/api/types/Checkout.d.ts +1 -0
- package/dist/cjs/api/types/ValueReceiptDetail.d.ts +19 -0
- package/dist/cjs/api/types/ValueReceiptDetail.js +3 -0
- package/dist/cjs/api/types/ValueReceiptListResponse.d.ts +5 -0
- package/dist/cjs/api/types/ValueReceiptListResponse.js +3 -0
- package/dist/cjs/api/types/ValueReceiptSummary.d.ts +16 -0
- package/dist/cjs/api/types/ValueReceiptSummary.js +3 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/resources/checkouts/client/requests/CreateCheckoutRequest.d.mts +2 -0
- package/dist/esm/api/resources/customers/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/customers/client/Client.mjs +6 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/Client.d.mts +75 -0
- package/dist/esm/api/resources/valueReceipts/client/Client.mjs +310 -0
- package/dist/esm/api/resources/valueReceipts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/valueReceipts/client/index.mjs +1 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.d.mts +10 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.d.mts +10 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/valueReceipts/index.d.mts +1 -0
- package/dist/esm/api/resources/valueReceipts/index.mjs +1 -0
- package/dist/esm/api/types/Checkout.d.mts +1 -0
- package/dist/esm/api/types/ValueReceiptDetail.d.mts +19 -0
- package/dist/esm/api/types/ValueReceiptDetail.mjs +2 -0
- package/dist/esm/api/types/ValueReceiptListResponse.d.mts +5 -0
- package/dist/esm/api/types/ValueReceiptListResponse.mjs +2 -0
- package/dist/esm/api/types/ValueReceiptSummary.d.mts +16 -0
- package/dist/esm/api/types/ValueReceiptSummary.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +259 -0
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export type { GetValueReceiptByIdRequest } from "./GetValueReceiptByIdRequest.mjs";
|
|
2
|
+
export type { ListValueReceiptsRequest } from "./ListValueReceiptsRequest.mjs";
|
|
3
|
+
export type { PublishValueReceiptBody } from "./PublishValueReceiptBody.mjs";
|
|
4
|
+
export type { UnpublishValueReceiptRequest } from "./UnpublishValueReceiptRequest.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export interface ValueReceiptDetail {
|
|
2
|
+
id: string;
|
|
3
|
+
status: string;
|
|
4
|
+
publicUrlToken: string;
|
|
5
|
+
publicUrl: string;
|
|
6
|
+
isPublished: boolean;
|
|
7
|
+
customerId: string | null;
|
|
8
|
+
customerName: string | null;
|
|
9
|
+
customerExternalId: string | null;
|
|
10
|
+
orderId: string | null;
|
|
11
|
+
currency: string;
|
|
12
|
+
startDate: string | null;
|
|
13
|
+
endDate: string | null;
|
|
14
|
+
totalDeliveredValue: number | null;
|
|
15
|
+
createdAt: string;
|
|
16
|
+
publishedAt: string | null;
|
|
17
|
+
publishExpiresAt: string | null;
|
|
18
|
+
allowEmbed: boolean;
|
|
19
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export interface ValueReceiptSummary {
|
|
2
|
+
id: string;
|
|
3
|
+
status: string;
|
|
4
|
+
publicUrlToken: string;
|
|
5
|
+
publicUrl: string;
|
|
6
|
+
isPublished: boolean;
|
|
7
|
+
customerId: string | null;
|
|
8
|
+
customerName: string | null;
|
|
9
|
+
customerExternalId: string | null;
|
|
10
|
+
orderId: string | null;
|
|
11
|
+
currency: string;
|
|
12
|
+
startDate: string | null;
|
|
13
|
+
endDate: string | null;
|
|
14
|
+
totalDeliveredValue: number | null;
|
|
15
|
+
createdAt: string;
|
|
16
|
+
}
|
|
@@ -43,3 +43,6 @@ export * from "./Signal.mjs";
|
|
|
43
43
|
export * from "./UpdateContactRequest.mjs";
|
|
44
44
|
export * from "./UpdateCustomerRequest.mjs";
|
|
45
45
|
export * from "./UpdateProductRequest.mjs";
|
|
46
|
+
export * from "./ValueReceiptDetail.mjs";
|
|
47
|
+
export * from "./ValueReceiptListResponse.mjs";
|
|
48
|
+
export * from "./ValueReceiptSummary.mjs";
|
|
@@ -43,3 +43,6 @@ export * from "./Signal.mjs";
|
|
|
43
43
|
export * from "./UpdateContactRequest.mjs";
|
|
44
44
|
export * from "./UpdateCustomerRequest.mjs";
|
|
45
45
|
export * from "./UpdateProductRequest.mjs";
|
|
46
|
+
export * from "./ValueReceiptDetail.mjs";
|
|
47
|
+
export * from "./ValueReceiptListResponse.mjs";
|
|
48
|
+
export * from "./ValueReceiptSummary.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.2.
|
|
1
|
+
export declare const SDK_VERSION = "1.2.1";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.2.
|
|
1
|
+
export const SDK_VERSION = "1.2.1";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -2660,6 +2660,265 @@ await client.customerPortals.createCustomerPortal();
|
|
|
2660
2660
|
</dl>
|
|
2661
2661
|
|
|
2662
2662
|
|
|
2663
|
+
</dd>
|
|
2664
|
+
</dl>
|
|
2665
|
+
</details>
|
|
2666
|
+
|
|
2667
|
+
## ValueReceipts
|
|
2668
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">listValueReceipts</a>({ ...params }) -> Paid.ValueReceiptListResponse</code></summary>
|
|
2669
|
+
<dl>
|
|
2670
|
+
<dd>
|
|
2671
|
+
|
|
2672
|
+
#### 📝 Description
|
|
2673
|
+
|
|
2674
|
+
<dl>
|
|
2675
|
+
<dd>
|
|
2676
|
+
|
|
2677
|
+
<dl>
|
|
2678
|
+
<dd>
|
|
2679
|
+
|
|
2680
|
+
List value receipts for the organization
|
|
2681
|
+
</dd>
|
|
2682
|
+
</dl>
|
|
2683
|
+
</dd>
|
|
2684
|
+
</dl>
|
|
2685
|
+
|
|
2686
|
+
#### 🔌 Usage
|
|
2687
|
+
|
|
2688
|
+
<dl>
|
|
2689
|
+
<dd>
|
|
2690
|
+
|
|
2691
|
+
<dl>
|
|
2692
|
+
<dd>
|
|
2693
|
+
|
|
2694
|
+
```typescript
|
|
2695
|
+
await client.valueReceipts.listValueReceipts();
|
|
2696
|
+
|
|
2697
|
+
```
|
|
2698
|
+
</dd>
|
|
2699
|
+
</dl>
|
|
2700
|
+
</dd>
|
|
2701
|
+
</dl>
|
|
2702
|
+
|
|
2703
|
+
#### ⚙️ Parameters
|
|
2704
|
+
|
|
2705
|
+
<dl>
|
|
2706
|
+
<dd>
|
|
2707
|
+
|
|
2708
|
+
<dl>
|
|
2709
|
+
<dd>
|
|
2710
|
+
|
|
2711
|
+
**request:** `Paid.ListValueReceiptsRequest`
|
|
2712
|
+
|
|
2713
|
+
</dd>
|
|
2714
|
+
</dl>
|
|
2715
|
+
|
|
2716
|
+
<dl>
|
|
2717
|
+
<dd>
|
|
2718
|
+
|
|
2719
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
2720
|
+
|
|
2721
|
+
</dd>
|
|
2722
|
+
</dl>
|
|
2723
|
+
</dd>
|
|
2724
|
+
</dl>
|
|
2725
|
+
|
|
2726
|
+
|
|
2727
|
+
</dd>
|
|
2728
|
+
</dl>
|
|
2729
|
+
</details>
|
|
2730
|
+
|
|
2731
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">getValueReceiptById</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
2732
|
+
<dl>
|
|
2733
|
+
<dd>
|
|
2734
|
+
|
|
2735
|
+
#### 📝 Description
|
|
2736
|
+
|
|
2737
|
+
<dl>
|
|
2738
|
+
<dd>
|
|
2739
|
+
|
|
2740
|
+
<dl>
|
|
2741
|
+
<dd>
|
|
2742
|
+
|
|
2743
|
+
Get a value receipt by ID, including its publish/share state.
|
|
2744
|
+
</dd>
|
|
2745
|
+
</dl>
|
|
2746
|
+
</dd>
|
|
2747
|
+
</dl>
|
|
2748
|
+
|
|
2749
|
+
#### 🔌 Usage
|
|
2750
|
+
|
|
2751
|
+
<dl>
|
|
2752
|
+
<dd>
|
|
2753
|
+
|
|
2754
|
+
<dl>
|
|
2755
|
+
<dd>
|
|
2756
|
+
|
|
2757
|
+
```typescript
|
|
2758
|
+
await client.valueReceipts.getValueReceiptById({
|
|
2759
|
+
id: "id"
|
|
2760
|
+
});
|
|
2761
|
+
|
|
2762
|
+
```
|
|
2763
|
+
</dd>
|
|
2764
|
+
</dl>
|
|
2765
|
+
</dd>
|
|
2766
|
+
</dl>
|
|
2767
|
+
|
|
2768
|
+
#### ⚙️ Parameters
|
|
2769
|
+
|
|
2770
|
+
<dl>
|
|
2771
|
+
<dd>
|
|
2772
|
+
|
|
2773
|
+
<dl>
|
|
2774
|
+
<dd>
|
|
2775
|
+
|
|
2776
|
+
**request:** `Paid.GetValueReceiptByIdRequest`
|
|
2777
|
+
|
|
2778
|
+
</dd>
|
|
2779
|
+
</dl>
|
|
2780
|
+
|
|
2781
|
+
<dl>
|
|
2782
|
+
<dd>
|
|
2783
|
+
|
|
2784
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
2785
|
+
|
|
2786
|
+
</dd>
|
|
2787
|
+
</dl>
|
|
2788
|
+
</dd>
|
|
2789
|
+
</dl>
|
|
2790
|
+
|
|
2791
|
+
|
|
2792
|
+
</dd>
|
|
2793
|
+
</dl>
|
|
2794
|
+
</details>
|
|
2795
|
+
|
|
2796
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">publishValueReceipt</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
2797
|
+
<dl>
|
|
2798
|
+
<dd>
|
|
2799
|
+
|
|
2800
|
+
#### 📝 Description
|
|
2801
|
+
|
|
2802
|
+
<dl>
|
|
2803
|
+
<dd>
|
|
2804
|
+
|
|
2805
|
+
<dl>
|
|
2806
|
+
<dd>
|
|
2807
|
+
|
|
2808
|
+
Make a value receipt publicly accessible via URL.
|
|
2809
|
+
</dd>
|
|
2810
|
+
</dl>
|
|
2811
|
+
</dd>
|
|
2812
|
+
</dl>
|
|
2813
|
+
|
|
2814
|
+
#### 🔌 Usage
|
|
2815
|
+
|
|
2816
|
+
<dl>
|
|
2817
|
+
<dd>
|
|
2818
|
+
|
|
2819
|
+
<dl>
|
|
2820
|
+
<dd>
|
|
2821
|
+
|
|
2822
|
+
```typescript
|
|
2823
|
+
await client.valueReceipts.publishValueReceipt({
|
|
2824
|
+
id: "id"
|
|
2825
|
+
});
|
|
2826
|
+
|
|
2827
|
+
```
|
|
2828
|
+
</dd>
|
|
2829
|
+
</dl>
|
|
2830
|
+
</dd>
|
|
2831
|
+
</dl>
|
|
2832
|
+
|
|
2833
|
+
#### ⚙️ Parameters
|
|
2834
|
+
|
|
2835
|
+
<dl>
|
|
2836
|
+
<dd>
|
|
2837
|
+
|
|
2838
|
+
<dl>
|
|
2839
|
+
<dd>
|
|
2840
|
+
|
|
2841
|
+
**request:** `Paid.PublishValueReceiptBody`
|
|
2842
|
+
|
|
2843
|
+
</dd>
|
|
2844
|
+
</dl>
|
|
2845
|
+
|
|
2846
|
+
<dl>
|
|
2847
|
+
<dd>
|
|
2848
|
+
|
|
2849
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
2850
|
+
|
|
2851
|
+
</dd>
|
|
2852
|
+
</dl>
|
|
2853
|
+
</dd>
|
|
2854
|
+
</dl>
|
|
2855
|
+
|
|
2856
|
+
|
|
2857
|
+
</dd>
|
|
2858
|
+
</dl>
|
|
2859
|
+
</details>
|
|
2860
|
+
|
|
2861
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">unpublishValueReceipt</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
2862
|
+
<dl>
|
|
2863
|
+
<dd>
|
|
2864
|
+
|
|
2865
|
+
#### 📝 Description
|
|
2866
|
+
|
|
2867
|
+
<dl>
|
|
2868
|
+
<dd>
|
|
2869
|
+
|
|
2870
|
+
<dl>
|
|
2871
|
+
<dd>
|
|
2872
|
+
|
|
2873
|
+
Revoke public access to a value receipt.
|
|
2874
|
+
</dd>
|
|
2875
|
+
</dl>
|
|
2876
|
+
</dd>
|
|
2877
|
+
</dl>
|
|
2878
|
+
|
|
2879
|
+
#### 🔌 Usage
|
|
2880
|
+
|
|
2881
|
+
<dl>
|
|
2882
|
+
<dd>
|
|
2883
|
+
|
|
2884
|
+
<dl>
|
|
2885
|
+
<dd>
|
|
2886
|
+
|
|
2887
|
+
```typescript
|
|
2888
|
+
await client.valueReceipts.unpublishValueReceipt({
|
|
2889
|
+
id: "id"
|
|
2890
|
+
});
|
|
2891
|
+
|
|
2892
|
+
```
|
|
2893
|
+
</dd>
|
|
2894
|
+
</dl>
|
|
2895
|
+
</dd>
|
|
2896
|
+
</dl>
|
|
2897
|
+
|
|
2898
|
+
#### ⚙️ Parameters
|
|
2899
|
+
|
|
2900
|
+
<dl>
|
|
2901
|
+
<dd>
|
|
2902
|
+
|
|
2903
|
+
<dl>
|
|
2904
|
+
<dd>
|
|
2905
|
+
|
|
2906
|
+
**request:** `Paid.UnpublishValueReceiptRequest`
|
|
2907
|
+
|
|
2908
|
+
</dd>
|
|
2909
|
+
</dl>
|
|
2910
|
+
|
|
2911
|
+
<dl>
|
|
2912
|
+
<dd>
|
|
2913
|
+
|
|
2914
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
2915
|
+
|
|
2916
|
+
</dd>
|
|
2917
|
+
</dl>
|
|
2918
|
+
</dd>
|
|
2919
|
+
</dl>
|
|
2920
|
+
|
|
2921
|
+
|
|
2663
2922
|
</dd>
|
|
2664
2923
|
</dl>
|
|
2665
2924
|
</details>
|