payabli 3.0.4 → 3.0.6
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/.fern/metadata.json +4 -4
- data/lib/payabli/bill/client.rb +119 -0
- data/lib/payabli/boarding/client.rb +209 -0
- data/lib/payabli/charge_backs/client.rb +20 -0
- data/lib/payabli/check_capture/client.rb +10 -0
- data/lib/payabli/client.rb +8 -6
- data/lib/payabli/cloud/client.rb +29 -0
- data/lib/payabli/customer/client.rb +54 -0
- data/lib/payabli/export/client.rb +321 -0
- data/lib/payabli/funding/client.rb +9 -0
- data/lib/payabli/ghost_card/client.rb +31 -0
- data/lib/payabli/hosted_payment_pages/client.rb +23 -0
- data/lib/payabli/import/client.rb +15 -0
- data/lib/payabli/internal/http/raw_client.rb +26 -0
- data/lib/payabli/internal/oauth_provider.rb +8 -2
- data/lib/payabli/internal/routing_auth_provider.rb +51 -0
- data/lib/payabli/invoice/client.rb +118 -0
- data/lib/payabli/line_item/client.rb +43 -0
- data/lib/payabli/management/client.rb +13 -0
- data/lib/payabli/money_in/client.rb +238 -0
- data/lib/payabli/money_out/client.rb +94 -0
- data/lib/payabli/notification/client.rb +46 -0
- data/lib/payabli/notificationlogs/client.rb +27 -0
- data/lib/payabli/ocr/client.rb +10 -0
- data/lib/payabli/organization/client.rb +91 -0
- data/lib/payabli/payment_link/client.rb +367 -0
- data/lib/payabli/payment_method_domain/client.rb +56 -0
- data/lib/payabli/payout_subscription/client.rb +50 -0
- data/lib/payabli/paypoint/client.rb +56 -0
- data/lib/payabli/query/client.rb +414 -0
- data/lib/payabli/statistic/client.rb +39 -0
- data/lib/payabli/subscription/client.rb +46 -0
- data/lib/payabli/templates/client.rb +28 -0
- data/lib/payabli/token/client.rb +8 -0
- data/lib/payabli/token_storage/client.rb +55 -0
- data/lib/payabli/types/application_data.rb +1 -1
- data/lib/payabli/types/application_data_managed.rb +1 -1
- data/lib/payabli/types/application_data_odp.rb +1 -1
- data/lib/payabli/types/application_data_pay_in.rb +1 -1
- data/lib/payabli/types/on_create.rb +1 -1
- data/lib/payabli/types/pay_method_body_all_fields.rb +1 -1
- data/lib/payabli/user/client.rb +67 -0
- data/lib/payabli/vendor/client.rb +102 -0
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli/wallet/client.rb +34 -0
- data/lib/payabli.rb +1 -0
- data/reference.md +219 -219
- data/wiremock/wiremock-mappings.json +32 -1302
- metadata +3 -2
|
@@ -31,6 +31,117 @@ module Payabli
|
|
|
31
31
|
# @option params [String, nil] :mail_2
|
|
32
32
|
# @option params [String, nil] :idempotency_key
|
|
33
33
|
#
|
|
34
|
+
# @example
|
|
35
|
+
# client.payment_link.add_pay_link_from_invoice(
|
|
36
|
+
# id_invoice: 23548884,
|
|
37
|
+
# mail_2: "jo@example.com; ceo@example.com",
|
|
38
|
+
# contact_us: {
|
|
39
|
+
# email_label: "Email",
|
|
40
|
+
# enabled: true,
|
|
41
|
+
# header: "Contact Us",
|
|
42
|
+
# order: 0,
|
|
43
|
+
# payment_icons: true,
|
|
44
|
+
# phone_label: "Phone"
|
|
45
|
+
# },
|
|
46
|
+
# invoices: {
|
|
47
|
+
# enabled: true,
|
|
48
|
+
# invoice_link: {
|
|
49
|
+
# enabled: true,
|
|
50
|
+
# label: "View Invoice",
|
|
51
|
+
# order: 0
|
|
52
|
+
# },
|
|
53
|
+
# order: 0,
|
|
54
|
+
# view_invoice_details: {
|
|
55
|
+
# enabled: true,
|
|
56
|
+
# label: "Invoice Details",
|
|
57
|
+
# order: 0
|
|
58
|
+
# }
|
|
59
|
+
# },
|
|
60
|
+
# logo: {
|
|
61
|
+
# enabled: true,
|
|
62
|
+
# order: 0
|
|
63
|
+
# },
|
|
64
|
+
# message_before_paying: {
|
|
65
|
+
# enabled: true,
|
|
66
|
+
# label: "Please review your payment details",
|
|
67
|
+
# order: 0
|
|
68
|
+
# },
|
|
69
|
+
# notes: {
|
|
70
|
+
# enabled: true,
|
|
71
|
+
# header: "Additional Notes",
|
|
72
|
+
# order: 0,
|
|
73
|
+
# placeholder: "Enter any additional notes here",
|
|
74
|
+
# value: ""
|
|
75
|
+
# },
|
|
76
|
+
# page: {
|
|
77
|
+
# description: "Complete your payment securely",
|
|
78
|
+
# enabled: true,
|
|
79
|
+
# header: "Payment Page",
|
|
80
|
+
# order: 0
|
|
81
|
+
# },
|
|
82
|
+
# payment_button: {
|
|
83
|
+
# enabled: true,
|
|
84
|
+
# label: "Pay Now",
|
|
85
|
+
# order: 0
|
|
86
|
+
# },
|
|
87
|
+
# payment_methods: {
|
|
88
|
+
# all_methods_checked: true,
|
|
89
|
+
# enabled: true,
|
|
90
|
+
# header: "Payment Methods",
|
|
91
|
+
# methods: {
|
|
92
|
+
# amex: true,
|
|
93
|
+
# apple_pay: true,
|
|
94
|
+
# discover: true,
|
|
95
|
+
# e_check: true,
|
|
96
|
+
# mastercard: true,
|
|
97
|
+
# visa: true
|
|
98
|
+
# },
|
|
99
|
+
# order: 0,
|
|
100
|
+
# settings: {
|
|
101
|
+
# apple_pay: {
|
|
102
|
+
# button_style: "black",
|
|
103
|
+
# button_type: "pay",
|
|
104
|
+
# language: "en-US"
|
|
105
|
+
# }
|
|
106
|
+
# }
|
|
107
|
+
# },
|
|
108
|
+
# payor: {
|
|
109
|
+
# enabled: true,
|
|
110
|
+
# fields: [{
|
|
111
|
+
# display: true,
|
|
112
|
+
# fixed: true,
|
|
113
|
+
# identifier: true,
|
|
114
|
+
# label: "Full Name",
|
|
115
|
+
# name: "fullName",
|
|
116
|
+
# order: 0,
|
|
117
|
+
# required: true,
|
|
118
|
+
# validation: "alpha",
|
|
119
|
+
# value: "",
|
|
120
|
+
# width: 0
|
|
121
|
+
# }],
|
|
122
|
+
# header: "Payor Information",
|
|
123
|
+
# order: 0
|
|
124
|
+
# },
|
|
125
|
+
# review: {
|
|
126
|
+
# enabled: true,
|
|
127
|
+
# header: "Review Payment",
|
|
128
|
+
# order: 0
|
|
129
|
+
# },
|
|
130
|
+
# settings: {
|
|
131
|
+
# color: "#000000",
|
|
132
|
+
# custom_css_url: "https://example.com/custom.css",
|
|
133
|
+
# language: "en",
|
|
134
|
+
# page_logo: {
|
|
135
|
+
# f_content: "PHN2ZyB2aWV3Qm94PSIwIDAgODAwIDEwMDAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiAgPCEtLSBCYWNrZ3JvdW5kIC0tPgogIDxyZWN0IHdpZHRoPSI4MDAiIGhlaWdodD0iMTAwMCIgZmlsbD0id2hpdGUiLz4KICAKICA8IS0tIENvbXBhbnkgSGVhZGVyIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI2MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjI0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+R3J1enlhIEFkdmVudHVyZSBPdXRmaXR0ZXJzPC90ZXh0PgogIDxsaW5lIHgxPSI0MCIgeTE9IjgwIiB4Mj0iNzYwIiB5Mj0iODAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIyIi8+CiAgCiAgPCEtLSBDb21wYW55IERldGFpbHMgLS0+CiAgPHRleHQgeD0iNDAiIHk9IjExMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4xMjMgTW91bnRhaW4gVmlldyBSb2FkPC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxMzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+VGJpbGlzaSwgR2VvcmdpYSAwMTA1PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxNTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+VGVsOiArOTk1IDMyIDEyMyA0NTY3PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxNzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+RW1haWw6IGluZm9AZ3J1enlhYWR2ZW50dXJlcy5jb208L3RleHQ+CgogIDwhLS0gSW52b2ljZSBUaXRsZSAtLT4KICA8dGV4dCB4PSI2MDAiIHk9IjExMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjI0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+SU5WT0lDRTwvdGV4dD4KICA8dGV4dCB4PSI2MDAiIHk9IjE0MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5EYXRlOiAxMi8xMS8yMDI0PC90ZXh0PgogIDx0ZXh0IHg9IjYwMCIgeT0iMTYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPkludm9pY2UgIzogR1JaLTIwMjQtMTEyMzwvdGV4dD4KCiAgPCEtLSBCaWxsIFRvIFNlY3Rpb24gLS0+CiAgPHRleHQgeD0iNDAiIHk9IjIyMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE2IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+QklMTCBUTzo8L3RleHQ+CiAgPHJlY3QgeD0iNDAiIHk9IjIzNSIgd2lkdGg9IjMwMCIgaGVpZ2h0PSI4MCIgZmlsbD0iI2Y3ZjlmYSIvPgogIDx0ZXh0IHg9IjUwIiB5PSIyNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+W0N1c3RvbWVyIE5hbWVdPC90ZXh0PgogIDx0ZXh0IHg9IjUwIiB5PSIyODAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+W0FkZHJlc3MgTGluZSAxXTwvdGV4dD4KICA8dGV4dCB4PSI1MCIgeT0iMzAwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPltDaXR5LCBDb3VudHJ5XTwvdGV4dD4KCiAgPCEtLSBUYWJsZSBIZWFkZXJzIC0tPgogIDxyZWN0IHg9IjQwIiB5PSIzNDAiIHdpZHRoPSI3MjAiIGhlaWdodD0iMzAiIGZpbGw9IiMyYzNlNTAiLz4KICA8dGV4dCB4PSI1MCIgeT0iMzYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBmaWxsPSJ3aGl0ZSI+RGVzY3JpcHRpb248L3RleHQ+CiAgPHRleHQgeD0iNDUwIiB5PSIzNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IndoaXRlIj5RdWFudGl0eTwvdGV4dD4KICA8dGV4dCB4PSI1NTAiIHk9IjM2MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0id2hpdGUiPlJhdGU8L3RleHQ+CiAgPHRleHQgeD0iNjgwIiB5PSIzNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IndoaXRlIj5BbW91bnQ8L3RleHQ+CgogIDwhLS0gVGFibGUgUm93cyAtLT4KICA8cmVjdCB4PSI0MCIgeT0iMzcwIiB3aWR0aD0iNzIwIiBoZWlnaHQ9IjMwIiBmaWxsPSIjZjdmOWZhIi8+CiAgPHRleHQgeD0iNTAiIHk9IjM5MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5Nb3VudGFpbiBDbGltYmluZyBFcXVpcG1lbnQgUmVudGFsPC90ZXh0PgogIDx0ZXh0IHg9IjQ1MCIgeT0iMzkwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPjE8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSIzOTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDI1MC4wMDwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjM5MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kMjUwLjAwPC90ZXh0PgoKICA8cmVjdCB4PSI0MCIgeT0iNDAwIiB3aWR0aD0iNzIwIiBoZWlnaHQ9IjMwIiBmaWxsPSJ3aGl0ZSIvPgogIDx0ZXh0IHg9IjUwIiB5PSI0MjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+R3VpZGVkIFRyZWsgUGFja2FnZSAtIDIgRGF5czwvdGV4dD4KICA8dGV4dCB4PSI0NTAiIHk9IjQyMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4xPC90ZXh0PgogIDx0ZXh0IHg9IjU1MCIgeT0iNDIwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPiQ0MDAuMDA8L3RleHQ+CiAgPHRleHQgeD0iNjgwIiB5PSI0MjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDQwMC4wMDwvdGV4dD4KCiAgPHJlY3QgeD0iNDAiIHk9IjQzMCIgd2lkdGg9IjcyMCIgaGVpZ2h0PSIzMCIgZmlsbD0iI2Y3ZjlmYSIvPgogIDx0ZXh0IHg9IjUwIiB5PSI0NTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+U2FmZXR5IEVxdWlwbWVudCBQYWNrYWdlPC90ZXh0PgogIDx0ZXh0IHg9IjQ1MCIgeT0iNDUwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPjE8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSI0NTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDE1MC4wMDwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjQ1MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kMTUwLjAwPC90ZXh0PgoKICA8IS0tIFRvdGFscyAtLT4KICA8bGluZSB4MT0iNDAiIHkxPSI0ODAiIHgyPSI3NjAiIHkyPSI0ODAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIxIi8+CiAgPHRleHQgeD0iNTUwIiB5PSI1MTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMzNDQ5NWUiPlN1YnRvdGFsOjwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjUxMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kODAwLjAwPC90ZXh0PgogIDx0ZXh0IHg9IjU1MCIgeT0iNTM1IiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBmaWxsPSIjMzQ0OTVlIj5UYXggKDE4JSk6PC90ZXh0PgogIDx0ZXh0IHg9IjY4MCIgeT0iNTM1IiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPiQxNDQuMDA8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSI1NzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPlRvdGFsOjwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjU3MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE2IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+JDk0NC4wMDwvdGV4dD4KCiAgPCEtLSBQYXltZW50IFRlcm1zIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI2NDAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPlBheW1lbnQgVGVybXM8L3RleHQ+CiAgPHRleHQgeD0iNDAiIHk9IjY3MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5QYXltZW50IGlzIGR1ZSB3aXRoaW4gMzAgZGF5czwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNjkwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPlBsZWFzZSBpbmNsdWRlIGludm9pY2UgbnVtYmVyIG9uIHBheW1lbnQ8L3RleHQ+CgogIDwhLS0gQmFuayBEZXRhaWxzIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI3MzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPkJhbmsgRGV0YWlsczwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNzYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPkJhbms6IEJhbmsgb2YgR2VvcmdpYTwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNzgwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPklCQU46IEdFMTIzNDU2Nzg5MDEyMzQ1Njc4PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSI4MDAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+U1dJRlQ6IEJBR0FHRTIyPC90ZXh0PgoKICA8IS0tIEZvb3RlciAtLT4KICA8bGluZSB4MT0iNDAiIHkxPSI5MDAiIHgyPSI3NjAiIHkyPSI5MDAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIxIi8+CiAgPHRleHQgeD0iNDAiIHk9IjkzMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjEyIiBmaWxsPSIjN2Y4YzhkIj5UaGFuayB5b3UgZm9yIGNob29zaW5nIEdydXp5YSBBZHZlbnR1cmUgT3V0Zml0dGVyczwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iOTUwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTIiIGZpbGw9IiM3ZjhjOGQiPnd3dy5ncnV6eWFhZHZlbnR1cmVzLmNvbTwvdGV4dD4KPC9zdmc+Cg==",
|
|
136
|
+
# filename: "logo.jpg",
|
|
137
|
+
# ftype: "jpg",
|
|
138
|
+
# furl: ""
|
|
139
|
+
# },
|
|
140
|
+
# redirect_after_approve: true,
|
|
141
|
+
# redirect_after_approve_url: "https://example.com/success"
|
|
142
|
+
# }
|
|
143
|
+
# )
|
|
144
|
+
#
|
|
34
145
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
35
146
|
def add_pay_link_from_invoice(request_options: {}, **params)
|
|
36
147
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -45,6 +156,7 @@ module Payabli
|
|
|
45
156
|
headers = {}
|
|
46
157
|
headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
|
|
47
158
|
|
|
159
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }]).merge(headers)
|
|
48
160
|
request = Payabli::Internal::JSON::Request.new(
|
|
49
161
|
base_url: request_options[:base_url],
|
|
50
162
|
method: "POST",
|
|
@@ -83,6 +195,70 @@ module Payabli
|
|
|
83
195
|
# @option params [String, nil] :mail_2
|
|
84
196
|
# @option params [String, nil] :idempotency_key
|
|
85
197
|
#
|
|
198
|
+
# @example
|
|
199
|
+
# client.payment_link.add_pay_link_from_bill(
|
|
200
|
+
# bill_id: 54323,
|
|
201
|
+
# mail_2: "jo@example.com; ceo@example.com",
|
|
202
|
+
# contact_us: {
|
|
203
|
+
# email_label: "Email",
|
|
204
|
+
# enabled: true,
|
|
205
|
+
# header: "Contact Us",
|
|
206
|
+
# order: 0,
|
|
207
|
+
# payment_icons: true,
|
|
208
|
+
# phone_label: "Phone"
|
|
209
|
+
# },
|
|
210
|
+
# logo: {
|
|
211
|
+
# enabled: true,
|
|
212
|
+
# order: 0
|
|
213
|
+
# },
|
|
214
|
+
# message_before_paying: {
|
|
215
|
+
# enabled: true,
|
|
216
|
+
# label: "Please review your payment details",
|
|
217
|
+
# order: 0
|
|
218
|
+
# },
|
|
219
|
+
# notes: {
|
|
220
|
+
# enabled: true,
|
|
221
|
+
# header: "Additional Notes",
|
|
222
|
+
# order: 0,
|
|
223
|
+
# placeholder: "Enter any additional notes here",
|
|
224
|
+
# value: ""
|
|
225
|
+
# },
|
|
226
|
+
# page: {
|
|
227
|
+
# description: "Get paid securely",
|
|
228
|
+
# enabled: true,
|
|
229
|
+
# header: "Payment Page",
|
|
230
|
+
# order: 0
|
|
231
|
+
# },
|
|
232
|
+
# payment_button: {
|
|
233
|
+
# enabled: true,
|
|
234
|
+
# label: "Pay Now",
|
|
235
|
+
# order: 0
|
|
236
|
+
# },
|
|
237
|
+
# payment_methods: {
|
|
238
|
+
# all_methods_checked: true,
|
|
239
|
+
# allow_multiple_methods: true,
|
|
240
|
+
# default_method: "vcard",
|
|
241
|
+
# enabled: true,
|
|
242
|
+
# header: "Payment Methods",
|
|
243
|
+
# methods: {
|
|
244
|
+
# ach: true,
|
|
245
|
+
# check: true,
|
|
246
|
+
# vcard: true
|
|
247
|
+
# },
|
|
248
|
+
# order: 0,
|
|
249
|
+
# show_preview_virtual_card: true
|
|
250
|
+
# },
|
|
251
|
+
# review: {
|
|
252
|
+
# enabled: true,
|
|
253
|
+
# header: "Review Payment",
|
|
254
|
+
# order: 0
|
|
255
|
+
# },
|
|
256
|
+
# settings: {
|
|
257
|
+
# color: "#000000",
|
|
258
|
+
# language: "en"
|
|
259
|
+
# }
|
|
260
|
+
# )
|
|
261
|
+
#
|
|
86
262
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
87
263
|
def add_pay_link_from_bill(request_options: {}, **params)
|
|
88
264
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -98,6 +274,7 @@ module Payabli
|
|
|
98
274
|
headers = {}
|
|
99
275
|
headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
|
|
100
276
|
|
|
277
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }]).merge(headers)
|
|
101
278
|
request = Payabli::Internal::JSON::Request.new(
|
|
102
279
|
base_url: request_options[:base_url],
|
|
103
280
|
method: "POST",
|
|
@@ -132,13 +309,18 @@ module Payabli
|
|
|
132
309
|
# @option request_options [Integer] :timeout_in_seconds
|
|
133
310
|
# @option params [String] :pay_link_id
|
|
134
311
|
#
|
|
312
|
+
# @example
|
|
313
|
+
# client.payment_link.delete_pay_link_from_id(pay_link_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234")
|
|
314
|
+
#
|
|
135
315
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
136
316
|
def delete_pay_link_from_id(request_options: {}, **params)
|
|
137
317
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
318
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
138
319
|
request = Payabli::Internal::JSON::Request.new(
|
|
139
320
|
base_url: request_options[:base_url],
|
|
140
321
|
method: "DELETE",
|
|
141
322
|
path: "PaymentLink/#{URI.encode_uri_component(params[:pay_link_id].to_s)}",
|
|
323
|
+
headers: headers,
|
|
142
324
|
request_options: request_options
|
|
143
325
|
)
|
|
144
326
|
begin
|
|
@@ -166,13 +348,18 @@ module Payabli
|
|
|
166
348
|
# @option request_options [Integer] :timeout_in_seconds
|
|
167
349
|
# @option params [String] :paylink_id
|
|
168
350
|
#
|
|
351
|
+
# @example
|
|
352
|
+
# client.payment_link.get_pay_link_from_id(paylink_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234")
|
|
353
|
+
#
|
|
169
354
|
# @return [Payabli::Types::GetPayLinkFromIdResponse]
|
|
170
355
|
def get_pay_link_from_id(request_options: {}, **params)
|
|
171
356
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
357
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
172
358
|
request = Payabli::Internal::JSON::Request.new(
|
|
173
359
|
base_url: request_options[:base_url],
|
|
174
360
|
method: "GET",
|
|
175
361
|
path: "PaymentLink/load/#{URI.encode_uri_component(params[:paylink_id].to_s)}",
|
|
362
|
+
headers: headers,
|
|
176
363
|
request_options: request_options
|
|
177
364
|
)
|
|
178
365
|
begin
|
|
@@ -200,13 +387,18 @@ module Payabli
|
|
|
200
387
|
# @option request_options [Integer] :timeout_in_seconds
|
|
201
388
|
# @option params [String] :pay_link_id
|
|
202
389
|
#
|
|
390
|
+
# @example
|
|
391
|
+
# client.payment_link.push_pay_link_from_id(pay_link_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234")
|
|
392
|
+
#
|
|
203
393
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
204
394
|
def push_pay_link_from_id(request_options: {}, **params)
|
|
205
395
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
396
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
206
397
|
request = Payabli::Internal::JSON::Request.new(
|
|
207
398
|
base_url: request_options[:base_url],
|
|
208
399
|
method: "POST",
|
|
209
400
|
path: "PaymentLink/push/#{URI.encode_uri_component(params[:pay_link_id].to_s)}",
|
|
401
|
+
headers: headers,
|
|
210
402
|
body: Payabli::Types::PushPayLinkRequest.new(params).to_h,
|
|
211
403
|
request_options: request_options
|
|
212
404
|
)
|
|
@@ -236,16 +428,21 @@ module Payabli
|
|
|
236
428
|
# @option params [String] :pay_link_id
|
|
237
429
|
# @option params [Boolean, nil] :amount_fixed
|
|
238
430
|
#
|
|
431
|
+
# @example
|
|
432
|
+
# client.payment_link.refresh_pay_link_from_id(pay_link_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234")
|
|
433
|
+
#
|
|
239
434
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
240
435
|
def refresh_pay_link_from_id(request_options: {}, **params)
|
|
241
436
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
242
437
|
query_params = {}
|
|
243
438
|
query_params["amountFixed"] = params[:amount_fixed] if params.key?(:amount_fixed)
|
|
244
439
|
|
|
440
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
245
441
|
request = Payabli::Internal::JSON::Request.new(
|
|
246
442
|
base_url: request_options[:base_url],
|
|
247
443
|
method: "GET",
|
|
248
444
|
path: "PaymentLink/refresh/#{URI.encode_uri_component(params[:pay_link_id].to_s)}",
|
|
445
|
+
headers: headers,
|
|
249
446
|
query: query_params,
|
|
250
447
|
request_options: request_options
|
|
251
448
|
)
|
|
@@ -276,6 +473,12 @@ module Payabli
|
|
|
276
473
|
# @option params [Boolean, nil] :attachfile
|
|
277
474
|
# @option params [String, nil] :mail_2
|
|
278
475
|
#
|
|
476
|
+
# @example
|
|
477
|
+
# client.payment_link.send_pay_link_from_id(
|
|
478
|
+
# pay_link_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234",
|
|
479
|
+
# mail_2: "jo@example.com; ceo@example.com"
|
|
480
|
+
# )
|
|
481
|
+
#
|
|
279
482
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
280
483
|
def send_pay_link_from_id(request_options: {}, **params)
|
|
281
484
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -283,10 +486,12 @@ module Payabli
|
|
|
283
486
|
query_params["attachfile"] = params[:attachfile] if params.key?(:attachfile)
|
|
284
487
|
query_params["mail2"] = params[:mail_2] if params.key?(:mail_2)
|
|
285
488
|
|
|
489
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
286
490
|
request = Payabli::Internal::JSON::Request.new(
|
|
287
491
|
base_url: request_options[:base_url],
|
|
288
492
|
method: "GET",
|
|
289
493
|
path: "PaymentLink/send/#{URI.encode_uri_component(params[:pay_link_id].to_s)}",
|
|
494
|
+
headers: headers,
|
|
290
495
|
query: query_params,
|
|
291
496
|
request_options: request_options
|
|
292
497
|
)
|
|
@@ -315,6 +520,23 @@ module Payabli
|
|
|
315
520
|
# @option request_options [Integer] :timeout_in_seconds
|
|
316
521
|
# @option params [String] :pay_link_id
|
|
317
522
|
#
|
|
523
|
+
# @example
|
|
524
|
+
# client.payment_link.update_pay_link_from_id(
|
|
525
|
+
# pay_link_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234",
|
|
526
|
+
# notes: {
|
|
527
|
+
# enabled: true,
|
|
528
|
+
# header: "Additional Notes",
|
|
529
|
+
# order: 0,
|
|
530
|
+
# placeholder: "Enter any additional notes here",
|
|
531
|
+
# value: ""
|
|
532
|
+
# },
|
|
533
|
+
# payment_button: {
|
|
534
|
+
# enabled: true,
|
|
535
|
+
# label: "Pay Now",
|
|
536
|
+
# order: 0
|
|
537
|
+
# }
|
|
538
|
+
# )
|
|
539
|
+
#
|
|
318
540
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
319
541
|
def update_pay_link_from_id(request_options: {}, **params)
|
|
320
542
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -322,10 +544,12 @@ module Payabli
|
|
|
322
544
|
non_body_param_names = %w[payLinkId]
|
|
323
545
|
body = request_data.except(*non_body_param_names)
|
|
324
546
|
|
|
547
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
325
548
|
request = Payabli::Internal::JSON::Request.new(
|
|
326
549
|
base_url: request_options[:base_url],
|
|
327
550
|
method: "PUT",
|
|
328
551
|
path: "PaymentLink/update/#{URI.encode_uri_component(params[:pay_link_id].to_s)}",
|
|
552
|
+
headers: headers,
|
|
329
553
|
body: body,
|
|
330
554
|
request_options: request_options
|
|
331
555
|
)
|
|
@@ -359,6 +583,73 @@ module Payabli
|
|
|
359
583
|
# @option params [String, nil] :mail_2
|
|
360
584
|
# @option params [String, nil] :amount_fixed
|
|
361
585
|
#
|
|
586
|
+
# @example
|
|
587
|
+
# client.payment_link.add_pay_link_from_bill_lot_number(
|
|
588
|
+
# lot_number: "LOT-2024-001",
|
|
589
|
+
# entry_point: "8cfec329267",
|
|
590
|
+
# vendor_number: "VEN-123",
|
|
591
|
+
# mail_2: "customer@example.com; billing@example.com",
|
|
592
|
+
# amount_fixed: "true",
|
|
593
|
+
# contact_us: {
|
|
594
|
+
# email_label: "Email",
|
|
595
|
+
# enabled: true,
|
|
596
|
+
# header: "Contact Us",
|
|
597
|
+
# order: 0,
|
|
598
|
+
# payment_icons: true,
|
|
599
|
+
# phone_label: "Phone"
|
|
600
|
+
# },
|
|
601
|
+
# logo: {
|
|
602
|
+
# enabled: true,
|
|
603
|
+
# order: 0
|
|
604
|
+
# },
|
|
605
|
+
# message_before_paying: {
|
|
606
|
+
# enabled: true,
|
|
607
|
+
# label: "Please review your payment details",
|
|
608
|
+
# order: 0
|
|
609
|
+
# },
|
|
610
|
+
# notes: {
|
|
611
|
+
# enabled: true,
|
|
612
|
+
# header: "Additional Notes",
|
|
613
|
+
# order: 0,
|
|
614
|
+
# placeholder: "Enter any additional notes here",
|
|
615
|
+
# value: ""
|
|
616
|
+
# },
|
|
617
|
+
# page: {
|
|
618
|
+
# description: "Get paid securely",
|
|
619
|
+
# enabled: true,
|
|
620
|
+
# header: "Payment Page",
|
|
621
|
+
# order: 0
|
|
622
|
+
# },
|
|
623
|
+
# payment_button: {
|
|
624
|
+
# enabled: true,
|
|
625
|
+
# label: "Pay Now",
|
|
626
|
+
# order: 0
|
|
627
|
+
# },
|
|
628
|
+
# payment_methods: {
|
|
629
|
+
# all_methods_checked: true,
|
|
630
|
+
# allow_multiple_methods: true,
|
|
631
|
+
# default_method: "vcard",
|
|
632
|
+
# enabled: true,
|
|
633
|
+
# header: "Payment Methods",
|
|
634
|
+
# methods: {
|
|
635
|
+
# ach: true,
|
|
636
|
+
# check: true,
|
|
637
|
+
# vcard: true
|
|
638
|
+
# },
|
|
639
|
+
# order: 0,
|
|
640
|
+
# show_preview_virtual_card: true
|
|
641
|
+
# },
|
|
642
|
+
# review: {
|
|
643
|
+
# enabled: true,
|
|
644
|
+
# header: "Review Payment",
|
|
645
|
+
# order: 0
|
|
646
|
+
# },
|
|
647
|
+
# settings: {
|
|
648
|
+
# color: "#000000",
|
|
649
|
+
# language: "en"
|
|
650
|
+
# }
|
|
651
|
+
# )
|
|
652
|
+
#
|
|
362
653
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
363
654
|
def add_pay_link_from_bill_lot_number(request_options: {}, **params)
|
|
364
655
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -373,10 +664,12 @@ module Payabli
|
|
|
373
664
|
query_params["amountFixed"] = params[:amount_fixed] if params.key?(:amount_fixed)
|
|
374
665
|
params = params.except(*query_param_names)
|
|
375
666
|
|
|
667
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
376
668
|
request = Payabli::Internal::JSON::Request.new(
|
|
377
669
|
base_url: request_options[:base_url],
|
|
378
670
|
method: "POST",
|
|
379
671
|
path: "PaymentLink/bill/lotNumber/#{URI.encode_uri_component(params[:lot_number].to_s)}",
|
|
672
|
+
headers: headers,
|
|
380
673
|
query: query_params,
|
|
381
674
|
body: Payabli::Types::PaymentPageRequestBodyOut.new(body_params).to_h,
|
|
382
675
|
request_options: request_options
|
|
@@ -408,6 +701,13 @@ module Payabli
|
|
|
408
701
|
# @option request_options [Integer] :timeout_in_seconds
|
|
409
702
|
# @option params [String] :paylink_id
|
|
410
703
|
#
|
|
704
|
+
# @example
|
|
705
|
+
# client.payment_link.patch_out_payment_link(
|
|
706
|
+
# paylink_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234",
|
|
707
|
+
# expiration_date: "2026-06-01T00:00:00Z",
|
|
708
|
+
# status: "Active"
|
|
709
|
+
# )
|
|
710
|
+
#
|
|
411
711
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
412
712
|
def patch_out_payment_link(request_options: {}, **params)
|
|
413
713
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -415,10 +715,12 @@ module Payabli
|
|
|
415
715
|
non_body_param_names = %w[paylinkId]
|
|
416
716
|
body = request_data.except(*non_body_param_names)
|
|
417
717
|
|
|
718
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
418
719
|
request = Payabli::Internal::JSON::Request.new(
|
|
419
720
|
base_url: request_options[:base_url],
|
|
420
721
|
method: "PATCH",
|
|
421
722
|
path: "PaymentLink/out/#{URI.encode_uri_component(params[:paylink_id].to_s)}",
|
|
723
|
+
headers: headers,
|
|
422
724
|
body: body,
|
|
423
725
|
request_options: request_options
|
|
424
726
|
)
|
|
@@ -448,13 +750,78 @@ module Payabli
|
|
|
448
750
|
# @option request_options [Integer] :timeout_in_seconds
|
|
449
751
|
# @option params [String] :paylink_id
|
|
450
752
|
#
|
|
753
|
+
# @example
|
|
754
|
+
# client.payment_link.update_pay_link_out_from_id(
|
|
755
|
+
# paylink_id: "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234",
|
|
756
|
+
# contact_us: {
|
|
757
|
+
# email_label: "Email",
|
|
758
|
+
# enabled: true,
|
|
759
|
+
# header: "Contact Us",
|
|
760
|
+
# order: 0,
|
|
761
|
+
# payment_icons: true,
|
|
762
|
+
# phone_label: "Phone"
|
|
763
|
+
# },
|
|
764
|
+
# logo: {
|
|
765
|
+
# enabled: true,
|
|
766
|
+
# order: 0
|
|
767
|
+
# },
|
|
768
|
+
# message_before_paying: {
|
|
769
|
+
# enabled: true,
|
|
770
|
+
# label: "Please review your payment details",
|
|
771
|
+
# order: 0
|
|
772
|
+
# },
|
|
773
|
+
# notes: {
|
|
774
|
+
# enabled: true,
|
|
775
|
+
# header: "Additional Notes",
|
|
776
|
+
# order: 0,
|
|
777
|
+
# placeholder: "Enter any additional notes here",
|
|
778
|
+
# value: ""
|
|
779
|
+
# },
|
|
780
|
+
# page: {
|
|
781
|
+
# description: "Get paid securely",
|
|
782
|
+
# enabled: true,
|
|
783
|
+
# header: "Payment Page",
|
|
784
|
+
# order: 0
|
|
785
|
+
# },
|
|
786
|
+
# payment_button: {
|
|
787
|
+
# enabled: true,
|
|
788
|
+
# label: "Pay Now",
|
|
789
|
+
# order: 0
|
|
790
|
+
# },
|
|
791
|
+
# payment_methods: {
|
|
792
|
+
# all_methods_checked: true,
|
|
793
|
+
# allow_multiple_methods: true,
|
|
794
|
+
# default_method: "vcard",
|
|
795
|
+
# enabled: true,
|
|
796
|
+
# header: "Payment Methods",
|
|
797
|
+
# methods: {
|
|
798
|
+
# ach: true,
|
|
799
|
+
# check: true,
|
|
800
|
+
# vcard: true
|
|
801
|
+
# },
|
|
802
|
+
# order: 0,
|
|
803
|
+
# show_preview_virtual_card: true
|
|
804
|
+
# },
|
|
805
|
+
# review: {
|
|
806
|
+
# enabled: true,
|
|
807
|
+
# header: "Review Payment",
|
|
808
|
+
# order: 0
|
|
809
|
+
# },
|
|
810
|
+
# settings: {
|
|
811
|
+
# color: "#000000",
|
|
812
|
+
# language: "en"
|
|
813
|
+
# }
|
|
814
|
+
# )
|
|
815
|
+
#
|
|
451
816
|
# @return [Payabli::Types::PayabliApiResponsePaymentLinks]
|
|
452
817
|
def update_pay_link_out_from_id(request_options: {}, **params)
|
|
453
818
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
819
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
454
820
|
request = Payabli::Internal::JSON::Request.new(
|
|
455
821
|
base_url: request_options[:base_url],
|
|
456
822
|
method: "PATCH",
|
|
457
823
|
path: "PaymentLink/updateOut/#{URI.encode_uri_component(params[:paylink_id].to_s)}",
|
|
824
|
+
headers: headers,
|
|
458
825
|
body: Payabli::Types::PaymentPageRequestBodyOut.new(params).to_h,
|
|
459
826
|
request_options: request_options
|
|
460
827
|
)
|