chargebee 2.27.0 → 2.29.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.
Files changed (51) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.yml +81 -0
  2. package/.github/ISSUE_TEMPLATE/config.yml +6 -0
  3. package/.github/ISSUE_TEMPLATE/feature_request.yml +34 -0
  4. package/.github/PULL_REQUEST_TEMPLATE.md +8 -0
  5. package/.github/workflows/greeting.yml +47 -0
  6. package/CHANGELOG.md +69 -2
  7. package/SECURITY.md +8 -0
  8. package/lib/chargebee.js +1 -1
  9. package/lib/resources/api_endpoints.js +0 -7
  10. package/package.json +1 -1
  11. package/types/core.d.ts +4 -4
  12. package/types/resources/AttachedItem.d.ts +88 -88
  13. package/types/resources/Card.d.ts +68 -68
  14. package/types/resources/Comment.d.ts +50 -44
  15. package/types/resources/Coupon.d.ts +242 -207
  16. package/types/resources/CouponSet.d.ts +72 -68
  17. package/types/resources/CreditNote.d.ts +612 -236
  18. package/types/resources/Customer.d.ts +655 -513
  19. package/types/resources/DifferentialPrice.d.ts +99 -74
  20. package/types/resources/EntitlementOverride.d.ts +27 -12
  21. package/types/resources/Estimate.d.ts +450 -450
  22. package/types/resources/Event.d.ts +30 -12
  23. package/types/resources/Export.d.ts +200 -200
  24. package/types/resources/Feature.d.ts +66 -35
  25. package/types/resources/Gift.d.ts +54 -44
  26. package/types/resources/HostedPage.d.ts +381 -381
  27. package/types/resources/InAppSubscription.d.ts +94 -90
  28. package/types/resources/Invoice.d.ts +1242 -660
  29. package/types/resources/Item.d.ts +148 -142
  30. package/types/resources/ItemEntitlement.d.ts +36 -36
  31. package/types/resources/ItemFamily.d.ts +45 -45
  32. package/types/resources/ItemPrice.d.ts +317 -273
  33. package/types/resources/PaymentIntent.d.ts +60 -60
  34. package/types/resources/PaymentVoucher.d.ts +74 -59
  35. package/types/resources/PortalSession.d.ts +45 -20
  36. package/types/resources/PromotionalCredit.d.ts +68 -68
  37. package/types/resources/Purchase.d.ts +3 -3
  38. package/types/resources/Quote.d.ts +652 -363
  39. package/types/resources/QuoteLineGroup.d.ts +245 -0
  40. package/types/resources/QuotedCharge.d.ts +170 -0
  41. package/types/resources/QuotedSubscription.d.ts +219 -0
  42. package/types/resources/SiteMigrationDetail.d.ts +7 -7
  43. package/types/resources/Subscription.d.ts +1219 -932
  44. package/types/resources/SubscriptionEntitlement.d.ts +33 -12
  45. package/types/resources/ThirdPartyPaymentMethod.d.ts +1 -1
  46. package/types/resources/TimeMachine.d.ts +15 -15
  47. package/types/resources/Token.d.ts +23 -23
  48. package/types/resources/Transaction.d.ts +229 -112
  49. package/types/resources/UnbilledCharge.d.ts +112 -67
  50. package/types/resources/Usage.d.ts +46 -47
  51. package/types/resources/VirtualBankAccount.d.ts +66 -66
@@ -0,0 +1,81 @@
1
+ name: Bug Report
2
+ description: Report a bug for this repository.
3
+ labels:
4
+ - Bug
5
+
6
+ body:
7
+
8
+ - type: textarea
9
+ id: what-happened
10
+ attributes:
11
+ label: Description of the Bug
12
+ description: Please provide a clear and concise description of the bug.
13
+ placeholder: Describe what you're experiencing.
14
+ validations:
15
+ required: true
16
+
17
+ - type: textarea
18
+ id: repro-steps
19
+ attributes:
20
+ label: Steps to reproduce
21
+ description: Clear and concise instructions to reproduce the bug are essential for quick resolution.
22
+ placeholder: |
23
+ 1. Fetch '...'
24
+ 2. Update the '....'
25
+ 3. Encounter the error
26
+ validations:
27
+ required: true
28
+
29
+ - type: textarea
30
+ id: expected-behavior
31
+ attributes:
32
+ label: Expected Behavior
33
+ description: Describe what you expected to happen.
34
+ validations:
35
+ required: true
36
+
37
+ - type: textarea
38
+ id: code-snippets
39
+ attributes:
40
+ label: Code Snippets (if applicable)
41
+ description: If relevant, provide code snippets to clarify the issue.
42
+ render: node
43
+ validations:
44
+ required: false
45
+
46
+ - type: input
47
+ id: os
48
+ attributes:
49
+ label: Operating System
50
+ placeholder: macOS
51
+ validations:
52
+ required: true
53
+
54
+ - type: input
55
+ id: language-version
56
+ attributes:
57
+ label: Language version
58
+ placeholder: Node 18.18.1
59
+ validations:
60
+ required: true
61
+
62
+ - type: input
63
+ id: lib-version
64
+ attributes:
65
+ label: Library version
66
+ placeholder: 2.28.0
67
+ validations:
68
+ required: true
69
+
70
+ - type: textarea
71
+ id: additional-context
72
+ attributes:
73
+ label: Additional context
74
+ description: Provide any other relevant information about the problem.
75
+ validations:
76
+ required: false
77
+
78
+ - type: markdown
79
+ attributes:
80
+ value: |
81
+ Thank you for taking the time to submit this bug report!
@@ -0,0 +1,6 @@
1
+ blank_issues_enabled: false
2
+ contact_links:
3
+ - name: Chargebee support
4
+ url: https://support.chargebee.com/
5
+ about: |
6
+ Github issues are not an official support channel for Chargebee. If you have an urgent request we suggest you contact us through an official channel: support@chargebee.com or https://support.chargebee.com/
@@ -0,0 +1,34 @@
1
+ name: Feature Request
2
+ description: Request a New Feature for the project.
3
+ labels:
4
+ - Feature Request
5
+
6
+ body:
7
+ - type: textarea
8
+ id: problem
9
+ attributes:
10
+ label: What problem does your feature request address?
11
+ description: Please provide a clear and concise description of the problem you'd like to solve. For example, "I'm frequently frustrated when..."
12
+
13
+ - type: textarea
14
+ id: solution
15
+ attributes:
16
+ label: Describe the desired solution
17
+ description: Please provide a clear and concise description of the solution you would like to see implemented.
18
+
19
+ - type: textarea
20
+ id: alternatives
21
+ attributes:
22
+ label: Alternatives considered
23
+ description: Describe any alternative solutions or features you may have thought about in relation to this problem.
24
+
25
+ - type: textarea
26
+ id: context
27
+ attributes:
28
+ label: Additional context
29
+ description: Feel free to include any other relevant information or context regarding your feature request.
30
+
31
+ - type: markdown
32
+ attributes:
33
+ value: |
34
+ Thank you for taking the time to submit your feature request!
@@ -0,0 +1,8 @@
1
+ ### Description
2
+ Please provide a brief overview of the changes introduced by this pull request.
3
+
4
+ ### Related Issues
5
+ Closes #IssueNumber
6
+
7
+ ### Additional Information
8
+ Include any additional information that might be helpful in reviewing the changes introduced by this pull request.
@@ -0,0 +1,47 @@
1
+ name: Greet New Contributors
2
+
3
+ on:
4
+ issues:
5
+ types: [opened]
6
+ pull_request:
7
+ types: [opened]
8
+
9
+ permissions:
10
+ issues: write
11
+ pull-requests: write
12
+
13
+ jobs:
14
+ build:
15
+
16
+ runs-on: ubuntu-latest
17
+
18
+ steps:
19
+ - name: Greet for issue
20
+ if: github.event_name == 'issues' && github.event.action == 'opened'
21
+ uses: actions/github-script@v6
22
+ with:
23
+ script: |
24
+ const issueComment = `
25
+ Hello @${context.payload.sender.login}, thank you for raising the issue. Your contribution is greatly appreciated and we look forward to addressing it.
26
+ `
27
+ github.rest.issues.createComment({
28
+ issue_number: context.payload.issue.number,
29
+ owner: context.repo.owner,
30
+ repo: context.repo.repo,
31
+ body: issueComment,
32
+ })
33
+
34
+ - name: Greet for pull request
35
+ if: github.event_name == 'pull_request' && github.event.action == 'opened'
36
+ uses: actions/github-script@v6
37
+ with:
38
+ script: |
39
+ const prComment = `
40
+ Thank you, @${context.payload.sender.login}, for the pull request. We will take a look at it and get back to you shortly.
41
+ `
42
+ github.rest.issues.createComment({
43
+ issue_number: context.payload.pull_request.number,
44
+ owner: context.repo.owner,
45
+ repo: context.repo.repo,
46
+ body: prComment,
47
+ })
package/CHANGELOG.md CHANGED
@@ -1,6 +1,69 @@
1
- ### v2.26.1 (2023-08-11)
1
+ ### v2.29.0 (2023-10-31)
2
2
  * * *
3
- * Support Descriptions for the attributes and actions has been added.
3
+
4
+ #### New attributes:
5
+ * statement_descriptor has been added to invoice resource.
6
+ * source has been added to the Hosted_Pages resource.
7
+
8
+ #### New Enum values:
9
+ * pay_com has been added to Gateway.
10
+ * pay_to, faster_payments, sepa_instant_transfer has been added to Customer#TypeEnum.
11
+ * pay_to, faster_payments, sepa_instant_transfer has been added to PaymentMethodEnum.
12
+ * pay_to, faster_payments, sepa_instant_transfer has been added to PaymentMethodTypeEnum.
13
+ * pay_to, faster_payments, sepa_instant_transfer has been added to TypeEnum.
14
+ * pay_to, faster_payments, sepa_instant_transfer, amazon_payments has been added to PaymentIntent#PaymentMethodTypeEnum.
15
+
16
+ #### New Input parameters:
17
+ * source has been added to HostedPage#CheckoutOneTimeForItemsRequest.
18
+ * source has been added to HostedPage#CheckoutNewForItemsRequest.
19
+ * source has been added to HostedPage#CheckoutExistingForItemsRequest.
20
+ * statement_descriptor_descriptor has been added to Invoice#CreateRequest.
21
+ * statement_descriptor_descriptor has been added to Invoice#CreateForChargeItemsAndChargesRequest.
22
+ * statement_descriptor_descriptor has been added to Invoice#UpdateDetailsRequest.
23
+ * statement_descriptor_additional_info has been added to Invoice#CreateRequest.
24
+ * statement_descriptor_additional_info has been added to Invoice#CreateForChargeItemsAndChargesRequest.
25
+ * statement_descriptor_additional_info has been added to Invoice#UpdateDetailsRequest.
26
+ * statement_descriptor_descriptor has been added to Subscription#CreateRequest.
27
+ * statement_descriptor_descriptor has been added to Subscription#CreateForCustomerRequest.
28
+ * statement_descriptor_descriptor has been added to Subscription#CreateWithItemsRequest.
29
+ * statement_descriptor_descriptor has been added to Subscription#UpdateRequest.
30
+ * statement_descriptor_descriptor has been added to Subscription#UpdateForItemsRequest.
31
+ * statement_descriptor_descriptor has been added to Subscription#ReactivateRequest.
32
+ * statement_descriptor_additional_info has been added to Subscription#CreateRequest.
33
+ * statement_descriptor_additional_info has been added to Subscription#CreateForCustomerRequest.
34
+ * statement_descriptor_additional_info has been added to Subscription#CreateWithItemsRequest.
35
+ * statement_descriptor_additional_info has been added to Subscription#UpdateRequest.
36
+ * statement_descriptor_additional_info has been added to Subscription#UpdateForItemsRequest.
37
+ * statement_descriptor_additional_info has been added to Subscription#ReactivateRequest.
38
+
39
+ #### Updates to old parameters:
40
+ * duration_type, discount_type in coupons has been made optional.
41
+ * proration_type in addons is now supported.
42
+ * csv_tax_rule has been removed.
43
+ * Tax1JurisTypeEnum has been removed.
44
+ * Tax2JurisTypeEnum has been removed.
45
+ * Tax3JurisTypeEnum has been removed.
46
+ * Tax4JurisTypeEnum has been removed.
47
+
48
+ ### v2.28.0 (2023-09-26)
49
+ * * *
50
+
51
+ #### New attributes:
52
+ * venmo has been added to the PaymentSource resource.
53
+ * proration_type has been added to the QuotedCharge, QuotedSubscription and Subscription resource.
54
+
55
+ #### New Enum values:
56
+ * ebanx has been added to Gateway.
57
+ * venmo has been added to Customer#TypeEnum.
58
+ * venmo has been added to PaymentMethodEnum.
59
+ * venmo has been added to PaymentMethodTypeEnum.
60
+ * venmo has been added to TypeEnum.
61
+ * venmo has been added to PaymentIntent#PaymentMethodTypeEnum.
62
+
63
+ #### New Input parameters:
64
+ * einvoicing_method has been added to HostedPage#CheckoutOneTimeForItemsRequest.
65
+ * einvoicing_method has been added to HostedPage#CheckoutNewForItemsRequest.
66
+ * additional_information has been added to PaymentSource#CardAdditionalInformation.
4
67
 
5
68
  ### v2.27.0 (2023-09-05)
6
69
  * * *
@@ -21,6 +84,10 @@
21
84
  #### New Input parameters:
22
85
  * avalara_tax_code, hsn_code, taxjar_product_code has been added to Invoice#AddChargeRequest.
23
86
 
87
+ ### v2.26.1 (2023-08-11)
88
+ * * *
89
+ * Support Descriptions for the attributes and actions has been added.
90
+
24
91
 
25
92
  ### v2.26.0 (2023-07-31)
26
93
  * * *
package/SECURITY.md ADDED
@@ -0,0 +1,8 @@
1
+ # Security Policy
2
+
3
+ At Chargebee, we take data integrity and security very seriously. Due to the nature of the product and service we provide, we are committed to working with individuals to stay updated on the latest security techniques and fix any security weakness in our application or infrastructure reported to us responsibly by external parties.
4
+
5
+ https://www.chargebee.com/security/responsible-disclosure-policy/
6
+
7
+ ## Reporting a vulnerability
8
+ Reach out to us at security@chargebee.com. Please do not open GitHub issues or pull requests as this makes the problem immediately visible to everyone, including malicious actors. Chargebee's security team will triage your report and respond according to its impact.
package/lib/chargebee.js CHANGED
@@ -11,7 +11,7 @@ ChargeBee._env = {
11
11
  hostSuffix: '.chargebee.com',
12
12
  apiPath: '/api/v2',
13
13
  timeout: 80000,
14
- clientVersion: 'v2.27.0',
14
+ clientVersion: 'v2.29.0',
15
15
  port: 443,
16
16
  timemachineWaitInMillis: 3000,
17
17
  exportWaitInMillis: 3000
@@ -2677,12 +2677,5 @@ var _endpoints = {
2677
2677
  true
2678
2678
  ]
2679
2679
  ],
2680
- "csv_tax_rule": [[
2681
- "create",
2682
- "POST",
2683
- "/csv_tax_rules",
2684
- null,
2685
- false
2686
- ]]
2687
2680
  };
2688
2681
  module.exports = _endpoints;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name":"chargebee",
3
- "version":"2.27.0",
3
+ "version":"2.29.0",
4
4
  "description":"A library for integrating with ChargeBee.",
5
5
  "keywords":[
6
6
  "payments",
package/types/core.d.ts CHANGED
@@ -46,7 +46,7 @@ declare module 'chargebee' {
46
46
  type ExportType = 'data' | 'import_friendly_data'
47
47
  type FreePeriodUnit = 'week' | 'month' | 'year' | 'day'
48
48
  type FriendOfferType = 'coupon_code' | 'coupon' | 'none'
49
- type Gateway = 'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay'
49
+ type Gateway = 'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com'
50
50
  type HierarchyOperationType = 'complete_hierarchy' | 'subordinates' | 'path_to_root'
51
51
  type InvoiceDunningHandling = 'stop' | 'continue'
52
52
  type ItemType = 'charge' | 'addon' | 'plan'
@@ -58,8 +58,8 @@ declare module 'chargebee' {
58
58
  type OperationType = 'add' | 'remove'
59
59
  type PauseOption = 'end_of_term' | 'billing_cycles' | 'immediately' | 'specific_date'
60
60
  type PaymentInitiator = 'merchant' | 'customer'
61
- type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
62
- type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'card'
61
+ type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
62
+ type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
63
63
  type PaymentVoucherType = 'boleto'
64
64
  type PeriodUnit = 'week' | 'month' | 'year' | 'day'
65
65
  type PriceType = 'tax_exclusive' | 'tax_inclusive'
@@ -78,7 +78,7 @@ declare module 'chargebee' {
78
78
  type Taxability = 'taxable' | 'exempt'
79
79
  type TaxjarExemptionCategory = 'other' | 'wholesale' | 'government'
80
80
  type TrialEndAction = 'activate_subscription' | 'plan_default' | 'cancel_subscription' | 'site_default'
81
- type Type = 'giropay' | 'alipay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'card'
81
+ type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
82
82
  type UnbilledChargesHandling = 'invoice' | 'no_action'
83
83
  type UnbilledChargesOption = 'invoice' | 'delete'
84
84
  type UnpaidInvoicesHandling = 'schedule_payment_collection' | 'no_action'