From 65408d3a33ce56e205e049143b9abf94ad8fb9e6 Mon Sep 17 00:00:00 2001
From: GitHub Actions <>
Date: Wed, 4 Sep 2024 00:23:10 +0000
Subject: [PATCH] Update javadoc
---
docs/com/bitpay/sdk/Client.html | 382 ++++++++++++++----
docs/com/bitpay/sdk/class-use/Client.html | 31 ++
.../bitpay/sdk/class-use/ConfigFilePath.html | 15 +
.../com/bitpay/sdk/class-use/Environment.html | 34 ++
docs/com/bitpay/sdk/class-use/PosToken.html | 28 ++
docs/com/bitpay/sdk/class-use/PrivateKey.html | 19 +
docs/com/bitpay/sdk/client/BitPayClient.html | 33 +-
.../client/class-use/HttpRequestFactory.html | 9 +
.../class-use/BitPayGenericException.html | 62 +++
.../sdk/util/class-use/TokenContainer.html | 19 +
docs/index-all.html | 36 ++
11 files changed, 597 insertions(+), 71 deletions(-)
diff --git a/docs/com/bitpay/sdk/Client.html b/docs/com/bitpay/sdk/Client.html
index 554257b7..1892ae14 100644
--- a/docs/com/bitpay/sdk/Client.html
+++ b/docs/com/bitpay/sdk/Client.html
@@ -18,7 +18,7 @@
catch(err) {
}
//-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":10,"i17":10,"i18":9,"i19":9,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":9,"i17":9,"i18":10,"i19":10,"i20":9,"i21":9,"i22":9,"i23":9,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -176,6 +176,14 @@ Constructor Summary
+Client(ConfigFilePath configFilePath,
+ org.apache.http.HttpHost proxy,
+ org.apache.http.client.CredentialsProvider proxyCredentials,
+ String platformInfo)
+Constructor for use if the keys and SIN are managed by this library.
+ |
+
+
Client(Environment environment,
PrivateKey privateKey,
TokenContainer tokenContainer,
@@ -184,6 +192,16 @@ Constructor Summary
Constructor for use if the keys and SIN are managed by this library.
|
+
+Client(Environment environment,
+ PrivateKey privateKey,
+ TokenContainer tokenContainer,
+ org.apache.http.HttpHost proxyDetails,
+ org.apache.http.client.CredentialsProvider proxyCredentials,
+ String platformInfo)
+Constructor for use if the keys and SIN are managed by this library.
+ |
+
Client(PosToken token)
Constructor for POS facade.
@@ -195,6 +213,19 @@ Constructor Summary
Constructor for POS facade.
|
+
+Client(PosToken token,
+ Environment environment,
+ String platformInfo)
+Constructor for POS facade.
+ |
+
+
+Client(PosToken token,
+ String platformInfo)
+Constructor for POS facade.
+ |
+
@@ -309,19 +340,35 @@ Method Summary
static Client |
+createClientByConfigFilePath(ConfigFilePath configFilePath,
+ String platformInfo)
+Create standard client.
+ |
+
+
+static Client |
createClientByPrivateKey(PrivateKey privateKey,
TokenContainer tokenContainer,
Environment environment)
Create standard client.
|
-
+
+static Client |
+createClientByPrivateKey(PrivateKey privateKey,
+ TokenContainer tokenContainer,
+ Environment environment,
+ String platformInfo)
+Create standard client.
+ |
+
+
Invoice |
createInvoice(Invoice invoice)
Create a BitPay invoice.
|
-
+
Invoice |
createInvoice(Invoice invoice,
Facade facade,
@@ -329,26 +376,41 @@ Method Summary
Create a BitPay invoice.
|
-
+
static Client |
createPosClient(PosToken token)
Create pos (light) client.
|
-
+
static Client |
createPosClient(PosToken token,
Environment environment)
Create pos (light) client.
|
-
+
+static Client |
+createPosClient(PosToken token,
+ Environment environment,
+ String platformInfo)
+Create pos (light) client.
+ |
+
+
+static Client |
+createPosClient(PosToken token,
+ String platformInfo)
+Create pos (light) client.
+ |
+
+
Refund |
createRefund(Refund refund)
Create a refund for a BitPay invoice.
|
-
+
Refund |
createRefund(String invoiceId,
Double amount,
@@ -359,7 +421,7 @@ Method Summary
Create a refund for a BitPay invoice.
|
-
+
Refund |
createRefund(String invoiceId,
Double amount,
@@ -371,20 +433,20 @@ Method Summary
Create a refund for a BitPay invoice.
|
-
+
Boolean |
deletePayoutRecipient(String recipientId)
Cancel a BitPay Payout recipient.
|
-
+
String |
deliverBill(String billId,
String billToken)
Deliver a BitPay Bill.
|
-
+
String |
deliverBill(String billId,
String billToken,
@@ -392,37 +454,37 @@ Method Summary
Deliver a BitPay Bill.
|
-
+
protected void |
deriveIdentity(org.bitcoinj.core.ECKey ecKey)
Derive identity.
|
-
+
String |
getAccessToken(Facade facade)
Retrieve a token associated with a known resource.
|
-
+
String |
getAccessToken(String key)
Retrieve a token associated with a known resource.
|
-
+
protected String |
getBaseUrl(Environment environment)
Gets base url.
|
-
+
Bill |
getBill(String billId)
Retrieve a BitPay bill by bill id using the public facade.
|
-
+
Bill |
getBill(String billId,
Facade facade,
@@ -430,62 +492,62 @@ Method Summary
Retrieve a BitPay bill by bill id using the specified facade.
|
-
+
protected BillClient |
getBillClient()
Get bill client.
|
-
+
List<Bill> |
getBills()
Retrieve a collection of BitPay bills.
|
-
+
List<Bill> |
getBills(String status)
Retrieve a collection of BitPay bills.
|
-
+
Map<String,Object> |
getCurrencyInfo(String currencyCode)
Gets info for specific currency.
|
-
+
protected org.bitcoinj.core.ECKey |
getEcKey(Config config)
Initialize the public/private key pair by either loading the existing one or by creating a new one.
|
-
+
protected org.bitcoinj.core.ECKey |
getEcKey(PrivateKey privateKey)
Gets ECKey.
|
-
+
protected Facade |
getFacadeBasedOnAccessToken()
Gets facade based on access token.
|
-
+
protected org.apache.http.client.HttpClient |
getHttpClient(org.apache.http.HttpHost proxyDetails,
org.apache.http.client.CredentialsProvider proxyCreds)
Gets http client.
|
-
+
Invoice |
getInvoice(String invoiceId)
Retrieve a BitPay invoice by invoice id using the public facade.
|
-
+
Invoice |
getInvoice(String invoiceId,
Facade facade,
@@ -493,13 +555,13 @@ Method Summary
Retrieve a BitPay invoice by invoice id.
|
-
+
Invoice |
getInvoiceByGuid(String guid)
Retrieve a BitPay invoice by guid using the specified facade.
|
-
+
Invoice |
getInvoiceByGuid(String guid,
Facade facade,
@@ -507,19 +569,19 @@ Method Summary
Retrieve a BitPay invoice by guid using the specified facade.
|
-
+
protected InvoiceClient |
getInvoiceClient()
Get invoice client.
|
-
+
InvoiceEventToken |
getInvoiceEventToken(String invoiceId)
Retrieves a bus token which can be used to subscribe to invoice events.
|
-
+
List<Invoice> |
getInvoices(String dateStart,
String dateEnd,
@@ -530,13 +592,13 @@ Method Summary
Retrieve a collection of BitPay invoices.
|
-
+
protected LedgerClient |
getLedgerClient()
Get ledger client.
|
-
+
List<LedgerEntry> |
getLedgerEntries(String currency,
String dateStart,
@@ -544,35 +606,35 @@ Method Summary
Retrieve a list of ledgers entries by currency and date range using the merchant facade.
|
-
+
List<Ledger> |
getLedgers()
Retrieve a list of ledgers using the merchant facade.
|
-
+
Payout |
getPayout(String payoutId)
Retrieve a BitPay payout by payout id using.
|
-
+
protected PayoutClient |
getPayoutClient()
Get payout client.
|
-
+
protected PayoutGroupClient |
getPayoutGroupClient() |
-
+
PayoutRecipient |
getPayoutRecipient(String recipientId)
Retrieve a BitPay payout recipient by batch id using.
|
-
+
List<PayoutRecipient> |
getPayoutRecipients(String status,
Integer limit,
@@ -580,13 +642,13 @@ Method Summary
Retrieve a collection of BitPay Payout Recipients.
|
-
+
protected PayoutRecipientsClient |
getPayoutRecipientsClient()
Get payout recipients client.
|
-
+
List<Payout> |
getPayouts(String startDate,
String endDate,
@@ -598,75 +660,75 @@ Method Summary
Retrieve a collection of BitPay payouts.
|
-
+
Rate |
getRate(String baseCurrency,
String currency)
Retrieve the rates for a cryptocurrency / fiat pair.
|
-
+
RateClient |
getRateClient()
Gets rates client.
|
-
+
Rates |
getRates()
Retrieve the exchange rate table maintained by BitPay.
|
-
+
Rates |
getRates(String baseCurrency)
Retrieve the exchange rate table maintained by BitPay by baseCurrency.
|
-
+
Refund |
getRefund(String refundId)
Retrieve a previously made refund request on a BitPay invoice.
|
-
+
Refund |
getRefundByGuid(String guid)
Retrieve a previously made refund request on a BitPay invoice.
|
-
+
protected RefundClient |
getRefundClient()
Get refund client.
|
-
+
List<Refund> |
getRefunds(String invoiceId)
Retrieve all refund requests on a BitPay invoice.
|
-
+
Settlement |
getSettlement(String settlementId)
Retrieves a summary of the specified settlement.
|
-
+
protected SettlementClient |
getSettlementClient()
Get settlement client.
|
-
+
Settlement |
getSettlementReconciliationReport(String settlementId,
String token)
Gets a detailed reconciliation report of the activity within the settlement period.
|
-
+
List<Settlement> |
getSettlements(String currency,
String dateStart,
@@ -677,82 +739,82 @@ Method Summary
Retrieves settlement reports for the calling merchant filtered by query.
|
-
+
List<Wallet> |
getSupportedWallets()
Retrieve all supported wallets.
|
-
+
protected WalletClient |
getWalletClient()
Get wallet client.
|
-
+
protected boolean |
isSignRequest(Facade facade)
Is sign request boolean.
|
-
+
Invoice |
payInvoice(String invoiceId,
String status)
Pay a BitPay invoice with a mock transaction.
|
-
+
Boolean |
requestInvoiceWebhookToBeResent(String invoiceId)
The intent of this call is to address issues when BitPay sends a webhook but the client doesn't receive it,
so the client can request that BitPay resend it.
|
-
+
Boolean |
requestPayoutNotification(String payoutId)
Request a payout notification.
|
-
+
Boolean |
requestPayoutRecipientNotification(String recipientId)
Request a payout recipient notification.
|
-
+
Boolean |
sendRefundNotification(String refundId)
Send a refund notification.
|
-
+
Payout |
submitPayout(Payout payout)
Submit a BitPay Payout.
|
-
+
List<PayoutRecipient> |
submitPayoutRecipients(PayoutRecipients recipients)
Submit BitPay Payout Recipients.
|
-
+
PayoutGroup |
submitPayouts(Collection<Payout> payouts)
Submit a BitPay Payouts.
|
-
+
Bill |
updateBill(Bill bill,
String billId)
Update a BitPay Bill.
|
-
+
Invoice |
updateInvoice(String invoiceId,
String buyerSms,
@@ -762,21 +824,21 @@ Method Summary
Update a BitPay invoice with communication method.
|
-
+
PayoutRecipient |
updatePayoutRecipient(String recipientId,
PayoutRecipient recipient)
Update a Payout Recipient.
|
-
+
Refund |
updateRefund(String refundId,
String status)
Update the status of a BitPay invoice.
|
-
+
Refund |
updateRefundByGuid(String guid,
String status)
@@ -870,6 +932,25 @@ Client
+
+
+
+
@@ -889,6 +970,27 @@ Client
+
+
+
+
@@ -914,6 +1016,33 @@ Client
+
+
+
+
+-
+
Client
+public Client(Environment environment,
+ PrivateKey privateKey,
+ TokenContainer tokenContainer,
+ org.apache.http.HttpHost proxyDetails,
+ org.apache.http.client.CredentialsProvider proxyCredentials,
+ String platformInfo)
+ throws BitPayGenericException
+Constructor for use if the keys and SIN are managed by this library.
+
+- Parameters:
+environment - Target environment. Options: Env.Test / Env.ProdprivateKey - The full path to the securely located private key or the HEX key value.tokenContainer - Object containing the available tokens.proxyDetails - HttpHost Optional Proxy setting (set to NULL to ignore)proxyCredentials - CredentialsProvider Optional Proxy Basic Auth Credentials (set to NULL to ignore)platformInfo - Platform Info- Throws:
+BitPayGenericException - BitPayGenericException class
+
+
@@ -935,6 +1064,29 @@ Client
+
+
+
+
+-
+
Client
+public Client(ConfigFilePath configFilePath,
+ org.apache.http.HttpHost proxy,
+ org.apache.http.client.CredentialsProvider proxyCredentials,
+ String platformInfo)
+ throws BitPayGenericException
+Constructor for use if the keys and SIN are managed by this library.
+
+- Parameters:
+configFilePath - The path to the configuration file.proxy - HttpHost Optional Proxy setting (set to NULL to ignore)proxyCredentials - CredentialsProvider Optional Proxy Basic Auth Credentials (set to NULL to ignore)platformInfo - Platform Info- Throws:
+BitPayGenericException - BitPayGenericException class
+
+
@@ -982,6 +1134,27 @@ createPosClient
+
+
+
+
@@ -1003,6 +1176,29 @@ createPosClient
+
+
+
+
@@ -1026,6 +1222,31 @@ createClientByPrivateKey
+
+
+
+
+-
+
createClientByPrivateKey
+public static Client createClientByPrivateKey(PrivateKey privateKey,
+ TokenContainer tokenContainer,
+ Environment environment,
+ String platformInfo)
+ throws BitPayGenericException
+Create standard client.
+
+- Parameters:
+privateKey - the private keytokenContainer - the token containerenvironment - environmentplatformInfo - the platform info- Returns:
+- Client Client
+- Throws:
+BitPayGenericException - BitPayGenericException class
+
+
@@ -1045,6 +1266,27 @@ createClientByConfigFilePath
+
+
+
+
diff --git a/docs/com/bitpay/sdk/class-use/Client.html b/docs/com/bitpay/sdk/class-use/Client.html
index 6ffb7cff..9582aabd 100644
--- a/docs/com/bitpay/sdk/class-use/Client.html
+++ b/docs/com/bitpay/sdk/class-use/Client.html
@@ -112,12 +112,28 @@ |
+
+static Client |
Client.createClientByPrivateKey(PrivateKey privateKey,
TokenContainer tokenContainer,
Environment environment)
Create standard client.
|
+
+static Client |
+Client.createClientByPrivateKey(PrivateKey privateKey,
+ TokenContainer tokenContainer,
+ Environment environment,
+ String platformInfo)
+Create standard client.
+ |
+
static Client |
Client.createPosClient(PosToken token)
@@ -131,6 +147,21 @@ |
+
+static Client |
+Client.createPosClient(PosToken token,
+ Environment environment,
+ String platformInfo)
+Create pos (light) client.
+ |
+
+
+static Client |
+Client.createPosClient(PosToken token,
+ String platformInfo)
+Create pos (light) client.
+ |
+
diff --git a/docs/com/bitpay/sdk/class-use/ConfigFilePath.html b/docs/com/bitpay/sdk/class-use/ConfigFilePath.html
index d71ce758..458498aa 100644
--- a/docs/com/bitpay/sdk/class-use/ConfigFilePath.html
+++ b/docs/com/bitpay/sdk/class-use/ConfigFilePath.html
@@ -116,6 +116,13 @@
diff --git a/docs/com/bitpay/sdk/class-use/Environment.html b/docs/com/bitpay/sdk/class-use/Environment.html
index 80df63c6..d44721b0 100644
--- a/docs/com/bitpay/sdk/class-use/Environment.html
+++ b/docs/com/bitpay/sdk/class-use/Environment.html
@@ -148,11 +148,28 @@
diff --git a/docs/com/bitpay/sdk/class-use/PrivateKey.html b/docs/com/bitpay/sdk/class-use/PrivateKey.html
index fe9c3578..1ecb44e6 100644
--- a/docs/com/bitpay/sdk/class-use/PrivateKey.html
+++ b/docs/com/bitpay/sdk/class-use/PrivateKey.html
@@ -113,6 +113,15 @@
diff --git a/docs/index-all.html b/docs/index-all.html
index 212d436c..29cbdda8 100644
--- a/docs/index-all.html
+++ b/docs/index-all.html
@@ -326,6 +326,10 @@ B
Instantiates a new Bit pay client.
+BitPayClient(HttpClient, HttpRequestFactory, String, ECKey, String) - Constructor for class com.bitpay.sdk.client.BitPayClient
+
+Instantiates a new Bit pay client.
+
BitPayException - Exception in com.bitpay.sdk.exceptions
General BitPay Exception which is inherited by all other exceptions.
@@ -573,18 +577,34 @@ C
Constructor for POS facade.
+Client(PosToken, String) - Constructor for class com.bitpay.sdk.Client
+
+Constructor for POS facade.
+
Client(PosToken, Environment) - Constructor for class com.bitpay.sdk.Client
Constructor for POS facade.
+Client(PosToken, Environment, String) - Constructor for class com.bitpay.sdk.Client
+
+Constructor for POS facade.
+
Client(Environment, PrivateKey, TokenContainer, HttpHost, CredentialsProvider) - Constructor for class com.bitpay.sdk.Client
Constructor for use if the keys and SIN are managed by this library.
+Client(Environment, PrivateKey, TokenContainer, HttpHost, CredentialsProvider, String) - Constructor for class com.bitpay.sdk.Client
+
+Constructor for use if the keys and SIN are managed by this library.
+
Client(ConfigFilePath, HttpHost, CredentialsProvider) - Constructor for class com.bitpay.sdk.Client
Constructor for use if the keys and SIN are managed by this library.
+Client(ConfigFilePath, HttpHost, CredentialsProvider, String) - Constructor for class com.bitpay.sdk.Client
+
+Constructor for use if the keys and SIN are managed by this library.
+
Client(BitPayClient, String, TokenContainer, GuidGenerator) - Constructor for class com.bitpay.sdk.Client
Constructor for all injected classes.
@@ -756,10 +776,18 @@ C
Create standard client.
+createClientByConfigFilePath(ConfigFilePath, String) - Static method in class com.bitpay.sdk.Client
+
+Create standard client.
+
createClientByPrivateKey(PrivateKey, TokenContainer, Environment) - Static method in class com.bitpay.sdk.Client
Create standard client.
+createClientByPrivateKey(PrivateKey, TokenContainer, Environment, String) - Static method in class com.bitpay.sdk.Client
+
+Create standard client.
+
CREATED - Static variable in class com.bitpay.sdk.model.invoice.RefundStatus
Funds deducted/allocated if immediate,
@@ -807,10 +835,18 @@
C
Create pos (light) client.
+
createPosClient(PosToken, String) - Static method in class com.bitpay.sdk.Client
+
+Create pos (light) client.
+
createPosClient(PosToken, Environment) - Static method in class com.bitpay.sdk.Client
Create pos (light) client.
+
createPosClient(PosToken, Environment, String) - Static method in class com.bitpay.sdk.Client
+
+Create pos (light) client.
+
createRefund(String, Double, Boolean, Boolean, Boolean, String) - Method in class com.bitpay.sdk.Client
Create a refund for a BitPay invoice.