@vrplatform/hyperline-client 1.0.7 → 1.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/main/_types.generated.d.ts +3426 -940
- package/build/main/_types.generated.js.map +1 -1
- package/build/main/client.d.ts +248 -22
- package/build/main/client.js +2 -2
- package/build/main/client.js.map +1 -1
- package/build/main/const.d.ts +9 -0
- package/build/main/const.js +9 -0
- package/build/main/const.js.map +1 -1
- package/build/module/_types.generated.d.ts +3426 -940
- package/build/module/_types.generated.js.map +1 -1
- package/build/module/client.d.ts +248 -22
- package/build/module/client.js +2 -2
- package/build/module/client.js.map +1 -1
- package/build/module/const.d.ts +9 -0
- package/build/module/const.js +9 -0
- package/build/module/const.js.map +1 -1
- package/package.json +1 -1
- package/src/_types.generated.ts +3426 -940
- package/src/client.ts +4 -2
- package/src/const.ts +10 -0
package/build/main/client.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ export declare class HyperlineAPI {
|
|
|
21
21
|
vat_number_valid: boolean;
|
|
22
22
|
vat_rate_custom: number | null;
|
|
23
23
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
24
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "
|
|
24
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
25
25
|
external_id: string | null;
|
|
26
26
|
properties: {
|
|
27
27
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -34,6 +34,7 @@ export declare class HyperlineAPI {
|
|
|
34
34
|
invoice_emails: string[];
|
|
35
35
|
invoicing_entity_id: string;
|
|
36
36
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
37
|
+
price_book_id: string | null;
|
|
37
38
|
available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
|
|
38
39
|
current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
39
40
|
current_payment_method_id: string | null;
|
|
@@ -54,11 +55,16 @@ export declare class HyperlineAPI {
|
|
|
54
55
|
gocardless?: string;
|
|
55
56
|
mollie?: string;
|
|
56
57
|
stripe?: string;
|
|
58
|
+
airwallex?: string;
|
|
57
59
|
hubspot?: string;
|
|
58
60
|
salesforce?: string;
|
|
61
|
+
xero?: string;
|
|
62
|
+
"exact-online"?: string;
|
|
63
|
+
pennylane?: string;
|
|
64
|
+
netsuite?: string;
|
|
59
65
|
};
|
|
60
66
|
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
61
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"];
|
|
67
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & unknown;
|
|
62
68
|
organisation_id: string | null;
|
|
63
69
|
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
64
70
|
}) | null>;
|
|
@@ -73,7 +79,7 @@ export declare class HyperlineAPI {
|
|
|
73
79
|
vat_number_valid: boolean;
|
|
74
80
|
vat_rate_custom: number | null;
|
|
75
81
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
76
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "
|
|
82
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
77
83
|
external_id: string | null;
|
|
78
84
|
properties: {
|
|
79
85
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -86,6 +92,7 @@ export declare class HyperlineAPI {
|
|
|
86
92
|
invoice_emails: string[];
|
|
87
93
|
invoicing_entity_id: string;
|
|
88
94
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
95
|
+
price_book_id: string | null;
|
|
89
96
|
available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
|
|
90
97
|
current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
91
98
|
current_payment_method_id: string | null;
|
|
@@ -122,7 +129,7 @@ export declare class HyperlineAPI {
|
|
|
122
129
|
vat_number_valid: boolean;
|
|
123
130
|
vat_rate_custom: number | null;
|
|
124
131
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
125
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "
|
|
132
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
126
133
|
external_id: string | null;
|
|
127
134
|
properties: {
|
|
128
135
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -135,6 +142,7 @@ export declare class HyperlineAPI {
|
|
|
135
142
|
invoice_emails: string[];
|
|
136
143
|
invoicing_entity_id: string;
|
|
137
144
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
145
|
+
price_book_id: string | null;
|
|
138
146
|
available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
|
|
139
147
|
current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
140
148
|
current_payment_method_id: string | null;
|
|
@@ -155,11 +163,16 @@ export declare class HyperlineAPI {
|
|
|
155
163
|
gocardless?: string;
|
|
156
164
|
mollie?: string;
|
|
157
165
|
stripe?: string;
|
|
166
|
+
airwallex?: string;
|
|
158
167
|
hubspot?: string;
|
|
159
168
|
salesforce?: string;
|
|
169
|
+
xero?: string;
|
|
170
|
+
"exact-online"?: string;
|
|
171
|
+
pennylane?: string;
|
|
172
|
+
netsuite?: string;
|
|
160
173
|
};
|
|
161
174
|
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
162
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"];
|
|
175
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & unknown;
|
|
163
176
|
organisation_id: string | null;
|
|
164
177
|
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
165
178
|
}) | null>;
|
|
@@ -174,7 +187,7 @@ export declare class HyperlineAPI {
|
|
|
174
187
|
vat_number_valid: boolean;
|
|
175
188
|
vat_rate_custom: number | null;
|
|
176
189
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
177
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "
|
|
190
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
178
191
|
external_id: string | null;
|
|
179
192
|
properties: {
|
|
180
193
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -187,6 +200,7 @@ export declare class HyperlineAPI {
|
|
|
187
200
|
invoice_emails: string[];
|
|
188
201
|
invoicing_entity_id: string;
|
|
189
202
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
203
|
+
price_book_id: string | null;
|
|
190
204
|
available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
|
|
191
205
|
current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
192
206
|
current_payment_method_id: string | null;
|
|
@@ -207,11 +221,16 @@ export declare class HyperlineAPI {
|
|
|
207
221
|
gocardless?: string;
|
|
208
222
|
mollie?: string;
|
|
209
223
|
stripe?: string;
|
|
224
|
+
airwallex?: string;
|
|
210
225
|
hubspot?: string;
|
|
211
226
|
salesforce?: string;
|
|
227
|
+
xero?: string;
|
|
228
|
+
"exact-online"?: string;
|
|
229
|
+
pennylane?: string;
|
|
230
|
+
netsuite?: string;
|
|
212
231
|
};
|
|
213
232
|
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
214
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"];
|
|
233
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & unknown;
|
|
215
234
|
organisation_id: string | null;
|
|
216
235
|
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
217
236
|
}) | null>;
|
|
@@ -227,7 +246,7 @@ export declare class HyperlineAPI {
|
|
|
227
246
|
vat_number_valid: boolean;
|
|
228
247
|
vat_rate_custom: number | null;
|
|
229
248
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
230
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "
|
|
249
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
231
250
|
external_id: string | null;
|
|
232
251
|
properties: {
|
|
233
252
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -240,6 +259,7 @@ export declare class HyperlineAPI {
|
|
|
240
259
|
invoice_emails: string[];
|
|
241
260
|
invoicing_entity_id: string;
|
|
242
261
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
262
|
+
price_book_id: string | null;
|
|
243
263
|
available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
|
|
244
264
|
current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
245
265
|
current_payment_method_id: string | null;
|
|
@@ -267,7 +287,7 @@ export declare class HyperlineAPI {
|
|
|
267
287
|
vat_number_valid: boolean;
|
|
268
288
|
vat_rate_custom: number | null;
|
|
269
289
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
270
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "
|
|
290
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
271
291
|
external_id: string | null;
|
|
272
292
|
properties: {
|
|
273
293
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -280,6 +300,7 @@ export declare class HyperlineAPI {
|
|
|
280
300
|
invoice_emails: string[];
|
|
281
301
|
invoicing_entity_id: string;
|
|
282
302
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
303
|
+
price_book_id: string | null;
|
|
283
304
|
available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
|
|
284
305
|
current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
285
306
|
current_payment_method_id: string | null;
|
|
@@ -299,7 +320,7 @@ export declare class HyperlineAPI {
|
|
|
299
320
|
getCustomerPortal(id: string): Promise<{
|
|
300
321
|
url: string;
|
|
301
322
|
} | null>;
|
|
302
|
-
getSubscription(id: string): Promise<({
|
|
323
|
+
getSubscription(id: string, liveBilling?: boolean): Promise<({
|
|
303
324
|
id: string;
|
|
304
325
|
currency: import("./_types.generated").components["schemas"]["Currency"];
|
|
305
326
|
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
@@ -336,7 +357,6 @@ export declare class HyperlineAPI {
|
|
|
336
357
|
next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
|
|
337
358
|
renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
338
359
|
current_phase_id: string | null;
|
|
339
|
-
trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
340
360
|
properties: {
|
|
341
361
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
342
362
|
} | null;
|
|
@@ -349,12 +369,16 @@ export declare class HyperlineAPI {
|
|
|
349
369
|
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
350
370
|
coupons: (({
|
|
351
371
|
description: string | null;
|
|
372
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
373
|
+
redemption_limit: number | null;
|
|
352
374
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
353
375
|
type: "amount";
|
|
354
376
|
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
355
377
|
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
356
378
|
} | {
|
|
357
379
|
description: string | null;
|
|
380
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
381
|
+
redemption_limit: number | null;
|
|
358
382
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
359
383
|
type: "percent";
|
|
360
384
|
discount_percent: number;
|
|
@@ -367,6 +391,52 @@ export declare class HyperlineAPI {
|
|
|
367
391
|
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
368
392
|
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
369
393
|
})[];
|
|
394
|
+
phases: {
|
|
395
|
+
id: string;
|
|
396
|
+
type: "setup" | "trial" | "standard";
|
|
397
|
+
status: "pending" | "active" | "finished";
|
|
398
|
+
order: number;
|
|
399
|
+
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
400
|
+
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
401
|
+
duration: {
|
|
402
|
+
period: "days" | "weeks" | "months" | "years";
|
|
403
|
+
count: number;
|
|
404
|
+
} | null;
|
|
405
|
+
billing_date_setting: "phase_start" | "specific_date";
|
|
406
|
+
initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
407
|
+
starts_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
408
|
+
ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
409
|
+
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
410
|
+
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
411
|
+
transition_invoicing_schedule: "immediately";
|
|
412
|
+
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
413
|
+
coupons: (({
|
|
414
|
+
description: string | null;
|
|
415
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
416
|
+
redemption_limit: number | null;
|
|
417
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
418
|
+
type: "amount";
|
|
419
|
+
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
420
|
+
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
421
|
+
} | {
|
|
422
|
+
description: string | null;
|
|
423
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
424
|
+
redemption_limit: number | null;
|
|
425
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
426
|
+
type: "percent";
|
|
427
|
+
discount_percent: number;
|
|
428
|
+
}) & {
|
|
429
|
+
id: string | null;
|
|
430
|
+
name: string | null;
|
|
431
|
+
subscription_coupon_id: string;
|
|
432
|
+
repeat: "once" | "forever" | "custom";
|
|
433
|
+
product_ids: string[];
|
|
434
|
+
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
435
|
+
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
436
|
+
})[];
|
|
437
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
438
|
+
updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
439
|
+
}[];
|
|
370
440
|
quote: {
|
|
371
441
|
id: string;
|
|
372
442
|
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
@@ -428,7 +498,6 @@ export declare class HyperlineAPI {
|
|
|
428
498
|
next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
|
|
429
499
|
renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
430
500
|
current_phase_id: string | null;
|
|
431
|
-
trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
432
501
|
properties: {
|
|
433
502
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
434
503
|
} | null;
|
|
@@ -441,12 +510,16 @@ export declare class HyperlineAPI {
|
|
|
441
510
|
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
442
511
|
coupons: (({
|
|
443
512
|
description: string | null;
|
|
513
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
514
|
+
redemption_limit: number | null;
|
|
444
515
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
445
516
|
type: "amount";
|
|
446
517
|
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
447
518
|
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
448
519
|
} | {
|
|
449
520
|
description: string | null;
|
|
521
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
522
|
+
redemption_limit: number | null;
|
|
450
523
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
451
524
|
type: "percent";
|
|
452
525
|
discount_percent: number;
|
|
@@ -459,6 +532,52 @@ export declare class HyperlineAPI {
|
|
|
459
532
|
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
460
533
|
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
461
534
|
})[];
|
|
535
|
+
phases: {
|
|
536
|
+
id: string;
|
|
537
|
+
type: "setup" | "trial" | "standard";
|
|
538
|
+
status: "pending" | "active" | "finished";
|
|
539
|
+
order: number;
|
|
540
|
+
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
541
|
+
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
542
|
+
duration: {
|
|
543
|
+
period: "days" | "weeks" | "months" | "years";
|
|
544
|
+
count: number;
|
|
545
|
+
} | null;
|
|
546
|
+
billing_date_setting: "phase_start" | "specific_date";
|
|
547
|
+
initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
548
|
+
starts_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
549
|
+
ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
550
|
+
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
551
|
+
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
552
|
+
transition_invoicing_schedule: "immediately";
|
|
553
|
+
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
554
|
+
coupons: (({
|
|
555
|
+
description: string | null;
|
|
556
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
557
|
+
redemption_limit: number | null;
|
|
558
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
559
|
+
type: "amount";
|
|
560
|
+
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
561
|
+
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
562
|
+
} | {
|
|
563
|
+
description: string | null;
|
|
564
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
565
|
+
redemption_limit: number | null;
|
|
566
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
567
|
+
type: "percent";
|
|
568
|
+
discount_percent: number;
|
|
569
|
+
}) & {
|
|
570
|
+
id: string | null;
|
|
571
|
+
name: string | null;
|
|
572
|
+
subscription_coupon_id: string;
|
|
573
|
+
repeat: "once" | "forever" | "custom";
|
|
574
|
+
product_ids: string[];
|
|
575
|
+
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
576
|
+
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
577
|
+
})[];
|
|
578
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
579
|
+
updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
580
|
+
}[];
|
|
462
581
|
quote: {
|
|
463
582
|
id: string;
|
|
464
583
|
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
@@ -512,7 +631,6 @@ export declare class HyperlineAPI {
|
|
|
512
631
|
next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
|
|
513
632
|
renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
514
633
|
current_phase_id: string | null;
|
|
515
|
-
trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
516
634
|
properties: {
|
|
517
635
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
518
636
|
} | null;
|
|
@@ -525,12 +643,16 @@ export declare class HyperlineAPI {
|
|
|
525
643
|
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
526
644
|
coupons: (({
|
|
527
645
|
description: string | null;
|
|
646
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
647
|
+
redemption_limit: number | null;
|
|
528
648
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
529
649
|
type: "amount";
|
|
530
650
|
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
531
651
|
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
532
652
|
} | {
|
|
533
653
|
description: string | null;
|
|
654
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
655
|
+
redemption_limit: number | null;
|
|
534
656
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
535
657
|
type: "percent";
|
|
536
658
|
discount_percent: number;
|
|
@@ -543,6 +665,52 @@ export declare class HyperlineAPI {
|
|
|
543
665
|
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
544
666
|
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
545
667
|
})[];
|
|
668
|
+
phases: {
|
|
669
|
+
id: string;
|
|
670
|
+
type: "setup" | "trial" | "standard";
|
|
671
|
+
status: "pending" | "active" | "finished";
|
|
672
|
+
order: number;
|
|
673
|
+
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
674
|
+
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
675
|
+
duration: {
|
|
676
|
+
period: "days" | "weeks" | "months" | "years";
|
|
677
|
+
count: number;
|
|
678
|
+
} | null;
|
|
679
|
+
billing_date_setting: "phase_start" | "specific_date";
|
|
680
|
+
initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
681
|
+
starts_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
682
|
+
ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
683
|
+
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
684
|
+
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
685
|
+
transition_invoicing_schedule: "immediately";
|
|
686
|
+
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
687
|
+
coupons: (({
|
|
688
|
+
description: string | null;
|
|
689
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
690
|
+
redemption_limit: number | null;
|
|
691
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
692
|
+
type: "amount";
|
|
693
|
+
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
694
|
+
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
695
|
+
} | {
|
|
696
|
+
description: string | null;
|
|
697
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
698
|
+
redemption_limit: number | null;
|
|
699
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
700
|
+
type: "percent";
|
|
701
|
+
discount_percent: number;
|
|
702
|
+
}) & {
|
|
703
|
+
id: string | null;
|
|
704
|
+
name: string | null;
|
|
705
|
+
subscription_coupon_id: string;
|
|
706
|
+
repeat: "once" | "forever" | "custom";
|
|
707
|
+
product_ids: string[];
|
|
708
|
+
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
709
|
+
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
710
|
+
})[];
|
|
711
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
712
|
+
updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
713
|
+
}[];
|
|
546
714
|
quote: {
|
|
547
715
|
id: string;
|
|
548
716
|
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
@@ -593,7 +761,6 @@ export declare class HyperlineAPI {
|
|
|
593
761
|
next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
|
|
594
762
|
renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
595
763
|
current_phase_id: string | null;
|
|
596
|
-
trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
597
764
|
properties: {
|
|
598
765
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
599
766
|
} | null;
|
|
@@ -606,12 +773,16 @@ export declare class HyperlineAPI {
|
|
|
606
773
|
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
607
774
|
coupons: (({
|
|
608
775
|
description: string | null;
|
|
776
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
777
|
+
redemption_limit: number | null;
|
|
609
778
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
610
779
|
type: "amount";
|
|
611
780
|
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
612
781
|
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
613
782
|
} | {
|
|
614
783
|
description: string | null;
|
|
784
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
785
|
+
redemption_limit: number | null;
|
|
615
786
|
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
616
787
|
type: "percent";
|
|
617
788
|
discount_percent: number;
|
|
@@ -624,6 +795,52 @@ export declare class HyperlineAPI {
|
|
|
624
795
|
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
625
796
|
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
626
797
|
})[];
|
|
798
|
+
phases: {
|
|
799
|
+
id: string;
|
|
800
|
+
type: "setup" | "trial" | "standard";
|
|
801
|
+
status: "pending" | "active" | "finished";
|
|
802
|
+
order: number;
|
|
803
|
+
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
804
|
+
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
805
|
+
duration: {
|
|
806
|
+
period: "days" | "weeks" | "months" | "years";
|
|
807
|
+
count: number;
|
|
808
|
+
} | null;
|
|
809
|
+
billing_date_setting: "phase_start" | "specific_date";
|
|
810
|
+
initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
811
|
+
starts_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
812
|
+
ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
813
|
+
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
814
|
+
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
815
|
+
transition_invoicing_schedule: "immediately";
|
|
816
|
+
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
817
|
+
coupons: (({
|
|
818
|
+
description: string | null;
|
|
819
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
820
|
+
redemption_limit: number | null;
|
|
821
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
822
|
+
type: "amount";
|
|
823
|
+
discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
824
|
+
currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
|
|
825
|
+
} | {
|
|
826
|
+
description: string | null;
|
|
827
|
+
expiration_date: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
828
|
+
redemption_limit: number | null;
|
|
829
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
830
|
+
type: "percent";
|
|
831
|
+
discount_percent: number;
|
|
832
|
+
}) & {
|
|
833
|
+
id: string | null;
|
|
834
|
+
name: string | null;
|
|
835
|
+
subscription_coupon_id: string;
|
|
836
|
+
repeat: "once" | "forever" | "custom";
|
|
837
|
+
product_ids: string[];
|
|
838
|
+
apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
839
|
+
expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
840
|
+
})[];
|
|
841
|
+
created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
842
|
+
updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
843
|
+
}[];
|
|
627
844
|
quote: {
|
|
628
845
|
id: string;
|
|
629
846
|
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
@@ -658,10 +875,6 @@ export declare class HyperlineAPI {
|
|
|
658
875
|
period: "days" | "weeks" | "months" | "years";
|
|
659
876
|
count: number | null;
|
|
660
877
|
} | null;
|
|
661
|
-
trial_interval: {
|
|
662
|
-
period: "days" | "weeks" | "months" | "years";
|
|
663
|
-
count: number;
|
|
664
|
-
} | null;
|
|
665
878
|
products: ({
|
|
666
879
|
id: string;
|
|
667
880
|
name: string;
|
|
@@ -747,7 +960,7 @@ export declare class HyperlineAPI {
|
|
|
747
960
|
number: string;
|
|
748
961
|
type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
|
|
749
962
|
document_name: string | null;
|
|
750
|
-
status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "
|
|
963
|
+
status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat";
|
|
751
964
|
reference: string | null;
|
|
752
965
|
purchase_order: string | null;
|
|
753
966
|
original_invoice_id: string | null;
|
|
@@ -766,7 +979,6 @@ export declare class HyperlineAPI {
|
|
|
766
979
|
converted_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
|
|
767
980
|
converted_at: import("./_types.generated").components["schemas"]["DateTime"];
|
|
768
981
|
payment_method_id: string | null;
|
|
769
|
-
attempt_count: number;
|
|
770
982
|
custom_note: string | null;
|
|
771
983
|
customer: {
|
|
772
984
|
id: string;
|
|
@@ -803,14 +1015,28 @@ export declare class HyperlineAPI {
|
|
|
803
1015
|
process_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
804
1016
|
refunded_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
805
1017
|
last_refreshed_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
1018
|
+
provider_fee: {
|
|
1019
|
+
amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
1020
|
+
currency: import("./_types.generated").components["schemas"]["Currency"];
|
|
1021
|
+
exchange_rate: number | null;
|
|
1022
|
+
} | null;
|
|
1023
|
+
chargeback: {
|
|
1024
|
+
amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
|
|
1025
|
+
last_chargeback_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
|
|
1026
|
+
} | null;
|
|
806
1027
|
} & ({
|
|
807
|
-
payment_method_type: "card" | "
|
|
1028
|
+
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
808
1029
|
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
1030
|
+
} | {
|
|
1031
|
+
payment_method_type: "transfer" | "transfer_automated";
|
|
1032
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"];
|
|
809
1033
|
} | {
|
|
810
1034
|
payment_method_type: "wallet";
|
|
811
1035
|
wallet_id: string;
|
|
1036
|
+
} | {
|
|
1037
|
+
payment_method_type: "external";
|
|
812
1038
|
}) & ({
|
|
813
|
-
status: "
|
|
1039
|
+
status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
|
|
814
1040
|
} | {
|
|
815
1041
|
status: "failed";
|
|
816
1042
|
error_type: "authentication_required" | "declined" | "fraud" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
|