recurly 4.84.0 → 4.85.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/CHANGELOG.md +11 -344
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/requests/subscription_create.rb +4 -0
- data/lib/recurly/requests/subscription_purchase.rb +12 -0
- data/lib/recurly/requests/subscription_update.rb +4 -0
- data/lib/recurly/resources/external_product_mini.rb +22 -0
- data/lib/recurly/resources/external_subscription.rb +8 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +47 -0
- metadata +4 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 405e9807e5dd53076ab3d64c13ae1b5e5d20e655df8379e38e287cfa913c01a5
|
|
4
|
+
data.tar.gz: 94dc4f27e270c5bac7ab91194adb350897b53b4dca417b9321a0b091d03a7d8d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7198bfcc4d95da718cc78fdcd9a165c79a6a93a246cb0f06d4602214e95b180c77173a73fd09a6da047ec2e772c360ae4952ca20a977c8b427a0338bd0c9ee60
|
|
7
|
+
data.tar.gz: 34c583f6601e51c58b1802bf5809b6fd9702eef536d75b6fe2cdc5bcef45c3ab434a67e7dde31cd1d5d08b2449d35435c276e3de5030ea14801cd56bf5ba3a56
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.85.0](https://github.com/recurly/recurly-client-ruby/tree/4.85.0) (2026-10-22)
|
|
4
|
+
|
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.84.0...4.85.0)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Merged Pull Requests**
|
|
9
|
+
|
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#973](https://github.com/recurly/recurly-client-ruby/pull/973) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
3
14
|
## [4.84.0](https://github.com/recurly/recurly-client-ruby/tree/4.84.0) (2026-10-08)
|
|
4
15
|
|
|
5
16
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.83.0...4.84.0)
|
|
@@ -688,350 +699,6 @@
|
|
|
688
699
|
|
|
689
700
|
## [4.22.0](https://github.com/recurly/recurly-client-ruby/tree/4.22.0) (2022-10-21)
|
|
690
701
|
|
|
691
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.21.1...4.22.0)
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
**Merged Pull Requests**
|
|
695
|
-
|
|
696
|
-
- Generated Latest Changes for v2021-02-25(Decimal Usage and Quantities and DunningEvent new fields) [#801](https://github.com/recurly/recurly-client-ruby/pull/801) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
## [4.21.1](https://github.com/recurly/recurly-client-ruby/tree/4.21.1) (2022-09-08)
|
|
701
|
-
|
|
702
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.21.0...4.21.1)
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
**Merged Pull Requests**
|
|
706
|
-
|
|
707
|
-
- Generated Latest Changes for v2021-02-25 [#792](https://github.com/recurly/recurly-client-ruby/pull/792) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
## [4.21.0](https://github.com/recurly/recurly-client-ruby/tree/4.21.0) (2022-09-07)
|
|
712
|
-
|
|
713
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.20.0...4.21.0)
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
**Merged Pull Requests**
|
|
717
|
-
|
|
718
|
-
- Generated Latest Changes for v2021-02-25 [#790](https://github.com/recurly/recurly-client-ruby/pull/790) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
719
|
-
- Fixes bug with put_dunning_campaign_bulk_update [#788](https://github.com/recurly/recurly-client-ruby/pull/788) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
## [4.20.0](https://github.com/recurly/recurly-client-ruby/tree/4.20.0) (2022-08-03)
|
|
724
|
-
|
|
725
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.19.0...4.20.0)
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
**Merged Pull Requests**
|
|
729
|
-
|
|
730
|
-
- Generated Latest Changes for v2021-02-25 [#783](https://github.com/recurly/recurly-client-ruby/pull/783) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
## [4.19.0](https://github.com/recurly/recurly-client-ruby/tree/4.19.0) (2022-07-11)
|
|
735
|
-
|
|
736
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.18.0...4.19.0)
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
**Merged Pull Requests**
|
|
740
|
-
|
|
741
|
-
- Generated Latest Changes for v2021-02-25 [#778](https://github.com/recurly/recurly-client-ruby/pull/778) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
## [4.18.0](https://github.com/recurly/recurly-client-ruby/tree/4.18.0) (2022-06-16)
|
|
746
|
-
|
|
747
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.17.0...4.18.0)
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
**Merged Pull Requests**
|
|
751
|
-
|
|
752
|
-
- Generated Latest Changes for v2021-02-25 [#776](https://github.com/recurly/recurly-client-ruby/pull/776) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
## [4.17.0](https://github.com/recurly/recurly-client-ruby/tree/4.17.0) (2022-04-15)
|
|
757
|
-
|
|
758
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.16.0...4.17.0)
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
**Merged Pull Requests**
|
|
762
|
-
|
|
763
|
-
- Generated Latest Changes for v2021-02-25 [#766](https://github.com/recurly/recurly-client-ruby/pull/766) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
## [4.16.0](https://github.com/recurly/recurly-client-ruby/tree/4.16.0) (2022-03-24)
|
|
768
|
-
|
|
769
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.15.0...4.16.0)
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
**Merged Pull Requests**
|
|
773
|
-
|
|
774
|
-
- Generated Latest Changes for v2021-02-25 (Percentage tiers feature) [#762](https://github.com/recurly/recurly-client-ruby/pull/762) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
## [4.15.0](https://github.com/recurly/recurly-client-ruby/tree/4.15.0) (2022-03-14)
|
|
779
|
-
|
|
780
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.14.0...4.15.0)
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
**Merged Pull Requests**
|
|
784
|
-
|
|
785
|
-
- Generated Latest Changes for v2021-02-25 (Percentage tiers feature) [#757](https://github.com/recurly/recurly-client-ruby/pull/757) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
## [4.14.0](https://github.com/recurly/recurly-client-ruby/tree/4.14.0) (2022-03-03)
|
|
790
|
-
|
|
791
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.13.0...4.14.0)
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
**Merged Pull Requests**
|
|
795
|
-
|
|
796
|
-
- Generated Latest Changes for v2021-02-25 [#753](https://github.com/recurly/recurly-client-ruby/pull/753) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
## [4.13.0](https://github.com/recurly/recurly-client-ruby/tree/4.13.0) (2022-01-31)
|
|
801
|
-
|
|
802
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.12.0...4.13.0)
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
**Merged Pull Requests**
|
|
806
|
-
|
|
807
|
-
- Generated Latest Changes for v2021-02-25 [#747](https://github.com/recurly/recurly-client-ruby/pull/747) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
808
|
-
- Add region argument to client to connect in EU data center [#744](https://github.com/recurly/recurly-client-ruby/pull/744) ([FabricioCoutinho](https://github.com/FabricioCoutinho))
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
## [4.12.0](https://github.com/recurly/recurly-client-ruby/tree/4.12.0) (2022-01-28)
|
|
813
|
-
|
|
814
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.11.0...4.12.0)
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
**Merged Pull Requests**
|
|
818
|
-
|
|
819
|
-
- Generated Latest Changes for v2021-02-25 (Invoice Customization) [#746](https://github.com/recurly/recurly-client-ruby/pull/746) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
820
|
-
- Generated Latest Changes for v2021-02-25 [#743](https://github.com/recurly/recurly-client-ruby/pull/743) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
## [4.11.0](https://github.com/recurly/recurly-client-ruby/tree/4.11.0) (2021-12-29)
|
|
825
|
-
|
|
826
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.10.0...4.11.0)
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
**Merged Pull Requests**
|
|
830
|
-
|
|
831
|
-
- Generated Latest Changes for v2021-02-25 (Tax Inclusive Pricing) [#741](https://github.com/recurly/recurly-client-ruby/pull/741) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
## [4.10.0](https://github.com/recurly/recurly-client-ruby/tree/4.10.0) (2021-11-22)
|
|
836
|
-
|
|
837
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.9.0...4.10.0)
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
**Merged Pull Requests**
|
|
841
|
-
|
|
842
|
-
- Generated Latest Changes for v2021-02-25 [#739](https://github.com/recurly/recurly-client-ruby/pull/739) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
843
|
-
- Generated Latest Changes for v2021-02-25 [#736](https://github.com/recurly/recurly-client-ruby/pull/736) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
844
|
-
- Allow API base url configuration [#735](https://github.com/recurly/recurly-client-ruby/pull/735) ([cbarton](https://github.com/cbarton))
|
|
845
|
-
- Generated Latest Changes for v2021-02-25 [#734](https://github.com/recurly/recurly-client-ruby/pull/734) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
846
|
-
- Generated Latest Changes for v2021-02-25 [#728](https://github.com/recurly/recurly-client-ruby/pull/728) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
## [4.9.0](https://github.com/recurly/recurly-client-ruby/tree/4.9.0) (2021-09-16)
|
|
851
|
-
|
|
852
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.8.0...4.9.0)
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
**Merged Pull Requests**
|
|
856
|
-
|
|
857
|
-
- Generated Latest Changes for v2021-02-25 (Support to new subscription fields and response) [#725](https://github.com/recurly/recurly-client-ruby/pull/725) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
## [4.8.0](https://github.com/recurly/recurly-client-ruby/tree/4.8.0) (2021-09-01)
|
|
862
|
-
|
|
863
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.7.0...4.8.0)
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
**Merged Pull Requests**
|
|
867
|
-
|
|
868
|
-
- Generated Latest Changes for v2021-02-25 (Dunning Campaigns feature) [#724](https://github.com/recurly/recurly-client-ruby/pull/724) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
## [4.7.0](https://github.com/recurly/recurly-client-ruby/tree/4.7.0) (2021-08-19)
|
|
873
|
-
|
|
874
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.6.0...4.7.0)
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
**Merged Pull Requests**
|
|
878
|
-
|
|
879
|
-
- Generated Latest Changes for v2021-02-25 (get_preview_renewal) [#722](https://github.com/recurly/recurly-client-ruby/pull/722) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
## [4.6.0](https://github.com/recurly/recurly-client-ruby/tree/4.6.0) (2021-08-11)
|
|
884
|
-
|
|
885
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.5.0...4.6.0)
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
**Merged Pull Requests**
|
|
889
|
-
|
|
890
|
-
- Generated Latest Changes for v2021-02-25 [#720](https://github.com/recurly/recurly-client-ruby/pull/720) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
## [4.5.0](https://github.com/recurly/recurly-client-ruby/tree/4.5.0) (2021-08-02)
|
|
895
|
-
|
|
896
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.4.0...4.5.0)
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
**Merged Pull Requests**
|
|
900
|
-
|
|
901
|
-
- Generated Latest Changes for v2021-02-25 [#714](https://github.com/recurly/recurly-client-ruby/pull/714) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
## [4.4.0](https://github.com/recurly/recurly-client-ruby/tree/4.4.0) (2021-06-15)
|
|
906
|
-
|
|
907
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.3.0...4.4.0)
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
**Merged Pull Requests**
|
|
911
|
-
|
|
912
|
-
- Generated Latest Changes for v2021-02-25 [#705](https://github.com/recurly/recurly-client-ruby/pull/705) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
## [4.3.0](https://github.com/recurly/recurly-client-ruby/tree/4.3.0) (2021-06-04)
|
|
917
|
-
|
|
918
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.2.0...4.3.0)
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
**Merged Pull Requests**
|
|
922
|
-
|
|
923
|
-
- Generated Latest Changes for v2021-02-25 [#702](https://github.com/recurly/recurly-client-ruby/pull/702) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
924
|
-
- Making #post allow a nil body [#699](https://github.com/recurly/recurly-client-ruby/pull/699) ([douglasmiller](https://github.com/douglasmiller))
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
## [4.2.0](https://github.com/recurly/recurly-client-ruby/tree/4.2.0) (2021-04-21)
|
|
929
|
-
|
|
930
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.1.0...4.2.0)
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
**Merged Pull Requests**
|
|
934
|
-
|
|
935
|
-
- Generated Latest Changes for v2021-02-25 [#695](https://github.com/recurly/recurly-client-ruby/pull/695) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
## [4.1.0](https://github.com/recurly/recurly-client-ruby/tree/4.1.0) (2021-04-14)
|
|
940
|
-
|
|
941
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.0.1...4.1.0)
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
**Merged Pull Requests**
|
|
945
|
-
|
|
946
|
-
- Generated Latest Changes for v2021-02-25 (Backup Payment Method) [#691](https://github.com/recurly/recurly-client-ruby/pull/691) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
947
|
-
- Generated Latest Changes for v2021-02-25 [#687](https://github.com/recurly/recurly-client-ruby/pull/687) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
948
|
-
- Restoring NetworkError and it's derivatives [#685](https://github.com/recurly/recurly-client-ruby/pull/685) ([douglasmiller](https://github.com/douglasmiller))
|
|
949
|
-
- Generated Latest Changes for v2021-02-25 (Usage Percentage on Tiers) [#683](https://github.com/recurly/recurly-client-ruby/pull/683) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
950
|
-
- Fixes TypeError caused by attempts to Base64 encode nil @api_key values [#672](https://github.com/recurly/recurly-client-ruby/pull/672) ([alexfulsome](https://github.com/alexfulsome))
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
## [4.0.1](https://github.com/recurly/recurly-client-ruby/tree/4.0.1) (2021-03-19)
|
|
955
|
-
|
|
956
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.0.0...4.0.1)
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
**Merged Pull Requests**
|
|
960
702
|
|
|
961
|
-
- Release 4.0.1 [#682](https://github.com/recurly/recurly-client-ruby/pull/682) ([douglasmiller](https://github.com/douglasmiller))
|
|
962
|
-
- More ruby 3.0 [#680](https://github.com/recurly/recurly-client-ruby/pull/680) ([douglasmiller](https://github.com/douglasmiller))
|
|
963
|
-
- Generated Latest Changes for v2021-02-25 [#678](https://github.com/recurly/recurly-client-ruby/pull/678) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
964
|
-
- Sync updates not ported from 3.x client [#671](https://github.com/recurly/recurly-client-ruby/pull/671) ([douglasmiller](https://github.com/douglasmiller))
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
## [4.0.0](https://github.com/recurly/recurly-client-ruby/tree/4.0.0) (2021-03-01)
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
# Major Version Release
|
|
972
|
-
|
|
973
|
-
The 4.x major version of the client pairs with the `v2021-02-25` API version. This version of the client and the API contain breaking changes that should be considered before upgrading your integration.
|
|
974
|
-
|
|
975
|
-
## Breaking Changes in the API
|
|
976
|
-
All changes to the core API are documented in the [Developer Portal changelog](https://developers.recurly.com/api/changelog.html#v2021-02-25---current-ga-version)
|
|
977
|
-
|
|
978
|
-
## Breaking Changes in Client
|
|
979
|
-
|
|
980
|
-
- Remove `site_id` and `subdomain` from client initializer. [#624]
|
|
981
|
-
- Remove `set_site_id` method from client. [#627]
|
|
982
|
-
- Classify unexpected error responses from Recurly API via an HTTP status code mapping provided in `Recurly::Errors::ERROR_MAP`. [#616]
|
|
983
|
-
- Remove `NetworkError` class. All error classes now extend the `APIError`. This means that the order of multiple rescue blocks will need to be re-considered. [#616]
|
|
984
|
-
|
|
985
|
-
### 3.x
|
|
986
|
-
|
|
987
|
-
```ruby
|
|
988
|
-
rescue Recurly::Errors::ValidationError => ex
|
|
989
|
-
# catch a validation error
|
|
990
|
-
rescue Recurly::Errors::APIError => ex
|
|
991
|
-
# catch a generic api error
|
|
992
|
-
rescue Recurly::Errors::TimeoutError => ex
|
|
993
|
-
# catch a specific network error
|
|
994
|
-
```
|
|
995
|
-
|
|
996
|
-
### 4.x
|
|
997
|
-
|
|
998
|
-
```ruby
|
|
999
|
-
rescue Recurly::Errors::ValidationError => ex
|
|
1000
|
-
# catch a validation error
|
|
1001
|
-
rescue Recurly::Errors::TimeoutError => ex
|
|
1002
|
-
# catch a specific network error
|
|
1003
|
-
rescue Recurly::Errors::APIError => ex
|
|
1004
|
-
# catch a generic api error
|
|
1005
|
-
```
|
|
1006
|
-
|
|
1007
|
-
- Rename `InvalidResponseError` to `InvalidContentTypeError`. [#616]
|
|
1008
|
-
- Rename `UnavailableError` to `ServiceUnavailableError`. [#616]
|
|
1009
|
-
- Reorganize top-level keys of the optional parameters hash to improve clarity and create space for additional options. [#619]
|
|
1010
|
-
|
|
1011
|
-
### 3.x
|
|
1012
|
-
|
|
1013
|
-
```ruby
|
|
1014
|
-
options = {
|
|
1015
|
-
limit: 200,
|
|
1016
|
-
headers: {
|
|
1017
|
-
'Accept-Language' => 'fr'
|
|
1018
|
-
}
|
|
1019
|
-
}
|
|
1020
|
-
accounts = @client.list_accounts(options)
|
|
1021
|
-
```
|
|
1022
|
-
|
|
1023
|
-
### 4.x
|
|
1024
|
-
|
|
1025
|
-
```ruby
|
|
1026
|
-
options = {
|
|
1027
|
-
params: {
|
|
1028
|
-
limit: 200
|
|
1029
|
-
}
|
|
1030
|
-
headers: {
|
|
1031
|
-
'Accept-Language' => 'fr'
|
|
1032
|
-
}
|
|
1033
|
-
}
|
|
1034
|
-
accounts = @client.list_accounts(options)
|
|
1035
|
-
```
|
|
1036
703
|
|
|
1037
704
|
|
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.85'
|
|
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.
|
|
@@ -153,6 +153,10 @@ module Recurly
|
|
|
153
153
|
# @!attribute unit_amount
|
|
154
154
|
# @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
|
|
155
155
|
define_attribute :unit_amount, Float
|
|
156
|
+
|
|
157
|
+
# @!attribute vat_reverse_charge_notes
|
|
158
|
+
# @return [String] This will default to the VAT reverse charge notes text specified on the Invoice Settings. Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.
|
|
159
|
+
define_attribute :vat_reverse_charge_notes, String
|
|
156
160
|
end
|
|
157
161
|
end
|
|
158
162
|
end
|
|
@@ -26,6 +26,10 @@ module Recurly
|
|
|
26
26
|
# @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
|
|
27
27
|
define_attribute :custom_fields, Array, { :item_type => :CustomField }
|
|
28
28
|
|
|
29
|
+
# @!attribute customer_notes
|
|
30
|
+
# @return [String] Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
|
|
31
|
+
define_attribute :customer_notes, String
|
|
32
|
+
|
|
29
33
|
# @!attribute next_bill_date
|
|
30
34
|
# @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
|
|
31
35
|
define_attribute :next_bill_date, DateTime
|
|
@@ -74,6 +78,10 @@ module Recurly
|
|
|
74
78
|
# @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
|
|
75
79
|
define_attribute :tax_inclusive, :Boolean
|
|
76
80
|
|
|
81
|
+
# @!attribute terms_and_conditions
|
|
82
|
+
# @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
|
|
83
|
+
define_attribute :terms_and_conditions, String
|
|
84
|
+
|
|
77
85
|
# @!attribute total_billing_cycles
|
|
78
86
|
# @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
|
|
79
87
|
define_attribute :total_billing_cycles, Integer
|
|
@@ -85,6 +93,10 @@ module Recurly
|
|
|
85
93
|
# @!attribute unit_amount
|
|
86
94
|
# @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
|
|
87
95
|
define_attribute :unit_amount, Float
|
|
96
|
+
|
|
97
|
+
# @!attribute vat_reverse_charge_notes
|
|
98
|
+
# @return [String] Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.
|
|
99
|
+
define_attribute :vat_reverse_charge_notes, String
|
|
88
100
|
end
|
|
89
101
|
end
|
|
90
102
|
end
|
|
@@ -81,6 +81,10 @@ module Recurly
|
|
|
81
81
|
# @!attribute transaction_descriptor_suffix
|
|
82
82
|
# @return [String] Optionally overrides the suffix component of the composed transaction descriptor. If omitted, the suffix is derived from the subscription's plan name or the invoice description, with a Trial prefix on Visa trial conversions. Subject to gateway availability and payment method support.
|
|
83
83
|
define_attribute :transaction_descriptor_suffix, String
|
|
84
|
+
|
|
85
|
+
# @!attribute vat_reverse_charge_notes
|
|
86
|
+
# @return [String] Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.
|
|
87
|
+
define_attribute :vat_reverse_charge_notes, String
|
|
84
88
|
end
|
|
85
89
|
end
|
|
86
90
|
end
|
|
@@ -0,0 +1,22 @@
|
|
|
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 ExternalProductMini < Resource
|
|
8
|
+
|
|
9
|
+
# @!attribute id
|
|
10
|
+
# @return [String] External product ID
|
|
11
|
+
define_attribute :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute name
|
|
14
|
+
# @return [String] The merchant-facing name of the external product.
|
|
15
|
+
define_attribute :name, String
|
|
16
|
+
|
|
17
|
+
# @!attribute object
|
|
18
|
+
# @return [String] Object type
|
|
19
|
+
define_attribute :object, String
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -42,6 +42,10 @@ module Recurly
|
|
|
42
42
|
# @return [Array[ExternalPaymentPhase]] The phases of the external subscription payment lifecycle.
|
|
43
43
|
define_attribute :external_payment_phases, Array, { :item_type => :ExternalPaymentPhase }
|
|
44
44
|
|
|
45
|
+
# @!attribute external_product
|
|
46
|
+
# @return [ExternalProductMini] Just the important parts.
|
|
47
|
+
define_attribute :external_product, :ExternalProductMini
|
|
48
|
+
|
|
45
49
|
# @!attribute external_product_reference
|
|
46
50
|
# @return [ExternalProductReferenceMini] External Product Reference details
|
|
47
51
|
define_attribute :external_product_reference, :ExternalProductReferenceMini
|
|
@@ -66,6 +70,10 @@ module Recurly
|
|
|
66
70
|
# @return [String] Object type
|
|
67
71
|
define_attribute :object, String
|
|
68
72
|
|
|
73
|
+
# @!attribute plan
|
|
74
|
+
# @return [PlanMini] Just the important parts.
|
|
75
|
+
define_attribute :plan, :PlanMini
|
|
76
|
+
|
|
69
77
|
# @!attribute quantity
|
|
70
78
|
# @return [Integer] An indication of the quantity of a subscribed item's quantity.
|
|
71
79
|
define_attribute :quantity, Integer
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
|
@@ -35526,6 +35526,12 @@ components:
|
|
|
35526
35526
|
description: If there are pending credits on the account that will be invoiced
|
|
35527
35527
|
during the subscription creation, these will be used as the Customer Notes
|
|
35528
35528
|
on the credit invoice.
|
|
35529
|
+
vat_reverse_charge_notes:
|
|
35530
|
+
type: string
|
|
35531
|
+
title: VAT reverse charge notes
|
|
35532
|
+
description: This will default to the VAT reverse charge notes text specified
|
|
35533
|
+
on the Invoice Settings. Specify custom notes to add or override VAT reverse
|
|
35534
|
+
charge notes. Custom notes will stay with a subscription on all renewals.
|
|
35529
35535
|
po_number:
|
|
35530
35536
|
type: string
|
|
35531
35537
|
title: Purchase order number
|
|
@@ -35699,6 +35705,21 @@ components:
|
|
|
35699
35705
|
"$ref": "#/components/schemas/SubscriptionRampInterval"
|
|
35700
35706
|
credit_application_policy:
|
|
35701
35707
|
"$ref": "#/components/schemas/CreditApplicationPolicy"
|
|
35708
|
+
terms_and_conditions:
|
|
35709
|
+
type: string
|
|
35710
|
+
title: Terms and conditions
|
|
35711
|
+
description: Specify custom notes to add or override Terms and Conditions.
|
|
35712
|
+
Custom notes will stay with a subscription on all renewals.
|
|
35713
|
+
customer_notes:
|
|
35714
|
+
type: string
|
|
35715
|
+
title: Customer notes
|
|
35716
|
+
description: Specify custom notes to add or override Customer Notes. Custom
|
|
35717
|
+
notes will stay with a subscription on all renewals.
|
|
35718
|
+
vat_reverse_charge_notes:
|
|
35719
|
+
type: string
|
|
35720
|
+
title: VAT reverse charge notes
|
|
35721
|
+
description: Specify custom notes to add or override VAT reverse charge
|
|
35722
|
+
notes. Custom notes will stay with a subscription on all renewals.
|
|
35702
35723
|
bulk:
|
|
35703
35724
|
type: boolean
|
|
35704
35725
|
description: Optional field to be used only when needing to bypass the 60
|
|
@@ -35755,6 +35776,11 @@ components:
|
|
|
35755
35776
|
title: Customer notes
|
|
35756
35777
|
description: Specify custom notes to add or override Customer Notes. Custom
|
|
35757
35778
|
notes will stay with a subscription on all renewals.
|
|
35779
|
+
vat_reverse_charge_notes:
|
|
35780
|
+
type: string
|
|
35781
|
+
title: VAT reverse charge notes
|
|
35782
|
+
description: Specify custom notes to add or override VAT reverse charge
|
|
35783
|
+
notes. Custom notes will stay with a subscription on all renewals.
|
|
35758
35784
|
po_number:
|
|
35759
35785
|
type: string
|
|
35760
35786
|
title: Purchase order number
|
|
@@ -37407,6 +37433,23 @@ components:
|
|
|
37407
37433
|
format: date-time
|
|
37408
37434
|
description: Last updated at
|
|
37409
37435
|
readOnly: true
|
|
37436
|
+
ExternalProductMini:
|
|
37437
|
+
type: object
|
|
37438
|
+
title: External product mini details
|
|
37439
|
+
description: Just the important parts.
|
|
37440
|
+
properties:
|
|
37441
|
+
id:
|
|
37442
|
+
type: string
|
|
37443
|
+
title: External product ID
|
|
37444
|
+
readOnly: true
|
|
37445
|
+
object:
|
|
37446
|
+
type: string
|
|
37447
|
+
title: Object type
|
|
37448
|
+
readOnly: true
|
|
37449
|
+
name:
|
|
37450
|
+
type: string
|
|
37451
|
+
title: Name
|
|
37452
|
+
description: The merchant-facing name of the external product.
|
|
37410
37453
|
ExternalProductReferenceMini:
|
|
37411
37454
|
type: object
|
|
37412
37455
|
title: External Product Reference details
|
|
@@ -37469,6 +37512,10 @@ components:
|
|
|
37469
37512
|
"$ref": "#/components/schemas/AccountMini"
|
|
37470
37513
|
external_product_reference:
|
|
37471
37514
|
"$ref": "#/components/schemas/ExternalProductReferenceMini"
|
|
37515
|
+
external_product:
|
|
37516
|
+
"$ref": "#/components/schemas/ExternalProductMini"
|
|
37517
|
+
plan:
|
|
37518
|
+
"$ref": "#/components/schemas/PlanMini"
|
|
37472
37519
|
external_payment_phases:
|
|
37473
37520
|
type: array
|
|
37474
37521
|
title: External payment phases
|
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.85.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Recurly
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-10-
|
|
11
|
+
date: 2026-10-22 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: base64
|
|
@@ -327,6 +327,7 @@ files:
|
|
|
327
327
|
- lib/recurly/resources/external_invoice.rb
|
|
328
328
|
- lib/recurly/resources/external_payment_phase.rb
|
|
329
329
|
- lib/recurly/resources/external_product.rb
|
|
330
|
+
- lib/recurly/resources/external_product_mini.rb
|
|
330
331
|
- lib/recurly/resources/external_product_reference_collection.rb
|
|
331
332
|
- lib/recurly/resources/external_product_reference_mini.rb
|
|
332
333
|
- lib/recurly/resources/external_subscription.rb
|
|
@@ -414,7 +415,7 @@ metadata:
|
|
|
414
415
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
|
415
416
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
|
416
417
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
|
417
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
|
418
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.85.0
|
|
418
419
|
post_install_message:
|
|
419
420
|
rdoc_options: []
|
|
420
421
|
require_paths:
|