recurly 4.43.0 → 4.45.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.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/.github/codeql/codeql-config.yml +13 -0
- data/.github/workflows/codeql.yml +68 -0
- data/CHANGELOG.md +22 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +35 -0
- data/lib/recurly/requests/invoice_create.rb +1 -1
- data/lib/recurly/requests/purchase_create.rb +1 -1
- data/lib/recurly/requests/subscription_change_create.rb +1 -1
- data/lib/recurly/requests/subscription_create.rb +5 -1
- data/lib/recurly/requests/subscription_update.rb +1 -1
- data/lib/recurly/resources/external_payment_phase.rb +70 -0
- data/lib/recurly/resources/fraud_risk_rule.rb +18 -0
- data/lib/recurly/resources/invoice.rb +2 -2
- data/lib/recurly/resources/line_item.rb +1 -1
- data/lib/recurly/resources/subscription.rb +3 -3
- data/lib/recurly/resources/transaction.rb +4 -0
- data/lib/recurly/resources/transaction_fraud_info.rb +30 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +244 -19
- metadata +9 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 061bfde1bfbf40f6a55902debee5a54f26570c14e1dbea2dd936d669600b5d63
|
4
|
+
data.tar.gz: 1ff7cfb18e36e801df6add13112daf4dd26b1d67a981f4e75884f4b768c0d388
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5edf2471128c95b588a27fcb883cd4700b5595a599a44433a0802139adb2e243f43b075412758e75ffbe2dfbe8119e990a6522ac2bcd77551a9fbcbf36900cb7
|
7
|
+
data.tar.gz: e886772b3052f81ae7ed4eb7c5c8320570d058068f3a036496e832fef01b2ffd7823debb72f4c558948a182e58eb82722812c0b4f3592d94f35d8ea18d30ca3b
|
data/.bumpversion.cfg
CHANGED
@@ -0,0 +1,13 @@
|
|
1
|
+
# Recurly Security and Quality checks
|
2
|
+
#
|
3
|
+
# Customize this file for your project.
|
4
|
+
# Contact the application security team in slack/security channel for assistance.
|
5
|
+
# https://coda.io/d/Information-Security_dDTWpZde3Uu/GitHub-Advanced-Security_suXj4#_lu8Xf
|
6
|
+
# https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan
|
7
|
+
name: "Recurly Security Tests"
|
8
|
+
query-filters:
|
9
|
+
# - exclude:
|
10
|
+
# id: js/redundant-query
|
11
|
+
paths-ignore:
|
12
|
+
- '**/node_modules'
|
13
|
+
- '**/*test*'
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# Managed by Security
|
2
|
+
# Documentation: https://coda.io/d/Information-Security_dDTWpZde3Uu/GitHub-Advanced-Security_suXj4#_lu8Xf
|
3
|
+
# Contact us in the security slack channel for concerns
|
4
|
+
name: "Security check - CodeQL"
|
5
|
+
|
6
|
+
on:
|
7
|
+
pull_request:
|
8
|
+
workflow_dispatch:
|
9
|
+
push:
|
10
|
+
branches:
|
11
|
+
- staging
|
12
|
+
- main
|
13
|
+
- master
|
14
|
+
|
15
|
+
jobs:
|
16
|
+
analyze:
|
17
|
+
name: Analyze
|
18
|
+
runs-on: ubuntu-latest
|
19
|
+
permissions:
|
20
|
+
actions: read
|
21
|
+
contents: read
|
22
|
+
security-events: write
|
23
|
+
|
24
|
+
strategy:
|
25
|
+
fail-fast: false
|
26
|
+
matrix:
|
27
|
+
language: [ 'ruby', 'javascript' ]
|
28
|
+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
|
29
|
+
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
|
30
|
+
|
31
|
+
steps:
|
32
|
+
- name: Checkout repository
|
33
|
+
uses: actions/checkout@v3
|
34
|
+
|
35
|
+
# Initializes the CodeQL tools for scanning.
|
36
|
+
- name: Initialize CodeQL
|
37
|
+
uses: github/codeql-action/init@v2
|
38
|
+
with:
|
39
|
+
languages: ${{ matrix.language }}
|
40
|
+
config-file: ./.github/codeql/codeql-config.yml
|
41
|
+
# If you wish to specify custom queries, you can do so here or in a config file.
|
42
|
+
# By default, queries listed here will override any specified in a config file.
|
43
|
+
# Prefix the list here with "+" to use these queries and those in the config file.
|
44
|
+
|
45
|
+
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
46
|
+
queries: + security-and-quality
|
47
|
+
|
48
|
+
|
49
|
+
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
|
50
|
+
# If this step fails, then you should remove it and run the build manually (see below)
|
51
|
+
- name: Autobuild
|
52
|
+
uses: github/codeql-action/autobuild@v2
|
53
|
+
|
54
|
+
# ℹ️ Command-line programs to run using the OS shell.
|
55
|
+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
56
|
+
|
57
|
+
# If the Autobuild fails above, remove it and uncomment the following three lines.
|
58
|
+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
|
59
|
+
|
60
|
+
# - run: |
|
61
|
+
# echo "Run, Build Application using script"
|
62
|
+
# ./location_of_script_within_repo/buildscript.sh
|
63
|
+
|
64
|
+
- name: Perform CodeQL Analysis
|
65
|
+
uses: github/codeql-action/analyze@v2
|
66
|
+
continue-on-error: true
|
67
|
+
with:
|
68
|
+
category: "/language:${{matrix.language}}"
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,27 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [4.45.0](https://github.com/recurly/recurly-client-ruby/tree/4.45.0) (2024-01-18)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.44.0...4.45.0)
|
6
|
+
|
7
|
+
|
8
|
+
**Merged Pull Requests**
|
9
|
+
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#872](https://github.com/recurly/recurly-client-ruby/pull/872) ([recurly-integrations](https://github.com/recurly-integrations))
|
11
|
+
|
12
|
+
|
13
|
+
|
14
|
+
## [4.44.0](https://github.com/recurly/recurly-client-ruby/tree/4.44.0) (2023-12-06)
|
15
|
+
|
16
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.43.0...4.44.0)
|
17
|
+
|
18
|
+
|
19
|
+
**Merged Pull Requests**
|
20
|
+
|
21
|
+
- Generated Latest Changes for v2021-02-25 (External Payment Phases) [#869](https://github.com/recurly/recurly-client-ruby/pull/869) ([recurly-integrations](https://github.com/recurly-integrations))
|
22
|
+
|
23
|
+
|
24
|
+
|
3
25
|
## [4.43.0](https://github.com/recurly/recurly-client-ruby/tree/4.43.0) (2023-11-07)
|
4
26
|
|
5
27
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.42.0...4.43.0)
|
data/GETTING_STARTED.md
CHANGED
@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
|
|
5
5
|
In your Gemfile, add `recurly` as a dependency.
|
6
6
|
|
7
7
|
```ruby
|
8
|
-
gem 'recurly', '~> 4.
|
8
|
+
gem 'recurly', '~> 4.45'
|
9
9
|
```
|
10
10
|
|
11
11
|
> *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
|
@@ -4433,6 +4433,41 @@ module Recurly
|
|
4433
4433
|
get(path, **options)
|
4434
4434
|
end
|
4435
4435
|
|
4436
|
+
# List the external payment phases on an external subscription
|
4437
|
+
#
|
4438
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscription_external_payment_phases list_external_subscription_external_payment_phases api documentation}
|
4439
|
+
#
|
4440
|
+
# @param external_subscription_id [String] External subscription id
|
4441
|
+
# @param params [Hash] Optional query string parameters:
|
4442
|
+
# :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
|
4443
|
+
# order. In descending order updated records will move behind the cursor and could
|
4444
|
+
# prevent some records from being returned.
|
4445
|
+
#
|
4446
|
+
# :limit [Integer] Limit number of records 1-200.
|
4447
|
+
# :order [String] Sort order.
|
4448
|
+
#
|
4449
|
+
# @return [Pager<Resources::ExternalPaymentPhase>] A list of the the external_payment_phases on a site.
|
4450
|
+
#
|
4451
|
+
def list_external_subscription_external_payment_phases(external_subscription_id:, **options)
|
4452
|
+
path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_payment_phases", external_subscription_id: external_subscription_id)
|
4453
|
+
pager(path, **options)
|
4454
|
+
end
|
4455
|
+
|
4456
|
+
# Fetch an external payment_phase
|
4457
|
+
#
|
4458
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription_external_payment_phase get_external_subscription_external_payment_phase api documentation}
|
4459
|
+
#
|
4460
|
+
# @param external_subscription_id [String] External subscription id
|
4461
|
+
# @param external_payment_phase_id [String] External payment phase ID, e.g. +a34ypb2ef9w1+.
|
4462
|
+
# @param params [Hash] Optional query string parameters:
|
4463
|
+
#
|
4464
|
+
# @return [Resources::ExternalPaymentPhase] Details for an external payment_phase.
|
4465
|
+
#
|
4466
|
+
def get_external_subscription_external_payment_phase(external_subscription_id:, external_payment_phase_id:, **options)
|
4467
|
+
path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}", external_subscription_id: external_subscription_id, external_payment_phase_id: external_payment_phase_id)
|
4468
|
+
get(path, **options)
|
4469
|
+
end
|
4470
|
+
|
4436
4471
|
# List entitlements granted to an account
|
4437
4472
|
#
|
4438
4473
|
# {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}
|
@@ -23,7 +23,7 @@ module Recurly
|
|
23
23
|
define_attribute :currency, String
|
24
24
|
|
25
25
|
# @!attribute net_terms
|
26
|
-
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For
|
26
|
+
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
27
27
|
define_attribute :net_terms, Integer
|
28
28
|
|
29
29
|
# @!attribute net_terms_type
|
@@ -47,7 +47,7 @@ module Recurly
|
|
47
47
|
define_attribute :line_items, Array, { :item_type => :LineItemCreate }
|
48
48
|
|
49
49
|
# @!attribute net_terms
|
50
|
-
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For
|
50
|
+
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
51
51
|
define_attribute :net_terms, Integer
|
52
52
|
|
53
53
|
# @!attribute net_terms_type
|
@@ -27,7 +27,7 @@ module Recurly
|
|
27
27
|
define_attribute :custom_fields, Array, { :item_type => :CustomField }
|
28
28
|
|
29
29
|
# @!attribute net_terms
|
30
|
-
# @return [Integer] Integer normally paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters. For more information
|
30
|
+
# @return [Integer] Integer normally paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
31
31
|
define_attribute :net_terms, Integer
|
32
32
|
|
33
33
|
# @!attribute net_terms_type
|
@@ -46,12 +46,16 @@ module Recurly
|
|
46
46
|
# @return [String] This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
|
47
47
|
define_attribute :customer_notes, String
|
48
48
|
|
49
|
+
# @!attribute gateway_code
|
50
|
+
# @return [String] If present, this subscription's transactions will use the payment gateway with this code.
|
51
|
+
define_attribute :gateway_code, String
|
52
|
+
|
49
53
|
# @!attribute gift_card_redemption_code
|
50
54
|
# @return [String] A gift card redemption code to be redeemed on the purchase invoice.
|
51
55
|
define_attribute :gift_card_redemption_code, String
|
52
56
|
|
53
57
|
# @!attribute net_terms
|
54
|
-
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For
|
58
|
+
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
55
59
|
define_attribute :net_terms, Integer
|
56
60
|
|
57
61
|
# @!attribute net_terms_type
|
@@ -31,7 +31,7 @@ module Recurly
|
|
31
31
|
define_attribute :gateway_code, String
|
32
32
|
|
33
33
|
# @!attribute net_terms
|
34
|
-
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For
|
34
|
+
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
35
35
|
define_attribute :net_terms, Integer
|
36
36
|
|
37
37
|
# @!attribute net_terms_type
|
@@ -0,0 +1,70 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Resources
|
7
|
+
class ExternalPaymentPhase < Resource
|
8
|
+
|
9
|
+
# @!attribute amount
|
10
|
+
# @return [String] Allows up to 9 decimal places
|
11
|
+
define_attribute :amount, String
|
12
|
+
|
13
|
+
# @!attribute created_at
|
14
|
+
# @return [DateTime] When the external subscription was created in Recurly.
|
15
|
+
define_attribute :created_at, DateTime
|
16
|
+
|
17
|
+
# @!attribute currency
|
18
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
19
|
+
define_attribute :currency, String
|
20
|
+
|
21
|
+
# @!attribute ending_billing_period_index
|
22
|
+
# @return [Integer] Ending Billing Period Index
|
23
|
+
define_attribute :ending_billing_period_index, Integer
|
24
|
+
|
25
|
+
# @!attribute ends_at
|
26
|
+
# @return [DateTime] Ends At
|
27
|
+
define_attribute :ends_at, DateTime
|
28
|
+
|
29
|
+
# @!attribute external_subscription
|
30
|
+
# @return [ExternalSubscription] Subscription from an external resource such as Apple App Store or Google Play Store.
|
31
|
+
define_attribute :external_subscription, :ExternalSubscription
|
32
|
+
|
33
|
+
# @!attribute id
|
34
|
+
# @return [String] System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.
|
35
|
+
define_attribute :id, String
|
36
|
+
|
37
|
+
# @!attribute object
|
38
|
+
# @return [String] Object type
|
39
|
+
define_attribute :object, String
|
40
|
+
|
41
|
+
# @!attribute offer_name
|
42
|
+
# @return [String] Name of the discount offer given, e.g. "introductory"
|
43
|
+
define_attribute :offer_name, String
|
44
|
+
|
45
|
+
# @!attribute offer_type
|
46
|
+
# @return [String] Type of discount offer given, e.g. "FREE_TRIAL"
|
47
|
+
define_attribute :offer_type, String
|
48
|
+
|
49
|
+
# @!attribute period_count
|
50
|
+
# @return [Integer] Number of billing periods
|
51
|
+
define_attribute :period_count, Integer
|
52
|
+
|
53
|
+
# @!attribute period_length
|
54
|
+
# @return [String] Billing cycle length
|
55
|
+
define_attribute :period_length, String
|
56
|
+
|
57
|
+
# @!attribute started_at
|
58
|
+
# @return [DateTime] Started At
|
59
|
+
define_attribute :started_at, DateTime
|
60
|
+
|
61
|
+
# @!attribute starting_billing_period_index
|
62
|
+
# @return [Integer] Starting Billing Period Index
|
63
|
+
define_attribute :starting_billing_period_index, Integer
|
64
|
+
|
65
|
+
# @!attribute updated_at
|
66
|
+
# @return [DateTime] When the external subscription was updated in Recurly.
|
67
|
+
define_attribute :updated_at, DateTime
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Resources
|
7
|
+
class FraudRiskRule < Resource
|
8
|
+
|
9
|
+
# @!attribute code
|
10
|
+
# @return [String] The Kount rule number.
|
11
|
+
define_attribute :code, String
|
12
|
+
|
13
|
+
# @!attribute message
|
14
|
+
# @return [String] Description of why the rule was triggered
|
15
|
+
define_attribute :message, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -83,7 +83,7 @@ module Recurly
|
|
83
83
|
define_attribute :line_items, Array, { :item_type => :LineItem }
|
84
84
|
|
85
85
|
# @!attribute net_terms
|
86
|
-
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For
|
86
|
+
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
87
87
|
define_attribute :net_terms, Integer
|
88
88
|
|
89
89
|
# @!attribute net_terms_type
|
@@ -139,7 +139,7 @@ module Recurly
|
|
139
139
|
define_attribute :tax, Float
|
140
140
|
|
141
141
|
# @!attribute tax_info
|
142
|
-
# @return [TaxInfo]
|
142
|
+
# @return [TaxInfo] Only for merchants using Recurly's In-The-Box taxes.
|
143
143
|
define_attribute :tax_info, :TaxInfo
|
144
144
|
|
145
145
|
# @!attribute terms_and_conditions
|
@@ -191,7 +191,7 @@ module Recurly
|
|
191
191
|
define_attribute :tax_inclusive, :Boolean
|
192
192
|
|
193
193
|
# @!attribute tax_info
|
194
|
-
# @return [TaxInfo]
|
194
|
+
# @return [TaxInfo] Only for merchants using Recurly's In-The-Box taxes.
|
195
195
|
define_attribute :tax_info, :TaxInfo
|
196
196
|
|
197
197
|
# @!attribute taxable
|
@@ -107,7 +107,7 @@ module Recurly
|
|
107
107
|
define_attribute :id, String
|
108
108
|
|
109
109
|
# @!attribute net_terms
|
110
|
-
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For
|
110
|
+
# @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
111
111
|
define_attribute :net_terms, Integer
|
112
112
|
|
113
113
|
# @!attribute net_terms_type
|
@@ -175,7 +175,7 @@ module Recurly
|
|
175
175
|
define_attribute :subtotal, Float
|
176
176
|
|
177
177
|
# @!attribute tax
|
178
|
-
# @return [Float]
|
178
|
+
# @return [Float] Only for merchants using Recurly's In-The-Box taxes.
|
179
179
|
define_attribute :tax, Float
|
180
180
|
|
181
181
|
# @!attribute tax_inclusive
|
@@ -183,7 +183,7 @@ module Recurly
|
|
183
183
|
define_attribute :tax_inclusive, :Boolean
|
184
184
|
|
185
185
|
# @!attribute tax_info
|
186
|
-
# @return [TaxInfo]
|
186
|
+
# @return [TaxInfo] Only for merchants using Recurly's In-The-Box taxes.
|
187
187
|
define_attribute :tax_info, :TaxInfo
|
188
188
|
|
189
189
|
# @!attribute terms_and_conditions
|
@@ -58,6 +58,10 @@ module Recurly
|
|
58
58
|
# @return [String] When processed, result from checking the CVV/CVC value on the transaction.
|
59
59
|
define_attribute :cvv_check, String
|
60
60
|
|
61
|
+
# @!attribute fraud_info
|
62
|
+
# @return [TransactionFraudInfo] Fraud information
|
63
|
+
define_attribute :fraud_info, :TransactionFraudInfo
|
64
|
+
|
61
65
|
# @!attribute gateway_approval_code
|
62
66
|
# @return [String] Transaction approval code from the payment gateway.
|
63
67
|
define_attribute :gateway_approval_code, String
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Resources
|
7
|
+
class TransactionFraudInfo < Resource
|
8
|
+
|
9
|
+
# @!attribute decision
|
10
|
+
# @return [String] Kount decision
|
11
|
+
define_attribute :decision, String
|
12
|
+
|
13
|
+
# @!attribute object
|
14
|
+
# @return [String] Object type
|
15
|
+
define_attribute :object, String
|
16
|
+
|
17
|
+
# @!attribute reference
|
18
|
+
# @return [String] Kount transaction reference ID
|
19
|
+
define_attribute :reference, String
|
20
|
+
|
21
|
+
# @!attribute risk_rules_triggered
|
22
|
+
# @return [Array[FraudRiskRule]] A list of fraud risk rules that were triggered for the transaction.
|
23
|
+
define_attribute :risk_rules_triggered, Array, { :item_type => :FraudRiskRule }
|
24
|
+
|
25
|
+
# @!attribute score
|
26
|
+
# @return [Integer] Kount score
|
27
|
+
define_attribute :score, Integer
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -207,6 +207,7 @@ x-tagGroups:
|
|
207
207
|
- external_products
|
208
208
|
- external_accounts
|
209
209
|
- external_product_references
|
210
|
+
- external_payment_phases
|
210
211
|
- name: Products and Promotions
|
211
212
|
tags:
|
212
213
|
- item
|
@@ -366,6 +367,11 @@ tags:
|
|
366
367
|
x-displayName: External Product Reference
|
367
368
|
description: Associates an external product to a corresponding resource on an external
|
368
369
|
platform like the Apple App Store or Google Play Store.
|
370
|
+
- name: external_payment_phases
|
371
|
+
x-displayName: External Payment Phase
|
372
|
+
description: Details of payments in the lifecycle of a subscription from an external
|
373
|
+
resource that is not managed by the Recurly platform, e.g. App Store or Google
|
374
|
+
Play Store.
|
369
375
|
- name: gift_cards
|
370
376
|
x-displayName: Gift Cards
|
371
377
|
description: Add gift card purchases to your checkout and allow gift card recipients
|
@@ -15918,6 +15924,69 @@ paths:
|
|
15918
15924
|
schema:
|
15919
15925
|
"$ref": "#/components/schemas/Error"
|
15920
15926
|
x-code-samples: []
|
15927
|
+
"/external_subscriptions/{external_subscription_id}/external_payment_phases":
|
15928
|
+
parameters:
|
15929
|
+
- "$ref": "#/components/parameters/external_subscription_id"
|
15930
|
+
get:
|
15931
|
+
tags:
|
15932
|
+
- external_subscriptions
|
15933
|
+
operationId: list_external_subscription_external_payment_phases
|
15934
|
+
summary: List the external payment phases on an external subscription
|
15935
|
+
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
15936
|
+
to learn how to use pagination in the API and Client Libraries.
|
15937
|
+
parameters:
|
15938
|
+
- "$ref": "#/components/parameters/sort_dates"
|
15939
|
+
- "$ref": "#/components/parameters/limit"
|
15940
|
+
- "$ref": "#/components/parameters/order"
|
15941
|
+
responses:
|
15942
|
+
'200':
|
15943
|
+
description: A list of the the external_payment_phases on a site.
|
15944
|
+
content:
|
15945
|
+
application/json:
|
15946
|
+
schema:
|
15947
|
+
"$ref": "#/components/schemas/ExternalPaymentPhaseList"
|
15948
|
+
'404':
|
15949
|
+
description: Incorrect site.
|
15950
|
+
content:
|
15951
|
+
application/json:
|
15952
|
+
schema:
|
15953
|
+
"$ref": "#/components/schemas/Error"
|
15954
|
+
default:
|
15955
|
+
description: Unexpected error.
|
15956
|
+
content:
|
15957
|
+
application/json:
|
15958
|
+
schema:
|
15959
|
+
"$ref": "#/components/schemas/Error"
|
15960
|
+
x-code-samples: []
|
15961
|
+
"/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}":
|
15962
|
+
parameters:
|
15963
|
+
- "$ref": "#/components/parameters/external_subscription_id"
|
15964
|
+
- "$ref": "#/components/parameters/external_payment_phase_id"
|
15965
|
+
get:
|
15966
|
+
tags:
|
15967
|
+
- external_payment_phases
|
15968
|
+
operationId: get_external_subscription_external_payment_phase
|
15969
|
+
summary: Fetch an external payment_phase
|
15970
|
+
responses:
|
15971
|
+
'200':
|
15972
|
+
description: Details for an external payment_phase.
|
15973
|
+
content:
|
15974
|
+
application/json:
|
15975
|
+
schema:
|
15976
|
+
"$ref": "#/components/schemas/ExternalPaymentPhase"
|
15977
|
+
'404':
|
15978
|
+
description: Incorrect site or external subscription ID.
|
15979
|
+
content:
|
15980
|
+
application/json:
|
15981
|
+
schema:
|
15982
|
+
"$ref": "#/components/schemas/Error"
|
15983
|
+
default:
|
15984
|
+
description: Unexpected error.
|
15985
|
+
content:
|
15986
|
+
application/json:
|
15987
|
+
schema:
|
15988
|
+
"$ref": "#/components/schemas/Error"
|
15989
|
+
x-code-samples: []
|
15921
15990
|
"/accounts/{account_id}/entitlements":
|
15922
15991
|
parameters:
|
15923
15992
|
- "$ref": "#/components/parameters/account_id"
|
@@ -16355,6 +16424,13 @@ components:
|
|
16355
16424
|
required: true
|
16356
16425
|
schema:
|
16357
16426
|
type: string
|
16427
|
+
external_payment_phase_id:
|
16428
|
+
name: external_payment_phase_id
|
16429
|
+
in: path
|
16430
|
+
description: External payment phase ID, e.g. `a34ypb2ef9w1`.
|
16431
|
+
required: true
|
16432
|
+
schema:
|
16433
|
+
type: string
|
16358
16434
|
invoice_template_id:
|
16359
16435
|
name: invoice_template_id
|
16360
16436
|
in: path
|
@@ -19346,16 +19422,19 @@ components:
|
|
19346
19422
|
Integer paired with `Net Terms Type` and representing the number
|
19347
19423
|
of days past the current date (for `net` Net Terms Type) or days after
|
19348
19424
|
the last day of the current month (for `eom` Net Terms Type) that the
|
19349
|
-
invoice will become past due. For
|
19425
|
+
invoice will become past due. For `manual` collection method, an additional 24 hours is
|
19350
19426
|
added to ensure the customer has the entire last day to make payment before
|
19351
|
-
becoming past due.
|
19427
|
+
becoming past due. For example:
|
19352
19428
|
|
19353
19429
|
If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
|
19354
19430
|
If an invoice is due `net 30`, it will become past due at 31 days exactly.
|
19355
19431
|
If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
|
19356
19432
|
|
19433
|
+
For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
|
19357
19434
|
When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
|
19358
|
-
|
19435
|
+
|
19436
|
+
For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
|
19437
|
+
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
19359
19438
|
minimum: 0
|
19360
19439
|
default: 0
|
19361
19440
|
net_terms_type:
|
@@ -19541,16 +19620,19 @@ components:
|
|
19541
19620
|
Integer paired with `Net Terms Type` and representing the number
|
19542
19621
|
of days past the current date (for `net` Net Terms Type) or days after
|
19543
19622
|
the last day of the current month (for `eom` Net Terms Type) that the
|
19544
|
-
invoice will become past due. For
|
19623
|
+
invoice will become past due. For `manual` collection method, an additional 24 hours is
|
19545
19624
|
added to ensure the customer has the entire last day to make payment before
|
19546
|
-
becoming past due.
|
19625
|
+
becoming past due. For example:
|
19547
19626
|
|
19548
19627
|
If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
|
19549
19628
|
If an invoice is due `net 30`, it will become past due at 31 days exactly.
|
19550
19629
|
If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
|
19551
19630
|
|
19631
|
+
For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
|
19552
19632
|
When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
|
19553
|
-
|
19633
|
+
|
19634
|
+
For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
|
19635
|
+
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
19554
19636
|
minimum: 0
|
19555
19637
|
default: 0
|
19556
19638
|
net_terms_type:
|
@@ -21633,6 +21715,7 @@ components:
|
|
21633
21715
|
type: number
|
21634
21716
|
format: float
|
21635
21717
|
title: Estimated tax
|
21718
|
+
description: Only for merchants using Recurly's In-The-Box taxes.
|
21636
21719
|
tax_info:
|
21637
21720
|
"$ref": "#/components/schemas/TaxInfo"
|
21638
21721
|
total:
|
@@ -21656,16 +21739,19 @@ components:
|
|
21656
21739
|
Integer paired with `Net Terms Type` and representing the number
|
21657
21740
|
of days past the current date (for `net` Net Terms Type) or days after
|
21658
21741
|
the last day of the current month (for `eom` Net Terms Type) that the
|
21659
|
-
invoice will become past due. For
|
21742
|
+
invoice will become past due. For `manual` collection method, an additional 24 hours is
|
21660
21743
|
added to ensure the customer has the entire last day to make payment before
|
21661
|
-
becoming past due.
|
21744
|
+
becoming past due. For example:
|
21662
21745
|
|
21663
21746
|
If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
|
21664
21747
|
If an invoice is due `net 30`, it will become past due at 31 days exactly.
|
21665
21748
|
If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
|
21666
21749
|
|
21750
|
+
For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
|
21667
21751
|
When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
|
21668
|
-
|
21752
|
+
|
21753
|
+
For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
|
21754
|
+
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
21669
21755
|
minimum: 0
|
21670
21756
|
default: 0
|
21671
21757
|
net_terms_type:
|
@@ -22237,7 +22323,8 @@ components:
|
|
22237
22323
|
month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription
|
22238
22324
|
change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters.
|
22239
22325
|
|
22240
|
-
For more information
|
22326
|
+
For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
|
22327
|
+
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
22241
22328
|
minimum: 0
|
22242
22329
|
default: 0
|
22243
22330
|
net_terms_type:
|
@@ -22450,20 +22537,29 @@ components:
|
|
22450
22537
|
Integer paired with `Net Terms Type` and representing the number
|
22451
22538
|
of days past the current date (for `net` Net Terms Type) or days after
|
22452
22539
|
the last day of the current month (for `eom` Net Terms Type) that the
|
22453
|
-
invoice will become past due. For
|
22540
|
+
invoice will become past due. For `manual` collection method, an additional 24 hours is
|
22454
22541
|
added to ensure the customer has the entire last day to make payment before
|
22455
|
-
becoming past due.
|
22542
|
+
becoming past due. For example:
|
22456
22543
|
|
22457
22544
|
If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
|
22458
22545
|
If an invoice is due `net 30`, it will become past due at 31 days exactly.
|
22459
22546
|
If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
|
22460
22547
|
|
22548
|
+
For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
|
22461
22549
|
When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
|
22462
|
-
|
22550
|
+
|
22551
|
+
For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
|
22552
|
+
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
22463
22553
|
minimum: 0
|
22464
22554
|
default: 0
|
22465
22555
|
net_terms_type:
|
22466
22556
|
"$ref": "#/components/schemas/NetTermsTypeEnum"
|
22557
|
+
gateway_code:
|
22558
|
+
type: string
|
22559
|
+
title: Gateway Code
|
22560
|
+
description: If present, this subscription's transactions will use the payment
|
22561
|
+
gateway with this code.
|
22562
|
+
maxLength: 13
|
22467
22563
|
transaction_type:
|
22468
22564
|
description: An optional type designation for the payment gateway transaction
|
22469
22565
|
created by this request. Supports 'moto' value, which is the acronym for
|
@@ -22637,16 +22733,19 @@ components:
|
|
22637
22733
|
Integer paired with `Net Terms Type` and representing the number
|
22638
22734
|
of days past the current date (for `net` Net Terms Type) or days after
|
22639
22735
|
the last day of the current month (for `eom` Net Terms Type) that the
|
22640
|
-
invoice will become past due. For
|
22736
|
+
invoice will become past due. For `manual` collection method, an additional 24 hours is
|
22641
22737
|
added to ensure the customer has the entire last day to make payment before
|
22642
|
-
becoming past due.
|
22738
|
+
becoming past due. For example:
|
22643
22739
|
|
22644
22740
|
If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
|
22645
22741
|
If an invoice is due `net 30`, it will become past due at 31 days exactly.
|
22646
22742
|
If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
|
22647
22743
|
|
22744
|
+
For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
|
22648
22745
|
When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
|
22649
|
-
|
22746
|
+
|
22747
|
+
For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
|
22748
|
+
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
22650
22749
|
minimum: 0
|
22651
22750
|
default: 0
|
22652
22751
|
net_terms_type:
|
@@ -22805,6 +22904,7 @@ components:
|
|
22805
22904
|
TaxInfo:
|
22806
22905
|
type: object
|
22807
22906
|
title: Tax info
|
22907
|
+
description: Only for merchants using Recurly's In-The-Box taxes.
|
22808
22908
|
properties:
|
22809
22909
|
type:
|
22810
22910
|
type: string
|
@@ -23070,6 +23170,44 @@ components:
|
|
23070
23170
|
For all other countries this will come from the VAT Number field in the
|
23071
23171
|
Billing Info.
|
23072
23172
|
title: VAT Number
|
23173
|
+
fraud_info:
|
23174
|
+
"$ref": "#/components/schemas/TransactionFraudInfo"
|
23175
|
+
TransactionFraudInfo:
|
23176
|
+
type: object
|
23177
|
+
title: Fraud information
|
23178
|
+
readOnly: true
|
23179
|
+
properties:
|
23180
|
+
object:
|
23181
|
+
type: string
|
23182
|
+
title: Object type
|
23183
|
+
readOnly: true
|
23184
|
+
score:
|
23185
|
+
type: integer
|
23186
|
+
title: Kount score
|
23187
|
+
minimum: 1
|
23188
|
+
maximum: 99
|
23189
|
+
decision:
|
23190
|
+
title: Kount decision
|
23191
|
+
maxLength: 10
|
23192
|
+
"$ref": "#/components/schemas/KountDecisionEnum"
|
23193
|
+
reference:
|
23194
|
+
type: string
|
23195
|
+
title: Kount transaction reference ID
|
23196
|
+
risk_rules_triggered:
|
23197
|
+
type: array
|
23198
|
+
title: Risk Rules Triggered
|
23199
|
+
description: A list of fraud risk rules that were triggered for the transaction.
|
23200
|
+
items:
|
23201
|
+
"$ref": "#/components/schemas/FraudRiskRule"
|
23202
|
+
FraudRiskRule:
|
23203
|
+
type: object
|
23204
|
+
properties:
|
23205
|
+
code:
|
23206
|
+
type: string
|
23207
|
+
title: The Kount rule number.
|
23208
|
+
message:
|
23209
|
+
type: string
|
23210
|
+
title: Description of why the rule was triggered
|
23073
23211
|
ExternalTransaction:
|
23074
23212
|
type: object
|
23075
23213
|
properties:
|
@@ -23373,16 +23511,19 @@ components:
|
|
23373
23511
|
Integer paired with `Net Terms Type` and representing the number
|
23374
23512
|
of days past the current date (for `net` Net Terms Type) or days after
|
23375
23513
|
the last day of the current month (for `eom` Net Terms Type) that the
|
23376
|
-
invoice will become past due. For
|
23514
|
+
invoice will become past due. For `manual` collection method, an additional 24 hours is
|
23377
23515
|
added to ensure the customer has the entire last day to make payment before
|
23378
|
-
becoming past due.
|
23516
|
+
becoming past due. For example:
|
23379
23517
|
|
23380
23518
|
If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
|
23381
23519
|
If an invoice is due `net 30`, it will become past due at 31 days exactly.
|
23382
23520
|
If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
|
23383
23521
|
|
23522
|
+
For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
|
23384
23523
|
When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
|
23385
|
-
|
23524
|
+
|
23525
|
+
For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
|
23526
|
+
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
|
23386
23527
|
minimum: 0
|
23387
23528
|
default: 0
|
23388
23529
|
net_terms_type:
|
@@ -23646,6 +23787,90 @@ components:
|
|
23646
23787
|
type: string
|
23647
23788
|
format: date-time
|
23648
23789
|
description: Time the object was last updated
|
23790
|
+
ExternalPaymentPhase:
|
23791
|
+
type: object
|
23792
|
+
description: Details of payments in the lifecycle of a subscription from an
|
23793
|
+
external resource that is not managed by the Recurly platform, e.g. App Store
|
23794
|
+
or Google Play Store.
|
23795
|
+
properties:
|
23796
|
+
id:
|
23797
|
+
type: string
|
23798
|
+
title: External payment phase ID
|
23799
|
+
description: System-generated unique identifier for an external payment
|
23800
|
+
phase ID, e.g. `e28zov4fw0v2`.
|
23801
|
+
object:
|
23802
|
+
type: string
|
23803
|
+
title: Object type
|
23804
|
+
external_subscription:
|
23805
|
+
"$ref": "#/components/schemas/ExternalSubscription"
|
23806
|
+
started_at:
|
23807
|
+
type: string
|
23808
|
+
format: date-time
|
23809
|
+
title: Started At
|
23810
|
+
ends_at:
|
23811
|
+
type: string
|
23812
|
+
format: date-time
|
23813
|
+
title: Ends At
|
23814
|
+
starting_billing_period_index:
|
23815
|
+
type: integer
|
23816
|
+
title: Starting Billing Period Index
|
23817
|
+
ending_billing_period_index:
|
23818
|
+
type: integer
|
23819
|
+
title: Ending Billing Period Index
|
23820
|
+
offer_type:
|
23821
|
+
type: string
|
23822
|
+
title: Offer Type
|
23823
|
+
description: Type of discount offer given, e.g. "FREE_TRIAL"
|
23824
|
+
offer_name:
|
23825
|
+
type: string
|
23826
|
+
title: Offer Name
|
23827
|
+
description: Name of the discount offer given, e.g. "introductory"
|
23828
|
+
period_count:
|
23829
|
+
type: integer
|
23830
|
+
title: Period Count
|
23831
|
+
description: Number of billing periods
|
23832
|
+
period_length:
|
23833
|
+
type: string
|
23834
|
+
title: Period Length
|
23835
|
+
description: Billing cycle length
|
23836
|
+
amount:
|
23837
|
+
type: string
|
23838
|
+
format: decimal
|
23839
|
+
title: Amount
|
23840
|
+
minimum: 0
|
23841
|
+
description: Allows up to 9 decimal places
|
23842
|
+
currency:
|
23843
|
+
type: string
|
23844
|
+
title: Currency
|
23845
|
+
description: 3-letter ISO 4217 currency code.
|
23846
|
+
maxLength: 3
|
23847
|
+
created_at:
|
23848
|
+
type: string
|
23849
|
+
format: date-time
|
23850
|
+
title: Created at
|
23851
|
+
description: When the external subscription was created in Recurly.
|
23852
|
+
updated_at:
|
23853
|
+
type: string
|
23854
|
+
format: date-time
|
23855
|
+
title: Updated at
|
23856
|
+
description: When the external subscription was updated in Recurly.
|
23857
|
+
ExternalPaymentPhaseList:
|
23858
|
+
type: object
|
23859
|
+
properties:
|
23860
|
+
object:
|
23861
|
+
type: string
|
23862
|
+
title: Object type
|
23863
|
+
description: Will always be List.
|
23864
|
+
has_more:
|
23865
|
+
type: boolean
|
23866
|
+
description: Indicates there are more results on subsequent pages.
|
23867
|
+
next:
|
23868
|
+
type: string
|
23869
|
+
description: Path to subsequent page of results.
|
23870
|
+
data:
|
23871
|
+
type: array
|
23872
|
+
items:
|
23873
|
+
"$ref": "#/components/schemas/ExternalPaymentPhase"
|
23649
23874
|
ExternalProduct:
|
23650
23875
|
type: object
|
23651
23876
|
description: Product from an external resource such as Apple App Store or Google
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: recurly
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.
|
4
|
+
version: 4.45.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Recurly
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -119,7 +119,9 @@ files:
|
|
119
119
|
- ".changelog_config.yaml"
|
120
120
|
- ".github/ISSUE_TEMPLATE/bug-report.md"
|
121
121
|
- ".github/ISSUE_TEMPLATE/question-or-other.md"
|
122
|
+
- ".github/codeql/codeql-config.yml"
|
122
123
|
- ".github/workflows/ci.yml"
|
124
|
+
- ".github/workflows/codeql.yml"
|
123
125
|
- ".github/workflows/docs.yml"
|
124
126
|
- ".github/workflows/pr-review.yml"
|
125
127
|
- ".gitignore"
|
@@ -268,11 +270,13 @@ files:
|
|
268
270
|
- lib/recurly/resources/external_account.rb
|
269
271
|
- lib/recurly/resources/external_charge.rb
|
270
272
|
- lib/recurly/resources/external_invoice.rb
|
273
|
+
- lib/recurly/resources/external_payment_phase.rb
|
271
274
|
- lib/recurly/resources/external_product.rb
|
272
275
|
- lib/recurly/resources/external_product_reference_collection.rb
|
273
276
|
- lib/recurly/resources/external_product_reference_mini.rb
|
274
277
|
- lib/recurly/resources/external_subscription.rb
|
275
278
|
- lib/recurly/resources/fraud_info.rb
|
279
|
+
- lib/recurly/resources/fraud_risk_rule.rb
|
276
280
|
- lib/recurly/resources/gateway_attributes.rb
|
277
281
|
- lib/recurly/resources/gift_card.rb
|
278
282
|
- lib/recurly/resources/gift_card_delivery.rb
|
@@ -315,6 +319,7 @@ files:
|
|
315
319
|
- lib/recurly/resources/tier_pricing.rb
|
316
320
|
- lib/recurly/resources/transaction.rb
|
317
321
|
- lib/recurly/resources/transaction_error.rb
|
322
|
+
- lib/recurly/resources/transaction_fraud_info.rb
|
318
323
|
- lib/recurly/resources/transaction_payment_gateway.rb
|
319
324
|
- lib/recurly/resources/unique_coupon_code.rb
|
320
325
|
- lib/recurly/resources/unique_coupon_code_params.rb
|
@@ -345,7 +350,7 @@ metadata:
|
|
345
350
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
346
351
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
347
352
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
348
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
353
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.45.0
|
349
354
|
post_install_message:
|
350
355
|
rdoc_options: []
|
351
356
|
require_paths:
|
@@ -361,7 +366,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
361
366
|
- !ruby/object:Gem::Version
|
362
367
|
version: '0'
|
363
368
|
requirements: []
|
364
|
-
rubygems_version: 3.4.
|
369
|
+
rubygems_version: 3.4.10
|
365
370
|
signing_key:
|
366
371
|
specification_version: 4
|
367
372
|
summary: The ruby client for Recurly's V3 API
|