@usethrottle/api-client 5.9.0 → 5.11.0

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.
@@ -103,7 +103,7 @@ export declare class OrdersService {
103
103
  itemsRemaining?: number;
104
104
  } | null;
105
105
  type?: 'one_time' | 'recurring' | 'mixed';
106
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
106
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
107
107
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
108
108
  currency?: string;
109
109
  /**
@@ -339,7 +339,7 @@ export declare class OrdersService {
339
339
  * @returns any Default Response
340
340
  * @throws ApiError
341
341
  */
342
- static getApiV1Orders(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'not_shipped' | 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
342
+ static getApiV1Orders(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'not_shipped' | 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
343
343
  data?: Array<{
344
344
  id?: string;
345
345
  workspaceId?: string;
@@ -354,7 +354,7 @@ export declare class OrdersService {
354
354
  itemsRemaining?: number;
355
355
  } | null;
356
356
  type?: 'one_time' | 'recurring' | 'mixed';
357
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
357
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
358
358
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
359
359
  currency?: string;
360
360
  /**
@@ -590,7 +590,7 @@ export declare class OrdersService {
590
590
  * @returns any Default Response
591
591
  * @throws ApiError
592
592
  */
593
- static getApiV1OrdersExportCsv(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'not_shipped' | 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<any>;
593
+ static getApiV1OrdersExportCsv(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'not_shipped' | 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<any>;
594
594
  /**
595
595
  * Get an order by ID (includes line items, plus `capturedAmount` and `refundedAmount`)
596
596
  * @param id
@@ -613,7 +613,7 @@ export declare class OrdersService {
613
613
  itemsRemaining?: number;
614
614
  } | null;
615
615
  type?: 'one_time' | 'recurring' | 'mixed';
616
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
616
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
617
617
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
618
618
  currency?: string;
619
619
  /**
@@ -906,7 +906,7 @@ export declare class OrdersService {
906
906
  itemsRemaining?: number;
907
907
  } | null;
908
908
  type?: 'one_time' | 'recurring' | 'mixed';
909
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
909
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
910
910
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
911
911
  currency?: string;
912
912
  /**
@@ -1146,7 +1146,7 @@ export declare class OrdersService {
1146
1146
  itemsRemaining?: number;
1147
1147
  } | null;
1148
1148
  type?: 'one_time' | 'recurring' | 'mixed';
1149
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
1149
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
1150
1150
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
1151
1151
  currency?: string;
1152
1152
  /**
@@ -1389,7 +1389,7 @@ export declare class OrdersService {
1389
1389
  itemsRemaining?: number;
1390
1390
  } | null;
1391
1391
  type?: 'one_time' | 'recurring' | 'mixed';
1392
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
1392
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
1393
1393
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
1394
1394
  currency?: string;
1395
1395
  /**
@@ -1632,7 +1632,7 @@ export declare class OrdersService {
1632
1632
  itemsRemaining?: number;
1633
1633
  } | null;
1634
1634
  type?: 'one_time' | 'recurring' | 'mixed';
1635
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
1635
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
1636
1636
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
1637
1637
  currency?: string;
1638
1638
  /**
@@ -1876,7 +1876,7 @@ export declare class OrdersService {
1876
1876
  itemsRemaining?: number;
1877
1877
  } | null;
1878
1878
  type?: 'one_time' | 'recurring' | 'mixed';
1879
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
1879
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
1880
1880
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
1881
1881
  currency?: string;
1882
1882
  /**
@@ -2129,7 +2129,7 @@ export declare class OrdersService {
2129
2129
  itemsRemaining?: number;
2130
2130
  } | null;
2131
2131
  type?: 'one_time' | 'recurring' | 'mixed';
2132
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
2132
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
2133
2133
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
2134
2134
  currency?: string;
2135
2135
  /**
@@ -2372,7 +2372,7 @@ export declare class OrdersService {
2372
2372
  itemsRemaining?: number;
2373
2373
  } | null;
2374
2374
  type?: 'one_time' | 'recurring' | 'mixed';
2375
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
2375
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
2376
2376
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
2377
2377
  currency?: string;
2378
2378
  /**
@@ -2621,7 +2621,7 @@ export declare class OrdersService {
2621
2621
  itemsRemaining?: number;
2622
2622
  } | null;
2623
2623
  type?: 'one_time' | 'recurring' | 'mixed';
2624
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
2624
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
2625
2625
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
2626
2626
  currency?: string;
2627
2627
  /**
@@ -2864,7 +2864,7 @@ export declare class OrdersService {
2864
2864
  itemsRemaining?: number;
2865
2865
  } | null;
2866
2866
  type?: 'one_time' | 'recurring' | 'mixed';
2867
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
2867
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
2868
2868
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
2869
2869
  currency?: string;
2870
2870
  /**
@@ -3104,7 +3104,7 @@ export declare class OrdersService {
3104
3104
  itemsRemaining?: number;
3105
3105
  } | null;
3106
3106
  type?: 'one_time' | 'recurring' | 'mixed';
3107
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
3107
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
3108
3108
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
3109
3109
  currency?: string;
3110
3110
  /**
@@ -3408,7 +3408,7 @@ export declare class OrdersService {
3408
3408
  itemsRemaining?: number;
3409
3409
  } | null;
3410
3410
  type?: 'one_time' | 'recurring' | 'mixed';
3411
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
3411
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
3412
3412
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
3413
3413
  currency?: string;
3414
3414
  /**
@@ -3671,6 +3671,8 @@ export declare class OrdersService {
3671
3671
  disputed?: boolean;
3672
3672
  disputeReason?: string | null;
3673
3673
  disputeOpenedAt?: string | null;
3674
+ disputeOutcome?: 'won' | 'lost';
3675
+ disputeClosedAt?: string | null;
3674
3676
  /**
3675
3677
  * Arbitrary key-value metadata
3676
3678
  */
@@ -3730,7 +3732,7 @@ export declare class OrdersService {
3730
3732
  orderNumber?: string;
3731
3733
  status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
3732
3734
  type?: 'one_time' | 'recurring' | 'mixed';
3733
- paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
3735
+ paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired' | 'charged_back';
3734
3736
  source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
3735
3737
  currency?: string;
3736
3738
  /**