@digitalworld/digital-world-sdk 16.0.0

package/lib/axios/cjs/gateway/payment_call_builder.js

@@ -0,0 +1,51 @@
+'use strict';
+
+var call_builder = require('./call_builder.js');
+
+class PaymentCallBuilder extends call_builder.CallBuilder {
+  constructor(serverUrl, httpClient) {
+    super(serverUrl, httpClient, "payments");
+    this.setPath("payments");
+  }
+  /**
+   * This endpoint responds with a collection of Payment operations where the given account was either the sender or receiver.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/horizon/resources/get-payments-by-account-id | Payments for Account}
+   * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+   * @returns this PaymentCallBuilder instance
+   */
+  forAccount(accountId) {
+    return this.forEndpoint("accounts", accountId);
+  }
+  /**
+   * This endpoint represents all payment operations that are part of a valid transactions in a given ledger.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/horizon/resources/retrieve-a-ledgers-payments | Payments for Ledger}
+   * @param sequence - Ledger sequence
+   * @returns this PaymentCallBuilder instance
+   */
+  forLedger(sequence) {
+    return this.forEndpoint("ledgers", sequence.toString());
+  }
+  /**
+   * This endpoint represents all payment operations that are part of a given transaction.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/transactions/payments/ | Payments for Transaction}
+   * @param transactionId - Transaction ID
+   * @returns this PaymentCallBuilder instance
+   */
+  forTransaction(transactionId) {
+    return this.forEndpoint("transactions", transactionId);
+  }
+  /**
+   * Adds a parameter defining whether to include failed transactions.
+   *   By default, only operations of successful transactions are returned.
+   *
+   * @param value - Set to `true` to include operations of failed transactions.
+   * @returns this PaymentCallBuilder instance
+   */
+  includeFailed(value) {
+    this.url.searchParams.set("include_failed", value.toString());
+    return this;
+  }
+}
+
+exports.PaymentCallBuilder = PaymentCallBuilder;
+//# sourceMappingURL=payment_call_builder.js.map

package/lib/axios/cjs/gateway/payment_call_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment_call_builder.js","sources":["../../../../src/gateway/payment_call_builder.ts"],"sourcesContent":["import { CallBuilder } from \"./call_builder.js\";\nimport { ServerApi } from \"./server_api.js\";\nimport type { HttpClient } from \"../http-client/index.js\";\n\n/**\n * Creates a new {@link PaymentCallBuilder} pointed to server defined by serverUrl.\n *\n * Do not create this object directly, use {@link Gateway.Server.payments}.\n *\n * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/horizon/resources/list-all-payments/ | All Payments}\n *\n * @param serverUrl - Gateway server URL.\n */\nexport class PaymentCallBuilder extends CallBuilder<\n  ServerApi.CollectionPage<\n    | ServerApi.PaymentOperationRecord\n    | ServerApi.CreateAccountOperationRecord\n    | ServerApi.AccountMergeOperationRecord\n    | ServerApi.PathPaymentOperationRecord\n    | ServerApi.PathPaymentStrictSendOperationRecord\n    | ServerApi.InvokeHostFunctionOperationRecord\n  >\n> {\n  constructor(serverUrl: URL, httpClient: HttpClient) {\n    super(serverUrl, httpClient, \"payments\");\n    this.setPath(\"payments\");\n  }\n\n  /**\n   * This endpoint responds with a collection of Payment operations where the given account was either the sender or receiver.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/horizon/resources/get-payments-by-account-id | Payments for Account}\n   * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`\n   * @returns this PaymentCallBuilder instance\n   */\n  public forAccount(accountId: string): this {\n    return this.forEndpoint(\"accounts\", accountId);\n  }\n\n  /**\n   * This endpoint represents all payment operations that are part of a valid transactions in a given ledger.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/horizon/resources/retrieve-a-ledgers-payments | Payments for Ledger}\n   * @param sequence - Ledger sequence\n   * @returns this PaymentCallBuilder instance\n   */\n  public forLedger(sequence: number | string): this {\n    return this.forEndpoint(\"ledgers\", sequence.toString());\n  }\n\n  /**\n   * This endpoint represents all payment operations that are part of a given transaction.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/transactions/payments/ | Payments for Transaction}\n   * @param transactionId - Transaction ID\n   * @returns this PaymentCallBuilder instance\n   */\n  public forTransaction(transactionId: string): this {\n    return this.forEndpoint(\"transactions\", transactionId);\n  }\n\n  /**\n   * Adds a parameter defining whether to include failed transactions.\n   *   By default, only operations of successful transactions are returned.\n   *\n   * @param value - Set to `true` to include operations of failed transactions.\n   * @returns this PaymentCallBuilder instance\n   */\n  public includeFailed(value: boolean): this {\n    this.url.searchParams.set(\"include_failed\", value.toString());\n    return this;\n  }\n}\n"],"names":["CallBuilder"],"mappings":";;;;AAaO,MAAM,2BAA2BA,wBAAA,CAStC;AAAA,EACA,WAAA,CAAY,WAAgB,UAAA,EAAwB;AAClD,IAAA,KAAA,CAAM,SAAA,EAAW,YAAY,UAAU,CAAA;AACvC,IAAA,IAAA,CAAK,QAAQ,UAAU,CAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,WAAW,SAAA,EAAyB;AACzC,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,UAAA,EAAY,SAAS,CAAA;AAAA,EAC/C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,UAAU,QAAA,EAAiC;AAChD,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,SAAA,EAAW,QAAA,CAAS,UAAU,CAAA;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,eAAe,aAAA,EAA6B;AACjD,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,cAAA,EAAgB,aAAa,CAAA;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,cAAc,KAAA,EAAsB;AACzC,IAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,gBAAA,EAAkB,KAAA,CAAM,UAAU,CAAA;AAC5D,IAAA,OAAO,IAAA;AAAA,EACT;AACF;;;;"}