@seekora-ai/admin-api 1.1.71 → 1.1.74
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/README.md +21 -2
- package/api.ts +1232 -88
- package/dist/api.d.ts +917 -22
- package/dist/api.js +451 -9
- package/dist/esm/api.d.ts +917 -22
- package/dist/esm/api.js +442 -4
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.74.tgz +0 -0
- package/seekora-ai-admin-api-1.1.71.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -6583,6 +6583,433 @@ export interface BatchRecordResult {
|
|
|
6583
6583
|
*/
|
|
6584
6584
|
'valid'?: boolean;
|
|
6585
6585
|
}
|
|
6586
|
+
/**
|
|
6587
|
+
*
|
|
6588
|
+
* @export
|
|
6589
|
+
* @interface BillingServiceCancelledSubscriptionInfo
|
|
6590
|
+
*/
|
|
6591
|
+
export interface BillingServiceCancelledSubscriptionInfo {
|
|
6592
|
+
/**
|
|
6593
|
+
*
|
|
6594
|
+
* @type {string}
|
|
6595
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6596
|
+
*/
|
|
6597
|
+
'cancellation_reason'?: string;
|
|
6598
|
+
/**
|
|
6599
|
+
*
|
|
6600
|
+
* @type {string}
|
|
6601
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6602
|
+
*/
|
|
6603
|
+
'cancelled_at'?: string;
|
|
6604
|
+
/**
|
|
6605
|
+
*
|
|
6606
|
+
* @type {number}
|
|
6607
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6608
|
+
*/
|
|
6609
|
+
'cancelled_by'?: number;
|
|
6610
|
+
/**
|
|
6611
|
+
*
|
|
6612
|
+
* @type {string}
|
|
6613
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6614
|
+
*/
|
|
6615
|
+
'cancelled_by_name'?: string;
|
|
6616
|
+
/**
|
|
6617
|
+
*
|
|
6618
|
+
* @type {number}
|
|
6619
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6620
|
+
*/
|
|
6621
|
+
'credits_removed'?: number;
|
|
6622
|
+
/**
|
|
6623
|
+
*
|
|
6624
|
+
* @type {number}
|
|
6625
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6626
|
+
*/
|
|
6627
|
+
'id'?: number;
|
|
6628
|
+
/**
|
|
6629
|
+
*
|
|
6630
|
+
* @type {number}
|
|
6631
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6632
|
+
*/
|
|
6633
|
+
'org_id'?: number;
|
|
6634
|
+
/**
|
|
6635
|
+
*
|
|
6636
|
+
* @type {string}
|
|
6637
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6638
|
+
*/
|
|
6639
|
+
'plan_name'?: string;
|
|
6640
|
+
/**
|
|
6641
|
+
*
|
|
6642
|
+
* @type {number}
|
|
6643
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6644
|
+
*/
|
|
6645
|
+
'refund_amount'?: number;
|
|
6646
|
+
/**
|
|
6647
|
+
*
|
|
6648
|
+
* @type {string}
|
|
6649
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6650
|
+
*/
|
|
6651
|
+
'refund_currency'?: string;
|
|
6652
|
+
/**
|
|
6653
|
+
*
|
|
6654
|
+
* @type {string}
|
|
6655
|
+
* @memberof BillingServiceCancelledSubscriptionInfo
|
|
6656
|
+
*/
|
|
6657
|
+
'subscription_id'?: string;
|
|
6658
|
+
}
|
|
6659
|
+
/**
|
|
6660
|
+
*
|
|
6661
|
+
* @export
|
|
6662
|
+
* @interface BillingServicePaymentMethodSummary
|
|
6663
|
+
*/
|
|
6664
|
+
export interface BillingServicePaymentMethodSummary {
|
|
6665
|
+
/**
|
|
6666
|
+
*
|
|
6667
|
+
* @type {string}
|
|
6668
|
+
* @memberof BillingServicePaymentMethodSummary
|
|
6669
|
+
*/
|
|
6670
|
+
'brand'?: string;
|
|
6671
|
+
/**
|
|
6672
|
+
*
|
|
6673
|
+
* @type {string}
|
|
6674
|
+
* @memberof BillingServicePaymentMethodSummary
|
|
6675
|
+
*/
|
|
6676
|
+
'id'?: string;
|
|
6677
|
+
/**
|
|
6678
|
+
*
|
|
6679
|
+
* @type {boolean}
|
|
6680
|
+
* @memberof BillingServicePaymentMethodSummary
|
|
6681
|
+
*/
|
|
6682
|
+
'is_default'?: boolean;
|
|
6683
|
+
/**
|
|
6684
|
+
*
|
|
6685
|
+
* @type {string}
|
|
6686
|
+
* @memberof BillingServicePaymentMethodSummary
|
|
6687
|
+
*/
|
|
6688
|
+
'last4'?: string;
|
|
6689
|
+
/**
|
|
6690
|
+
* card, upi, bank_transfer
|
|
6691
|
+
* @type {string}
|
|
6692
|
+
* @memberof BillingServicePaymentMethodSummary
|
|
6693
|
+
*/
|
|
6694
|
+
'type'?: string;
|
|
6695
|
+
}
|
|
6696
|
+
/**
|
|
6697
|
+
*
|
|
6698
|
+
* @export
|
|
6699
|
+
* @interface BillingServicePaymentStatusResponse
|
|
6700
|
+
*/
|
|
6701
|
+
export interface BillingServicePaymentStatusResponse {
|
|
6702
|
+
/**
|
|
6703
|
+
*
|
|
6704
|
+
* @type {number}
|
|
6705
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6706
|
+
*/
|
|
6707
|
+
'amount_due'?: number;
|
|
6708
|
+
/**
|
|
6709
|
+
*
|
|
6710
|
+
* @type {boolean}
|
|
6711
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6712
|
+
*/
|
|
6713
|
+
'can_retry'?: boolean;
|
|
6714
|
+
/**
|
|
6715
|
+
*
|
|
6716
|
+
* @type {string}
|
|
6717
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6718
|
+
*/
|
|
6719
|
+
'currency'?: string;
|
|
6720
|
+
/**
|
|
6721
|
+
*
|
|
6722
|
+
* @type {number}
|
|
6723
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6724
|
+
*/
|
|
6725
|
+
'days_overdue'?: number;
|
|
6726
|
+
/**
|
|
6727
|
+
*
|
|
6728
|
+
* @type {number}
|
|
6729
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6730
|
+
*/
|
|
6731
|
+
'dunning_stage'?: number;
|
|
6732
|
+
/**
|
|
6733
|
+
*
|
|
6734
|
+
* @type {string}
|
|
6735
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6736
|
+
*/
|
|
6737
|
+
'dunning_stage_name'?: string;
|
|
6738
|
+
/**
|
|
6739
|
+
*
|
|
6740
|
+
* @type {string}
|
|
6741
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6742
|
+
*/
|
|
6743
|
+
'grace_period_ends_at'?: string;
|
|
6744
|
+
/**
|
|
6745
|
+
*
|
|
6746
|
+
* @type {string}
|
|
6747
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6748
|
+
*/
|
|
6749
|
+
'last_payment_date'?: string;
|
|
6750
|
+
/**
|
|
6751
|
+
*
|
|
6752
|
+
* @type {string}
|
|
6753
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6754
|
+
*/
|
|
6755
|
+
'last_payment_status'?: string;
|
|
6756
|
+
/**
|
|
6757
|
+
*
|
|
6758
|
+
* @type {string}
|
|
6759
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6760
|
+
*/
|
|
6761
|
+
'next_billing_date'?: string;
|
|
6762
|
+
/**
|
|
6763
|
+
*
|
|
6764
|
+
* @type {Array<BillingServicePaymentMethodSummary>}
|
|
6765
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6766
|
+
*/
|
|
6767
|
+
'payment_methods'?: Array<BillingServicePaymentMethodSummary>;
|
|
6768
|
+
/**
|
|
6769
|
+
*
|
|
6770
|
+
* @type {number}
|
|
6771
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6772
|
+
*/
|
|
6773
|
+
'retry_attempts_left'?: number;
|
|
6774
|
+
/**
|
|
6775
|
+
* \"active\", \"past_due\", \"suspended\", \"cancelled\"
|
|
6776
|
+
* @type {string}
|
|
6777
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6778
|
+
*/
|
|
6779
|
+
'status'?: string;
|
|
6780
|
+
/**
|
|
6781
|
+
*
|
|
6782
|
+
* @type {number}
|
|
6783
|
+
* @memberof BillingServicePaymentStatusResponse
|
|
6784
|
+
*/
|
|
6785
|
+
'subscription_id'?: number;
|
|
6786
|
+
}
|
|
6787
|
+
/**
|
|
6788
|
+
*
|
|
6789
|
+
* @export
|
|
6790
|
+
* @interface BillingServiceRetryPaymentRequest
|
|
6791
|
+
*/
|
|
6792
|
+
export interface BillingServiceRetryPaymentRequest {
|
|
6793
|
+
/**
|
|
6794
|
+
*
|
|
6795
|
+
* @type {number}
|
|
6796
|
+
* @memberof BillingServiceRetryPaymentRequest
|
|
6797
|
+
*/
|
|
6798
|
+
'subscription_id': number;
|
|
6799
|
+
}
|
|
6800
|
+
/**
|
|
6801
|
+
*
|
|
6802
|
+
* @export
|
|
6803
|
+
* @interface BillingServiceRetryPaymentResponse
|
|
6804
|
+
*/
|
|
6805
|
+
export interface BillingServiceRetryPaymentResponse {
|
|
6806
|
+
/**
|
|
6807
|
+
*
|
|
6808
|
+
* @type {string}
|
|
6809
|
+
* @memberof BillingServiceRetryPaymentResponse
|
|
6810
|
+
*/
|
|
6811
|
+
'message'?: string;
|
|
6812
|
+
/**
|
|
6813
|
+
*
|
|
6814
|
+
* @type {string}
|
|
6815
|
+
* @memberof BillingServiceRetryPaymentResponse
|
|
6816
|
+
*/
|
|
6817
|
+
'next_billing_date'?: string;
|
|
6818
|
+
/**
|
|
6819
|
+
*
|
|
6820
|
+
* @type {string}
|
|
6821
|
+
* @memberof BillingServiceRetryPaymentResponse
|
|
6822
|
+
*/
|
|
6823
|
+
'payment_id'?: string;
|
|
6824
|
+
/**
|
|
6825
|
+
* For 3DS authentication
|
|
6826
|
+
* @type {string}
|
|
6827
|
+
* @memberof BillingServiceRetryPaymentResponse
|
|
6828
|
+
*/
|
|
6829
|
+
'redirect_url'?: string;
|
|
6830
|
+
/**
|
|
6831
|
+
* \"processing\", \"success\", \"failed\", \"requires_action\"
|
|
6832
|
+
* @type {string}
|
|
6833
|
+
* @memberof BillingServiceRetryPaymentResponse
|
|
6834
|
+
*/
|
|
6835
|
+
'status'?: string;
|
|
6836
|
+
/**
|
|
6837
|
+
*
|
|
6838
|
+
* @type {boolean}
|
|
6839
|
+
* @memberof BillingServiceRetryPaymentResponse
|
|
6840
|
+
*/
|
|
6841
|
+
'success'?: boolean;
|
|
6842
|
+
}
|
|
6843
|
+
/**
|
|
6844
|
+
*
|
|
6845
|
+
* @export
|
|
6846
|
+
* @interface BillingServiceSubscriptionPlanChangeInfo
|
|
6847
|
+
*/
|
|
6848
|
+
export interface BillingServiceSubscriptionPlanChangeInfo {
|
|
6849
|
+
/**
|
|
6850
|
+
*
|
|
6851
|
+
* @type {number}
|
|
6852
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6853
|
+
*/
|
|
6854
|
+
'amount_remaining_value'?: number;
|
|
6855
|
+
/**
|
|
6856
|
+
*
|
|
6857
|
+
* @type {string}
|
|
6858
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6859
|
+
*/
|
|
6860
|
+
'change_type'?: string;
|
|
6861
|
+
/**
|
|
6862
|
+
*
|
|
6863
|
+
* @type {string}
|
|
6864
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6865
|
+
*/
|
|
6866
|
+
'created_at'?: string;
|
|
6867
|
+
/**
|
|
6868
|
+
*
|
|
6869
|
+
* @type {number}
|
|
6870
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6871
|
+
*/
|
|
6872
|
+
'credits_added_new_plan'?: number;
|
|
6873
|
+
/**
|
|
6874
|
+
*
|
|
6875
|
+
* @type {number}
|
|
6876
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6877
|
+
*/
|
|
6878
|
+
'credits_forfeited'?: number;
|
|
6879
|
+
/**
|
|
6880
|
+
*
|
|
6881
|
+
* @type {number}
|
|
6882
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6883
|
+
*/
|
|
6884
|
+
'credits_remaining_before'?: number;
|
|
6885
|
+
/**
|
|
6886
|
+
*
|
|
6887
|
+
* @type {number}
|
|
6888
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6889
|
+
*/
|
|
6890
|
+
'credits_transferred'?: number;
|
|
6891
|
+
/**
|
|
6892
|
+
*
|
|
6893
|
+
* @type {number}
|
|
6894
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6895
|
+
*/
|
|
6896
|
+
'days_remaining_old_plan'?: number;
|
|
6897
|
+
/**
|
|
6898
|
+
*
|
|
6899
|
+
* @type {number}
|
|
6900
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6901
|
+
*/
|
|
6902
|
+
'from_plan_id'?: number;
|
|
6903
|
+
/**
|
|
6904
|
+
*
|
|
6905
|
+
* @type {string}
|
|
6906
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6907
|
+
*/
|
|
6908
|
+
'from_plan_name'?: string;
|
|
6909
|
+
/**
|
|
6910
|
+
*
|
|
6911
|
+
* @type {number}
|
|
6912
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6913
|
+
*/
|
|
6914
|
+
'id'?: number;
|
|
6915
|
+
/**
|
|
6916
|
+
*
|
|
6917
|
+
* @type {number}
|
|
6918
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6919
|
+
*/
|
|
6920
|
+
'org_id'?: number;
|
|
6921
|
+
/**
|
|
6922
|
+
*
|
|
6923
|
+
* @type {string}
|
|
6924
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6925
|
+
*/
|
|
6926
|
+
'processed_at'?: string;
|
|
6927
|
+
/**
|
|
6928
|
+
*
|
|
6929
|
+
* @type {string}
|
|
6930
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6931
|
+
*/
|
|
6932
|
+
'proration_policy'?: string;
|
|
6933
|
+
/**
|
|
6934
|
+
*
|
|
6935
|
+
* @type {string}
|
|
6936
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6937
|
+
*/
|
|
6938
|
+
'reason'?: string;
|
|
6939
|
+
/**
|
|
6940
|
+
*
|
|
6941
|
+
* @type {string}
|
|
6942
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6943
|
+
*/
|
|
6944
|
+
'status'?: string;
|
|
6945
|
+
/**
|
|
6946
|
+
*
|
|
6947
|
+
* @type {number}
|
|
6948
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6949
|
+
*/
|
|
6950
|
+
'to_plan_id'?: number;
|
|
6951
|
+
/**
|
|
6952
|
+
*
|
|
6953
|
+
* @type {string}
|
|
6954
|
+
* @memberof BillingServiceSubscriptionPlanChangeInfo
|
|
6955
|
+
*/
|
|
6956
|
+
'to_plan_name'?: string;
|
|
6957
|
+
}
|
|
6958
|
+
/**
|
|
6959
|
+
*
|
|
6960
|
+
* @export
|
|
6961
|
+
* @interface BillingServiceTrialEligibilityResponse
|
|
6962
|
+
*/
|
|
6963
|
+
export interface BillingServiceTrialEligibilityResponse {
|
|
6964
|
+
/**
|
|
6965
|
+
*
|
|
6966
|
+
* @type {number}
|
|
6967
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
6968
|
+
*/
|
|
6969
|
+
'active_trial_plan_id'?: number;
|
|
6970
|
+
/**
|
|
6971
|
+
*
|
|
6972
|
+
* @type {boolean}
|
|
6973
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
6974
|
+
*/
|
|
6975
|
+
'eligible'?: boolean;
|
|
6976
|
+
/**
|
|
6977
|
+
*
|
|
6978
|
+
* @type {boolean}
|
|
6979
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
6980
|
+
*/
|
|
6981
|
+
'has_active_trial'?: boolean;
|
|
6982
|
+
/**
|
|
6983
|
+
*
|
|
6984
|
+
* @type {string}
|
|
6985
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
6986
|
+
*/
|
|
6987
|
+
'reason'?: string;
|
|
6988
|
+
/**
|
|
6989
|
+
*
|
|
6990
|
+
* @type {number}
|
|
6991
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
6992
|
+
*/
|
|
6993
|
+
'trial_plan_id'?: number;
|
|
6994
|
+
/**
|
|
6995
|
+
*
|
|
6996
|
+
* @type {string}
|
|
6997
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
6998
|
+
*/
|
|
6999
|
+
'trial_plan_name'?: string;
|
|
7000
|
+
/**
|
|
7001
|
+
*
|
|
7002
|
+
* @type {number}
|
|
7003
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
7004
|
+
*/
|
|
7005
|
+
'trial_subscription_id'?: number;
|
|
7006
|
+
/**
|
|
7007
|
+
*
|
|
7008
|
+
* @type {string}
|
|
7009
|
+
* @memberof BillingServiceTrialEligibilityResponse
|
|
7010
|
+
*/
|
|
7011
|
+
'trial_used_at'?: string;
|
|
7012
|
+
}
|
|
6586
7013
|
/**
|
|
6587
7014
|
*
|
|
6588
7015
|
* @export
|
|
@@ -7512,6 +7939,12 @@ export interface DataTypesBillingOrderDetailsResponse {
|
|
|
7512
7939
|
* @memberof DataTypesBillingOrderDetailsResponse
|
|
7513
7940
|
*/
|
|
7514
7941
|
'can_pay'?: boolean;
|
|
7942
|
+
/**
|
|
7943
|
+
* Order lifecycle events for timeline display
|
|
7944
|
+
* @type {Array<DataTypesOrderEvent>}
|
|
7945
|
+
* @memberof DataTypesBillingOrderDetailsResponse
|
|
7946
|
+
*/
|
|
7947
|
+
'events'?: Array<DataTypesOrderEvent>;
|
|
7515
7948
|
/**
|
|
7516
7949
|
* Array of invoices for subscriptions
|
|
7517
7950
|
* @type {Array<DataTypesInvoice>}
|
|
@@ -10673,6 +11106,12 @@ export interface DataTypesDueSubscription {
|
|
|
10673
11106
|
* @memberof DataTypesDueSubscription
|
|
10674
11107
|
*/
|
|
10675
11108
|
'days_overdue'?: number;
|
|
11109
|
+
/**
|
|
11110
|
+
*
|
|
11111
|
+
* @type {string}
|
|
11112
|
+
* @memberof DataTypesDueSubscription
|
|
11113
|
+
*/
|
|
11114
|
+
'gateway_subscription_id'?: string;
|
|
10676
11115
|
/**
|
|
10677
11116
|
*
|
|
10678
11117
|
* @type {string}
|
|
@@ -10709,12 +11148,6 @@ export interface DataTypesDueSubscription {
|
|
|
10709
11148
|
* @memberof DataTypesDueSubscription
|
|
10710
11149
|
*/
|
|
10711
11150
|
'plan_name'?: string;
|
|
10712
|
-
/**
|
|
10713
|
-
*
|
|
10714
|
-
* @type {string}
|
|
10715
|
-
* @memberof DataTypesDueSubscription
|
|
10716
|
-
*/
|
|
10717
|
-
'razorpay_subscription_id'?: string;
|
|
10718
11151
|
/**
|
|
10719
11152
|
*
|
|
10720
11153
|
* @type {string}
|
|
@@ -11774,6 +12207,56 @@ export interface DataTypesGenericResponseAny {
|
|
|
11774
12207
|
*/
|
|
11775
12208
|
'status'?: number;
|
|
11776
12209
|
}
|
|
12210
|
+
/**
|
|
12211
|
+
*
|
|
12212
|
+
* @export
|
|
12213
|
+
* @interface DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo
|
|
12214
|
+
*/
|
|
12215
|
+
export interface DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo {
|
|
12216
|
+
/**
|
|
12217
|
+
*
|
|
12218
|
+
* @type {Array<BillingServiceCancelledSubscriptionInfo>}
|
|
12219
|
+
* @memberof DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo
|
|
12220
|
+
*/
|
|
12221
|
+
'data'?: Array<BillingServiceCancelledSubscriptionInfo>;
|
|
12222
|
+
/**
|
|
12223
|
+
*
|
|
12224
|
+
* @type {string}
|
|
12225
|
+
* @memberof DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo
|
|
12226
|
+
*/
|
|
12227
|
+
'message'?: string;
|
|
12228
|
+
/**
|
|
12229
|
+
*
|
|
12230
|
+
* @type {number}
|
|
12231
|
+
* @memberof DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo
|
|
12232
|
+
*/
|
|
12233
|
+
'status'?: number;
|
|
12234
|
+
}
|
|
12235
|
+
/**
|
|
12236
|
+
*
|
|
12237
|
+
* @export
|
|
12238
|
+
* @interface DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo
|
|
12239
|
+
*/
|
|
12240
|
+
export interface DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo {
|
|
12241
|
+
/**
|
|
12242
|
+
*
|
|
12243
|
+
* @type {Array<BillingServiceSubscriptionPlanChangeInfo>}
|
|
12244
|
+
* @memberof DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo
|
|
12245
|
+
*/
|
|
12246
|
+
'data'?: Array<BillingServiceSubscriptionPlanChangeInfo>;
|
|
12247
|
+
/**
|
|
12248
|
+
*
|
|
12249
|
+
* @type {string}
|
|
12250
|
+
* @memberof DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo
|
|
12251
|
+
*/
|
|
12252
|
+
'message'?: string;
|
|
12253
|
+
/**
|
|
12254
|
+
*
|
|
12255
|
+
* @type {number}
|
|
12256
|
+
* @memberof DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo
|
|
12257
|
+
*/
|
|
12258
|
+
'status'?: number;
|
|
12259
|
+
}
|
|
11777
12260
|
/**
|
|
11778
12261
|
*
|
|
11779
12262
|
* @export
|
|
@@ -11874,6 +12357,31 @@ export interface DataTypesGenericResponseArrayString {
|
|
|
11874
12357
|
*/
|
|
11875
12358
|
'status'?: number;
|
|
11876
12359
|
}
|
|
12360
|
+
/**
|
|
12361
|
+
*
|
|
12362
|
+
* @export
|
|
12363
|
+
* @interface DataTypesGenericResponseBillingServiceTrialEligibilityResponse
|
|
12364
|
+
*/
|
|
12365
|
+
export interface DataTypesGenericResponseBillingServiceTrialEligibilityResponse {
|
|
12366
|
+
/**
|
|
12367
|
+
*
|
|
12368
|
+
* @type {BillingServiceTrialEligibilityResponse}
|
|
12369
|
+
* @memberof DataTypesGenericResponseBillingServiceTrialEligibilityResponse
|
|
12370
|
+
*/
|
|
12371
|
+
'data'?: BillingServiceTrialEligibilityResponse;
|
|
12372
|
+
/**
|
|
12373
|
+
*
|
|
12374
|
+
* @type {string}
|
|
12375
|
+
* @memberof DataTypesGenericResponseBillingServiceTrialEligibilityResponse
|
|
12376
|
+
*/
|
|
12377
|
+
'message'?: string;
|
|
12378
|
+
/**
|
|
12379
|
+
*
|
|
12380
|
+
* @type {number}
|
|
12381
|
+
* @memberof DataTypesGenericResponseBillingServiceTrialEligibilityResponse
|
|
12382
|
+
*/
|
|
12383
|
+
'status'?: number;
|
|
12384
|
+
}
|
|
11877
12385
|
/**
|
|
11878
12386
|
*
|
|
11879
12387
|
* @export
|
|
@@ -12499,6 +13007,31 @@ export interface DataTypesGenericResponseMenuRoutesAddMenuResponse {
|
|
|
12499
13007
|
*/
|
|
12500
13008
|
'status'?: number;
|
|
12501
13009
|
}
|
|
13010
|
+
/**
|
|
13011
|
+
*
|
|
13012
|
+
* @export
|
|
13013
|
+
* @interface DataTypesGenericResponsePaymentGatewayCreditProrationResult
|
|
13014
|
+
*/
|
|
13015
|
+
export interface DataTypesGenericResponsePaymentGatewayCreditProrationResult {
|
|
13016
|
+
/**
|
|
13017
|
+
*
|
|
13018
|
+
* @type {PaymentGatewayCreditProrationResult}
|
|
13019
|
+
* @memberof DataTypesGenericResponsePaymentGatewayCreditProrationResult
|
|
13020
|
+
*/
|
|
13021
|
+
'data'?: PaymentGatewayCreditProrationResult;
|
|
13022
|
+
/**
|
|
13023
|
+
*
|
|
13024
|
+
* @type {string}
|
|
13025
|
+
* @memberof DataTypesGenericResponsePaymentGatewayCreditProrationResult
|
|
13026
|
+
*/
|
|
13027
|
+
'message'?: string;
|
|
13028
|
+
/**
|
|
13029
|
+
*
|
|
13030
|
+
* @type {number}
|
|
13031
|
+
* @memberof DataTypesGenericResponsePaymentGatewayCreditProrationResult
|
|
13032
|
+
*/
|
|
13033
|
+
'status'?: number;
|
|
13034
|
+
}
|
|
12502
13035
|
/**
|
|
12503
13036
|
*
|
|
12504
13037
|
* @export
|
|
@@ -16942,6 +17475,12 @@ export interface DataTypesOrder {
|
|
|
16942
17475
|
* @memberof DataTypesOrder
|
|
16943
17476
|
*/
|
|
16944
17477
|
'id'?: number;
|
|
17478
|
+
/**
|
|
17479
|
+
* True if this is a trial activation (token charge), not a real payment
|
|
17480
|
+
* @type {boolean}
|
|
17481
|
+
* @memberof DataTypesOrder
|
|
17482
|
+
*/
|
|
17483
|
+
'is_trial_activation'?: boolean;
|
|
16945
17484
|
/**
|
|
16946
17485
|
*
|
|
16947
17486
|
* @type {{ [key: string]: any; }}
|
|
@@ -16974,6 +17513,24 @@ export interface DataTypesOrder {
|
|
|
16974
17513
|
* @memberof DataTypesOrder
|
|
16975
17514
|
*/
|
|
16976
17515
|
'status'?: string;
|
|
17516
|
+
/**
|
|
17517
|
+
* Base price before tax
|
|
17518
|
+
* @type {number}
|
|
17519
|
+
* @memberof DataTypesOrder
|
|
17520
|
+
*/
|
|
17521
|
+
'subtotal'?: number;
|
|
17522
|
+
/**
|
|
17523
|
+
* Tax amount calculated
|
|
17524
|
+
* @type {number}
|
|
17525
|
+
* @memberof DataTypesOrder
|
|
17526
|
+
*/
|
|
17527
|
+
'tax_amount'?: number;
|
|
17528
|
+
/**
|
|
17529
|
+
* Total amount (subtotal + tax) - what customer pays
|
|
17530
|
+
* @type {number}
|
|
17531
|
+
* @memberof DataTypesOrder
|
|
17532
|
+
*/
|
|
17533
|
+
'total_amount'?: number;
|
|
16977
17534
|
/**
|
|
16978
17535
|
*
|
|
16979
17536
|
* @type {string}
|
|
@@ -17018,6 +17575,45 @@ export interface DataTypesOrderDetailsResponse {
|
|
|
17018
17575
|
*/
|
|
17019
17576
|
'transactions'?: Array<DataTypesOrderTransactionDisplay>;
|
|
17020
17577
|
}
|
|
17578
|
+
/**
|
|
17579
|
+
*
|
|
17580
|
+
* @export
|
|
17581
|
+
* @interface DataTypesOrderEvent
|
|
17582
|
+
*/
|
|
17583
|
+
export interface DataTypesOrderEvent {
|
|
17584
|
+
/**
|
|
17585
|
+
*
|
|
17586
|
+
* @type {string}
|
|
17587
|
+
* @memberof DataTypesOrderEvent
|
|
17588
|
+
*/
|
|
17589
|
+
'created_at'?: string;
|
|
17590
|
+
/**
|
|
17591
|
+
*
|
|
17592
|
+
* @type {{ [key: string]: any; }}
|
|
17593
|
+
* @memberof DataTypesOrderEvent
|
|
17594
|
+
*/
|
|
17595
|
+
'event_data'?: {
|
|
17596
|
+
[key: string]: any;
|
|
17597
|
+
};
|
|
17598
|
+
/**
|
|
17599
|
+
*
|
|
17600
|
+
* @type {string}
|
|
17601
|
+
* @memberof DataTypesOrderEvent
|
|
17602
|
+
*/
|
|
17603
|
+
'event_type'?: string;
|
|
17604
|
+
/**
|
|
17605
|
+
*
|
|
17606
|
+
* @type {number}
|
|
17607
|
+
* @memberof DataTypesOrderEvent
|
|
17608
|
+
*/
|
|
17609
|
+
'id'?: number;
|
|
17610
|
+
/**
|
|
17611
|
+
*
|
|
17612
|
+
* @type {number}
|
|
17613
|
+
* @memberof DataTypesOrderEvent
|
|
17614
|
+
*/
|
|
17615
|
+
'order_id'?: number;
|
|
17616
|
+
}
|
|
17021
17617
|
/**
|
|
17022
17618
|
*
|
|
17023
17619
|
* @export
|
|
@@ -22495,6 +23091,12 @@ export interface DataTypesSubscriptionPaymentResponse {
|
|
|
22495
23091
|
* @memberof DataTypesSubscriptionPaymentResponse
|
|
22496
23092
|
*/
|
|
22497
23093
|
'error'?: string;
|
|
23094
|
+
/**
|
|
23095
|
+
*
|
|
23096
|
+
* @type {string}
|
|
23097
|
+
* @memberof DataTypesSubscriptionPaymentResponse
|
|
23098
|
+
*/
|
|
23099
|
+
'gateway_subscription_id'?: string;
|
|
22498
23100
|
/**
|
|
22499
23101
|
*
|
|
22500
23102
|
* @type {string}
|
|
@@ -22531,12 +23133,6 @@ export interface DataTypesSubscriptionPaymentResponse {
|
|
|
22531
23133
|
* @memberof DataTypesSubscriptionPaymentResponse
|
|
22532
23134
|
*/
|
|
22533
23135
|
'processed_at'?: string;
|
|
22534
|
-
/**
|
|
22535
|
-
*
|
|
22536
|
-
* @type {string}
|
|
22537
|
-
* @memberof DataTypesSubscriptionPaymentResponse
|
|
22538
|
-
*/
|
|
22539
|
-
'razorpay_subscription_id'?: string;
|
|
22540
23136
|
/**
|
|
22541
23137
|
*
|
|
22542
23138
|
* @type {number}
|
|
@@ -22580,6 +23176,12 @@ export interface DataTypesSubscriptionPaymentStatus {
|
|
|
22580
23176
|
* @memberof DataTypesSubscriptionPaymentStatus
|
|
22581
23177
|
*/
|
|
22582
23178
|
'days_overdue'?: number;
|
|
23179
|
+
/**
|
|
23180
|
+
*
|
|
23181
|
+
* @type {string}
|
|
23182
|
+
* @memberof DataTypesSubscriptionPaymentStatus
|
|
23183
|
+
*/
|
|
23184
|
+
'gateway_subscription_id'?: string;
|
|
22583
23185
|
/**
|
|
22584
23186
|
*
|
|
22585
23187
|
* @type {boolean}
|
|
@@ -22616,12 +23218,6 @@ export interface DataTypesSubscriptionPaymentStatus {
|
|
|
22616
23218
|
* @memberof DataTypesSubscriptionPaymentStatus
|
|
22617
23219
|
*/
|
|
22618
23220
|
'org_id'?: number;
|
|
22619
|
-
/**
|
|
22620
|
-
*
|
|
22621
|
-
* @type {string}
|
|
22622
|
-
* @memberof DataTypesSubscriptionPaymentStatus
|
|
22623
|
-
*/
|
|
22624
|
-
'razorpay_subscription_id'?: string;
|
|
22625
23221
|
/**
|
|
22626
23222
|
*
|
|
22627
23223
|
* @type {string}
|
|
@@ -26104,6 +26700,79 @@ export interface MgDocumentTypesCreateArticleRequestDto {
|
|
|
26104
26700
|
*/
|
|
26105
26701
|
'title'?: string;
|
|
26106
26702
|
}
|
|
26703
|
+
/**
|
|
26704
|
+
*
|
|
26705
|
+
* @export
|
|
26706
|
+
* @interface PaymentGatewayCreditProrationResult
|
|
26707
|
+
*/
|
|
26708
|
+
export interface PaymentGatewayCreditProrationResult {
|
|
26709
|
+
/**
|
|
26710
|
+
*
|
|
26711
|
+
* @type {string}
|
|
26712
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26713
|
+
*/
|
|
26714
|
+
'change_type'?: string;
|
|
26715
|
+
/**
|
|
26716
|
+
*
|
|
26717
|
+
* @type {number}
|
|
26718
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26719
|
+
*/
|
|
26720
|
+
'credits_remaining'?: number;
|
|
26721
|
+
/**
|
|
26722
|
+
*
|
|
26723
|
+
* @type {number}
|
|
26724
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26725
|
+
*/
|
|
26726
|
+
'credits_to_forfeit'?: number;
|
|
26727
|
+
/**
|
|
26728
|
+
*
|
|
26729
|
+
* @type {number}
|
|
26730
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26731
|
+
*/
|
|
26732
|
+
'credits_to_transfer'?: number;
|
|
26733
|
+
/**
|
|
26734
|
+
*
|
|
26735
|
+
* @type {number}
|
|
26736
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26737
|
+
*/
|
|
26738
|
+
'days_remaining'?: number;
|
|
26739
|
+
/**
|
|
26740
|
+
*
|
|
26741
|
+
* @type {number}
|
|
26742
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26743
|
+
*/
|
|
26744
|
+
'from_plan_id'?: number;
|
|
26745
|
+
/**
|
|
26746
|
+
*
|
|
26747
|
+
* @type {number}
|
|
26748
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26749
|
+
*/
|
|
26750
|
+
'monetary_value'?: number;
|
|
26751
|
+
/**
|
|
26752
|
+
*
|
|
26753
|
+
* @type {number}
|
|
26754
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26755
|
+
*/
|
|
26756
|
+
'new_plan_credits'?: number;
|
|
26757
|
+
/**
|
|
26758
|
+
*
|
|
26759
|
+
* @type {number}
|
|
26760
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26761
|
+
*/
|
|
26762
|
+
'plan_change_record_id'?: number;
|
|
26763
|
+
/**
|
|
26764
|
+
*
|
|
26765
|
+
* @type {number}
|
|
26766
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26767
|
+
*/
|
|
26768
|
+
'proration_ratio'?: number;
|
|
26769
|
+
/**
|
|
26770
|
+
*
|
|
26771
|
+
* @type {number}
|
|
26772
|
+
* @memberof PaymentGatewayCreditProrationResult
|
|
26773
|
+
*/
|
|
26774
|
+
'to_plan_id'?: number;
|
|
26775
|
+
}
|
|
26107
26776
|
/**
|
|
26108
26777
|
*
|
|
26109
26778
|
* @export
|
|
@@ -26652,6 +27321,12 @@ export interface QuerySuggestionsServiceManualQuerySuggestionRequest {
|
|
|
26652
27321
|
'metadata'?: {
|
|
26653
27322
|
[key: string]: string;
|
|
26654
27323
|
};
|
|
27324
|
+
/**
|
|
27325
|
+
* Optional, defaults to 0 (saved and returned)
|
|
27326
|
+
* @type {number}
|
|
27327
|
+
* @memberof QuerySuggestionsServiceManualQuerySuggestionRequest
|
|
27328
|
+
*/
|
|
27329
|
+
'popularity'?: number;
|
|
26655
27330
|
/**
|
|
26656
27331
|
* Optional, defaults to 0
|
|
26657
27332
|
* @type {number}
|
|
@@ -34435,6 +35110,37 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
34435
35110
|
* @throws {RequiredError}
|
|
34436
35111
|
*/
|
|
34437
35112
|
adminBillingUsageDetailsGet: (xstoreid?: string, startDate?: string, endDate?: string, granularity?: AdminBillingUsageDetailsGetGranularityEnum, chartPage?: number, chartPageSize?: number, endpointPage?: number, endpointPageSize?: number, consumptionPage?: number, consumptionPageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35113
|
+
/**
|
|
35114
|
+
* Retrieves a list of all historically cancelled subscriptions for the organization with cancellation details, refund info, and credits removed
|
|
35115
|
+
* @summary Get cancelled subscriptions history
|
|
35116
|
+
* @param {*} [options] Override http request option.
|
|
35117
|
+
* @throws {RequiredError}
|
|
35118
|
+
*/
|
|
35119
|
+
apiAdminBillingCancelledSubscriptionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35120
|
+
/**
|
|
35121
|
+
* Calculates and previews how credits would be handled when changing from current plan to a new plan
|
|
35122
|
+
* @summary Preview credit proration for plan change
|
|
35123
|
+
* @param {number} toPlanId Target plan ID
|
|
35124
|
+
* @param {*} [options] Override http request option.
|
|
35125
|
+
* @throws {RequiredError}
|
|
35126
|
+
*/
|
|
35127
|
+
apiAdminBillingCreditProrationPreviewGet: (toPlanId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35128
|
+
/**
|
|
35129
|
+
* Retrieves a list of all subscription plan changes (upgrades/downgrades) with credit proration details
|
|
35130
|
+
* @summary Get subscription plan change history
|
|
35131
|
+
* @param {number} [limit] Number of results per page (default 20)
|
|
35132
|
+
* @param {number} [offset] Offset for pagination (default 0)
|
|
35133
|
+
* @param {*} [options] Override http request option.
|
|
35134
|
+
* @throws {RequiredError}
|
|
35135
|
+
*/
|
|
35136
|
+
apiAdminBillingSubscriptionChangesGet: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35137
|
+
/**
|
|
35138
|
+
* Checks if the organization is eligible for a trial subscription (one trial per organization rule)
|
|
35139
|
+
* @summary Check trial eligibility
|
|
35140
|
+
* @param {*} [options] Override http request option.
|
|
35141
|
+
* @throws {RequiredError}
|
|
35142
|
+
*/
|
|
35143
|
+
apiAdminBillingTrialEligibilityGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34438
35144
|
};
|
|
34439
35145
|
/**
|
|
34440
35146
|
* BillingDashboardApi - functional programming interface
|
|
@@ -34782,6 +35488,37 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
34782
35488
|
* @throws {RequiredError}
|
|
34783
35489
|
*/
|
|
34784
35490
|
adminBillingUsageDetailsGet(xstoreid?: string, startDate?: string, endDate?: string, granularity?: AdminBillingUsageDetailsGetGranularityEnum, chartPage?: number, chartPageSize?: number, endpointPage?: number, endpointPageSize?: number, consumptionPage?: number, consumptionPageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35491
|
+
/**
|
|
35492
|
+
* Retrieves a list of all historically cancelled subscriptions for the organization with cancellation details, refund info, and credits removed
|
|
35493
|
+
* @summary Get cancelled subscriptions history
|
|
35494
|
+
* @param {*} [options] Override http request option.
|
|
35495
|
+
* @throws {RequiredError}
|
|
35496
|
+
*/
|
|
35497
|
+
apiAdminBillingCancelledSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo>>;
|
|
35498
|
+
/**
|
|
35499
|
+
* Calculates and previews how credits would be handled when changing from current plan to a new plan
|
|
35500
|
+
* @summary Preview credit proration for plan change
|
|
35501
|
+
* @param {number} toPlanId Target plan ID
|
|
35502
|
+
* @param {*} [options] Override http request option.
|
|
35503
|
+
* @throws {RequiredError}
|
|
35504
|
+
*/
|
|
35505
|
+
apiAdminBillingCreditProrationPreviewGet(toPlanId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponsePaymentGatewayCreditProrationResult>>;
|
|
35506
|
+
/**
|
|
35507
|
+
* Retrieves a list of all subscription plan changes (upgrades/downgrades) with credit proration details
|
|
35508
|
+
* @summary Get subscription plan change history
|
|
35509
|
+
* @param {number} [limit] Number of results per page (default 20)
|
|
35510
|
+
* @param {number} [offset] Offset for pagination (default 0)
|
|
35511
|
+
* @param {*} [options] Override http request option.
|
|
35512
|
+
* @throws {RequiredError}
|
|
35513
|
+
*/
|
|
35514
|
+
apiAdminBillingSubscriptionChangesGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo>>;
|
|
35515
|
+
/**
|
|
35516
|
+
* Checks if the organization is eligible for a trial subscription (one trial per organization rule)
|
|
35517
|
+
* @summary Check trial eligibility
|
|
35518
|
+
* @param {*} [options] Override http request option.
|
|
35519
|
+
* @throws {RequiredError}
|
|
35520
|
+
*/
|
|
35521
|
+
apiAdminBillingTrialEligibilityGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseBillingServiceTrialEligibilityResponse>>;
|
|
34785
35522
|
};
|
|
34786
35523
|
/**
|
|
34787
35524
|
* BillingDashboardApi - factory interface
|
|
@@ -35129,6 +35866,37 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
35129
35866
|
* @throws {RequiredError}
|
|
35130
35867
|
*/
|
|
35131
35868
|
adminBillingUsageDetailsGet(xstoreid?: string, startDate?: string, endDate?: string, granularity?: AdminBillingUsageDetailsGetGranularityEnum, chartPage?: number, chartPageSize?: number, endpointPage?: number, endpointPageSize?: number, consumptionPage?: number, consumptionPageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
35869
|
+
/**
|
|
35870
|
+
* Retrieves a list of all historically cancelled subscriptions for the organization with cancellation details, refund info, and credits removed
|
|
35871
|
+
* @summary Get cancelled subscriptions history
|
|
35872
|
+
* @param {*} [options] Override http request option.
|
|
35873
|
+
* @throws {RequiredError}
|
|
35874
|
+
*/
|
|
35875
|
+
apiAdminBillingCancelledSubscriptionsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo>;
|
|
35876
|
+
/**
|
|
35877
|
+
* Calculates and previews how credits would be handled when changing from current plan to a new plan
|
|
35878
|
+
* @summary Preview credit proration for plan change
|
|
35879
|
+
* @param {number} toPlanId Target plan ID
|
|
35880
|
+
* @param {*} [options] Override http request option.
|
|
35881
|
+
* @throws {RequiredError}
|
|
35882
|
+
*/
|
|
35883
|
+
apiAdminBillingCreditProrationPreviewGet(toPlanId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponsePaymentGatewayCreditProrationResult>;
|
|
35884
|
+
/**
|
|
35885
|
+
* Retrieves a list of all subscription plan changes (upgrades/downgrades) with credit proration details
|
|
35886
|
+
* @summary Get subscription plan change history
|
|
35887
|
+
* @param {number} [limit] Number of results per page (default 20)
|
|
35888
|
+
* @param {number} [offset] Offset for pagination (default 0)
|
|
35889
|
+
* @param {*} [options] Override http request option.
|
|
35890
|
+
* @throws {RequiredError}
|
|
35891
|
+
*/
|
|
35892
|
+
apiAdminBillingSubscriptionChangesGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo>;
|
|
35893
|
+
/**
|
|
35894
|
+
* Checks if the organization is eligible for a trial subscription (one trial per organization rule)
|
|
35895
|
+
* @summary Check trial eligibility
|
|
35896
|
+
* @param {*} [options] Override http request option.
|
|
35897
|
+
* @throws {RequiredError}
|
|
35898
|
+
*/
|
|
35899
|
+
apiAdminBillingTrialEligibilityGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseBillingServiceTrialEligibilityResponse>;
|
|
35132
35900
|
};
|
|
35133
35901
|
/**
|
|
35134
35902
|
* BillingDashboardApi - object-oriented interface
|
|
@@ -35511,6 +36279,41 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
35511
36279
|
* @memberof BillingDashboardApi
|
|
35512
36280
|
*/
|
|
35513
36281
|
adminBillingUsageDetailsGet(xstoreid?: string, startDate?: string, endDate?: string, granularity?: AdminBillingUsageDetailsGetGranularityEnum, chartPage?: number, chartPageSize?: number, endpointPage?: number, endpointPageSize?: number, consumptionPage?: number, consumptionPageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36282
|
+
/**
|
|
36283
|
+
* Retrieves a list of all historically cancelled subscriptions for the organization with cancellation details, refund info, and credits removed
|
|
36284
|
+
* @summary Get cancelled subscriptions history
|
|
36285
|
+
* @param {*} [options] Override http request option.
|
|
36286
|
+
* @throws {RequiredError}
|
|
36287
|
+
* @memberof BillingDashboardApi
|
|
36288
|
+
*/
|
|
36289
|
+
apiAdminBillingCancelledSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo, any, {}>>;
|
|
36290
|
+
/**
|
|
36291
|
+
* Calculates and previews how credits would be handled when changing from current plan to a new plan
|
|
36292
|
+
* @summary Preview credit proration for plan change
|
|
36293
|
+
* @param {number} toPlanId Target plan ID
|
|
36294
|
+
* @param {*} [options] Override http request option.
|
|
36295
|
+
* @throws {RequiredError}
|
|
36296
|
+
* @memberof BillingDashboardApi
|
|
36297
|
+
*/
|
|
36298
|
+
apiAdminBillingCreditProrationPreviewGet(toPlanId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponsePaymentGatewayCreditProrationResult, any, {}>>;
|
|
36299
|
+
/**
|
|
36300
|
+
* Retrieves a list of all subscription plan changes (upgrades/downgrades) with credit proration details
|
|
36301
|
+
* @summary Get subscription plan change history
|
|
36302
|
+
* @param {number} [limit] Number of results per page (default 20)
|
|
36303
|
+
* @param {number} [offset] Offset for pagination (default 0)
|
|
36304
|
+
* @param {*} [options] Override http request option.
|
|
36305
|
+
* @throws {RequiredError}
|
|
36306
|
+
* @memberof BillingDashboardApi
|
|
36307
|
+
*/
|
|
36308
|
+
apiAdminBillingSubscriptionChangesGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayBillingServiceSubscriptionPlanChangeInfo, any, {}>>;
|
|
36309
|
+
/**
|
|
36310
|
+
* Checks if the organization is eligible for a trial subscription (one trial per organization rule)
|
|
36311
|
+
* @summary Check trial eligibility
|
|
36312
|
+
* @param {*} [options] Override http request option.
|
|
36313
|
+
* @throws {RequiredError}
|
|
36314
|
+
* @memberof BillingDashboardApi
|
|
36315
|
+
*/
|
|
36316
|
+
apiAdminBillingTrialEligibilityGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseBillingServiceTrialEligibilityResponse, any, {}>>;
|
|
35514
36317
|
}
|
|
35515
36318
|
/**
|
|
35516
36319
|
* @export
|
|
@@ -35922,6 +36725,98 @@ export declare const AdminBillingGraphsUsageBreakdownGetGranularityEnum: {
|
|
|
35922
36725
|
readonly Month: "month";
|
|
35923
36726
|
};
|
|
35924
36727
|
export type AdminBillingGraphsUsageBreakdownGetGranularityEnum = typeof AdminBillingGraphsUsageBreakdownGetGranularityEnum[keyof typeof AdminBillingGraphsUsageBreakdownGetGranularityEnum];
|
|
36728
|
+
/**
|
|
36729
|
+
* BillingUserPaymentsApi - axios parameter creator
|
|
36730
|
+
* @export
|
|
36731
|
+
*/
|
|
36732
|
+
export declare const BillingUserPaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
36733
|
+
/**
|
|
36734
|
+
* Allows user to retry a failed payment for their subscription
|
|
36735
|
+
* @summary Retry a failed subscription payment
|
|
36736
|
+
* @param {BillingServiceRetryPaymentRequest} billingServiceRetryPaymentRequest Retry payment request
|
|
36737
|
+
* @param {*} [options] Override http request option.
|
|
36738
|
+
* @throws {RequiredError}
|
|
36739
|
+
*/
|
|
36740
|
+
apiBillingPaymentsRetryPost: (billingServiceRetryPaymentRequest: BillingServiceRetryPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36741
|
+
/**
|
|
36742
|
+
* Gets the current payment status, dunning state, and retry options for a subscription
|
|
36743
|
+
* @summary Get payment status for a subscription
|
|
36744
|
+
* @param {number} id Subscription ID
|
|
36745
|
+
* @param {*} [options] Override http request option.
|
|
36746
|
+
* @throws {RequiredError}
|
|
36747
|
+
*/
|
|
36748
|
+
apiBillingSubscriptionsIdPaymentStatusGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36749
|
+
};
|
|
36750
|
+
/**
|
|
36751
|
+
* BillingUserPaymentsApi - functional programming interface
|
|
36752
|
+
* @export
|
|
36753
|
+
*/
|
|
36754
|
+
export declare const BillingUserPaymentsApiFp: (configuration?: Configuration) => {
|
|
36755
|
+
/**
|
|
36756
|
+
* Allows user to retry a failed payment for their subscription
|
|
36757
|
+
* @summary Retry a failed subscription payment
|
|
36758
|
+
* @param {BillingServiceRetryPaymentRequest} billingServiceRetryPaymentRequest Retry payment request
|
|
36759
|
+
* @param {*} [options] Override http request option.
|
|
36760
|
+
* @throws {RequiredError}
|
|
36761
|
+
*/
|
|
36762
|
+
apiBillingPaymentsRetryPost(billingServiceRetryPaymentRequest: BillingServiceRetryPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BillingServiceRetryPaymentResponse>>;
|
|
36763
|
+
/**
|
|
36764
|
+
* Gets the current payment status, dunning state, and retry options for a subscription
|
|
36765
|
+
* @summary Get payment status for a subscription
|
|
36766
|
+
* @param {number} id Subscription ID
|
|
36767
|
+
* @param {*} [options] Override http request option.
|
|
36768
|
+
* @throws {RequiredError}
|
|
36769
|
+
*/
|
|
36770
|
+
apiBillingSubscriptionsIdPaymentStatusGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BillingServicePaymentStatusResponse>>;
|
|
36771
|
+
};
|
|
36772
|
+
/**
|
|
36773
|
+
* BillingUserPaymentsApi - factory interface
|
|
36774
|
+
* @export
|
|
36775
|
+
*/
|
|
36776
|
+
export declare const BillingUserPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
36777
|
+
/**
|
|
36778
|
+
* Allows user to retry a failed payment for their subscription
|
|
36779
|
+
* @summary Retry a failed subscription payment
|
|
36780
|
+
* @param {BillingServiceRetryPaymentRequest} billingServiceRetryPaymentRequest Retry payment request
|
|
36781
|
+
* @param {*} [options] Override http request option.
|
|
36782
|
+
* @throws {RequiredError}
|
|
36783
|
+
*/
|
|
36784
|
+
apiBillingPaymentsRetryPost(billingServiceRetryPaymentRequest: BillingServiceRetryPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<BillingServiceRetryPaymentResponse>;
|
|
36785
|
+
/**
|
|
36786
|
+
* Gets the current payment status, dunning state, and retry options for a subscription
|
|
36787
|
+
* @summary Get payment status for a subscription
|
|
36788
|
+
* @param {number} id Subscription ID
|
|
36789
|
+
* @param {*} [options] Override http request option.
|
|
36790
|
+
* @throws {RequiredError}
|
|
36791
|
+
*/
|
|
36792
|
+
apiBillingSubscriptionsIdPaymentStatusGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<BillingServicePaymentStatusResponse>;
|
|
36793
|
+
};
|
|
36794
|
+
/**
|
|
36795
|
+
* BillingUserPaymentsApi - object-oriented interface
|
|
36796
|
+
* @export
|
|
36797
|
+
* @class BillingUserPaymentsApi
|
|
36798
|
+
* @extends {BaseAPI}
|
|
36799
|
+
*/
|
|
36800
|
+
export declare class BillingUserPaymentsApi extends BaseAPI {
|
|
36801
|
+
/**
|
|
36802
|
+
* Allows user to retry a failed payment for their subscription
|
|
36803
|
+
* @summary Retry a failed subscription payment
|
|
36804
|
+
* @param {BillingServiceRetryPaymentRequest} billingServiceRetryPaymentRequest Retry payment request
|
|
36805
|
+
* @param {*} [options] Override http request option.
|
|
36806
|
+
* @throws {RequiredError}
|
|
36807
|
+
* @memberof BillingUserPaymentsApi
|
|
36808
|
+
*/
|
|
36809
|
+
apiBillingPaymentsRetryPost(billingServiceRetryPaymentRequest: BillingServiceRetryPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingServiceRetryPaymentResponse, any, {}>>;
|
|
36810
|
+
/**
|
|
36811
|
+
* Gets the current payment status, dunning state, and retry options for a subscription
|
|
36812
|
+
* @summary Get payment status for a subscription
|
|
36813
|
+
* @param {number} id Subscription ID
|
|
36814
|
+
* @param {*} [options] Override http request option.
|
|
36815
|
+
* @throws {RequiredError}
|
|
36816
|
+
* @memberof BillingUserPaymentsApi
|
|
36817
|
+
*/
|
|
36818
|
+
apiBillingSubscriptionsIdPaymentStatusGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingServicePaymentStatusResponse, any, {}>>;
|
|
36819
|
+
}
|
|
35925
36820
|
/**
|
|
35926
36821
|
* CommonApi - axios parameter creator
|
|
35927
36822
|
* @export
|
|
@@ -40579,7 +41474,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
40579
41474
|
* @param {V1NotificationsGetPriorityEnum} [priority] Filter by priority
|
|
40580
41475
|
* @param {V1NotificationsGetSortByEnum} [sortBy] Sort field
|
|
40581
41476
|
* @param {V1NotificationsGetSortOrderEnum} [sortOrder] Sort order (case-insensitive)
|
|
40582
|
-
* @param {string} [since] ISO8601 timestamp - return only notifications created
|
|
41477
|
+
* @param {string} [since] ISO8601 timestamp - return only notifications created strictly after this time (excludes notifications with this exact timestamp)
|
|
40583
41478
|
* @param {*} [options] Override http request option.
|
|
40584
41479
|
* @throws {RequiredError}
|
|
40585
41480
|
*/
|
|
@@ -40658,7 +41553,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
40658
41553
|
* @param {V1NotificationsGetPriorityEnum} [priority] Filter by priority
|
|
40659
41554
|
* @param {V1NotificationsGetSortByEnum} [sortBy] Sort field
|
|
40660
41555
|
* @param {V1NotificationsGetSortOrderEnum} [sortOrder] Sort order (case-insensitive)
|
|
40661
|
-
* @param {string} [since] ISO8601 timestamp - return only notifications created
|
|
41556
|
+
* @param {string} [since] ISO8601 timestamp - return only notifications created strictly after this time (excludes notifications with this exact timestamp)
|
|
40662
41557
|
* @param {*} [options] Override http request option.
|
|
40663
41558
|
* @throws {RequiredError}
|
|
40664
41559
|
*/
|
|
@@ -40737,7 +41632,7 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
40737
41632
|
* @param {V1NotificationsGetPriorityEnum} [priority] Filter by priority
|
|
40738
41633
|
* @param {V1NotificationsGetSortByEnum} [sortBy] Sort field
|
|
40739
41634
|
* @param {V1NotificationsGetSortOrderEnum} [sortOrder] Sort order (case-insensitive)
|
|
40740
|
-
* @param {string} [since] ISO8601 timestamp - return only notifications created
|
|
41635
|
+
* @param {string} [since] ISO8601 timestamp - return only notifications created strictly after this time (excludes notifications with this exact timestamp)
|
|
40741
41636
|
* @param {*} [options] Override http request option.
|
|
40742
41637
|
* @throws {RequiredError}
|
|
40743
41638
|
*/
|
|
@@ -40819,7 +41714,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
40819
41714
|
* @param {V1NotificationsGetPriorityEnum} [priority] Filter by priority
|
|
40820
41715
|
* @param {V1NotificationsGetSortByEnum} [sortBy] Sort field
|
|
40821
41716
|
* @param {V1NotificationsGetSortOrderEnum} [sortOrder] Sort order (case-insensitive)
|
|
40822
|
-
* @param {string} [since] ISO8601 timestamp - return only notifications created
|
|
41717
|
+
* @param {string} [since] ISO8601 timestamp - return only notifications created strictly after this time (excludes notifications with this exact timestamp)
|
|
40823
41718
|
* @param {*} [options] Override http request option.
|
|
40824
41719
|
* @throws {RequiredError}
|
|
40825
41720
|
* @memberof NotificationsApi
|