@payabli/sdk-node 0.0.144 → 0.0.146

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.
Files changed (76) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/query/client/Client.d.ts +58 -0
  3. package/dist/cjs/api/resources/query/client/Client.js +160 -0
  4. package/dist/cjs/api/resources/query/client/requests/ListSubscriptionsOrgRequest.d.ts +1 -0
  5. package/dist/cjs/api/resources/query/client/requests/ListSubscriptionsRequest.d.ts +1 -0
  6. package/dist/cjs/api/resources/query/client/requests/ListTransactionsOrgRequest.d.ts +9 -0
  7. package/dist/cjs/api/resources/query/client/requests/ListTransactionsRequest.d.ts +9 -0
  8. package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +8 -6
  9. package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +8 -6
  10. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.d.ts +72 -0
  11. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.js +3 -0
  12. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsRequest.d.ts +72 -0
  13. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsRequest.js +3 -0
  14. package/dist/cjs/api/resources/query/client/requests/ListVendorsOrgRequest.d.ts +1 -0
  15. package/dist/cjs/api/resources/query/client/requests/ListVendorsRequest.d.ts +1 -0
  16. package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
  17. package/dist/cjs/api/resources/queryTypes/types/QueryTransferDetailResponse.d.ts +2 -0
  18. package/dist/cjs/api/resources/queryTypes/types/QueryTransferSummary.d.ts +2 -0
  19. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionQueryResponse.d.ts +49 -0
  20. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionQueryResponse.js +3 -0
  21. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionRecord.d.ts +86 -0
  22. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionRecord.js +3 -0
  23. package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
  24. package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
  25. package/dist/cjs/api/types/CustomerQueryRecords.d.ts +2 -0
  26. package/dist/cjs/api/types/QueryResponseTransactions.d.ts +74 -0
  27. package/dist/cjs/api/types/SplitCount.d.ts +4 -0
  28. package/dist/cjs/api/types/SplitCount.js +3 -0
  29. package/dist/cjs/api/types/SubscriptionQueryRecords.d.ts +10 -0
  30. package/dist/cjs/api/types/TransactionQueryRecords.d.ts +1 -0
  31. package/dist/cjs/api/types/TransactionQueryRecordsCustomer.d.ts +1 -0
  32. package/dist/cjs/api/types/VCardSummary.d.ts +4 -2
  33. package/dist/cjs/api/types/VendorResponseStoredMethod.d.ts +2 -1
  34. package/dist/cjs/api/types/index.d.ts +1 -0
  35. package/dist/cjs/api/types/index.js +1 -0
  36. package/dist/cjs/version.d.ts +1 -1
  37. package/dist/cjs/version.js +1 -1
  38. package/dist/esm/BaseClient.mjs +2 -2
  39. package/dist/esm/api/resources/query/client/Client.d.mts +58 -0
  40. package/dist/esm/api/resources/query/client/Client.mjs +160 -0
  41. package/dist/esm/api/resources/query/client/requests/ListSubscriptionsOrgRequest.d.mts +1 -0
  42. package/dist/esm/api/resources/query/client/requests/ListSubscriptionsRequest.d.mts +1 -0
  43. package/dist/esm/api/resources/query/client/requests/ListTransactionsOrgRequest.d.mts +9 -0
  44. package/dist/esm/api/resources/query/client/requests/ListTransactionsRequest.d.mts +9 -0
  45. package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +8 -6
  46. package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +8 -6
  47. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.d.mts +72 -0
  48. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.mjs +2 -0
  49. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsRequest.d.mts +72 -0
  50. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsRequest.mjs +2 -0
  51. package/dist/esm/api/resources/query/client/requests/ListVendorsOrgRequest.d.mts +1 -0
  52. package/dist/esm/api/resources/query/client/requests/ListVendorsRequest.d.mts +1 -0
  53. package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
  54. package/dist/esm/api/resources/queryTypes/types/QueryTransferDetailResponse.d.mts +2 -0
  55. package/dist/esm/api/resources/queryTypes/types/QueryTransferSummary.d.mts +2 -0
  56. package/dist/esm/api/resources/queryTypes/types/VCardTransactionQueryResponse.d.mts +49 -0
  57. package/dist/esm/api/resources/queryTypes/types/VCardTransactionQueryResponse.mjs +2 -0
  58. package/dist/esm/api/resources/queryTypes/types/VCardTransactionRecord.d.mts +86 -0
  59. package/dist/esm/api/resources/queryTypes/types/VCardTransactionRecord.mjs +2 -0
  60. package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
  61. package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
  62. package/dist/esm/api/types/CustomerQueryRecords.d.mts +2 -0
  63. package/dist/esm/api/types/QueryResponseTransactions.d.mts +74 -0
  64. package/dist/esm/api/types/SplitCount.d.mts +4 -0
  65. package/dist/esm/api/types/SplitCount.mjs +2 -0
  66. package/dist/esm/api/types/SubscriptionQueryRecords.d.mts +10 -0
  67. package/dist/esm/api/types/TransactionQueryRecords.d.mts +1 -0
  68. package/dist/esm/api/types/TransactionQueryRecordsCustomer.d.mts +1 -0
  69. package/dist/esm/api/types/VCardSummary.d.mts +4 -2
  70. package/dist/esm/api/types/VendorResponseStoredMethod.d.mts +2 -1
  71. package/dist/esm/api/types/index.d.mts +1 -0
  72. package/dist/esm/api/types/index.mjs +1 -0
  73. package/dist/esm/version.d.mts +1 -1
  74. package/dist/esm/version.mjs +1 -1
  75. package/package.json +1 -1
  76. package/reference.md +150 -0
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@payabli/sdk-node",
46
- "X-Fern-SDK-Version": "0.0.144",
47
- "User-Agent": "@payabli/sdk-node/0.0.144",
46
+ "X-Fern-SDK-Version": "0.0.146",
47
+ "User-Agent": "@payabli/sdk-node/0.0.146",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -581,6 +581,14 @@ export declare class QueryClient {
581
581
  * limitRecord: 0,
582
582
  * sortBy: "desc(field_name)"
583
583
  * })
584
+ *
585
+ * @example
586
+ * await client.query.listTransactions("8cfec329267", {
587
+ * limitRecord: 1,
588
+ * parameters: {
589
+ * "operation(eq)": "Reject"
590
+ * }
591
+ * })
584
592
  */
585
593
  listTransactions(entry: Payabli.Entry, request?: Payabli.ListTransactionsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryResponseTransactions>;
586
594
  private __listTransactions;
@@ -615,6 +623,14 @@ export declare class QueryClient {
615
623
  * limitRecord: 0,
616
624
  * sortBy: "desc(field_name)"
617
625
  * })
626
+ *
627
+ * @example
628
+ * await client.query.listTransactionsOrg(123, {
629
+ * limitRecord: 1,
630
+ * parameters: {
631
+ * "operation(eq)": "Reject"
632
+ * }
633
+ * })
618
634
  */
619
635
  listTransactionsOrg(orgId: number, request?: Payabli.ListTransactionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryResponseTransactions>;
620
636
  private __listTransactionsOrg;
@@ -842,6 +858,48 @@ export declare class QueryClient {
842
858
  */
843
859
  listVcards(entry: Payabli.Entry, request?: Payabli.ListVcardsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.VCardQueryResponse>;
844
860
  private __listVcards;
861
+ /**
862
+ * Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
863
+ *
864
+ * @param {Payabli.Entry} entry
865
+ * @param {Payabli.ListVcardsTransactionsRequest} request
866
+ * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
867
+ *
868
+ * @throws {@link Payabli.BadRequestError}
869
+ * @throws {@link Payabli.UnauthorizedError}
870
+ * @throws {@link Payabli.InternalServerError}
871
+ * @throws {@link Payabli.ServiceUnavailableError}
872
+ *
873
+ * @example
874
+ * await client.query.listVcardsTransactions("8cfec329267", {
875
+ * fromRecord: 0,
876
+ * limitRecord: 20,
877
+ * sortBy: "desc(CreatedOn)"
878
+ * })
879
+ */
880
+ listVcardsTransactions(entry: Payabli.Entry, request?: Payabli.ListVcardsTransactionsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.VCardTransactionQueryResponse>;
881
+ private __listVcardsTransactions;
882
+ /**
883
+ * Retrieve a list of virtual card transactions for an organization. Use filters to limit results.
884
+ *
885
+ * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
886
+ * @param {Payabli.ListVcardsTransactionsOrgRequest} request
887
+ * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
888
+ *
889
+ * @throws {@link Payabli.BadRequestError}
890
+ * @throws {@link Payabli.UnauthorizedError}
891
+ * @throws {@link Payabli.InternalServerError}
892
+ * @throws {@link Payabli.ServiceUnavailableError}
893
+ *
894
+ * @example
895
+ * await client.query.listVcardsTransactionsOrg(123, {
896
+ * fromRecord: 0,
897
+ * limitRecord: 20,
898
+ * sortBy: "desc(CreatedOn)"
899
+ * })
900
+ */
901
+ listVcardsTransactionsOrg(orgId: number, request?: Payabli.ListVcardsTransactionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.VCardTransactionQueryResponse>;
902
+ private __listVcardsTransactionsOrg;
845
903
  /**
846
904
  * Retrieve a list of vcards (virtual credit cards) issued for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
847
905
  *
@@ -1909,6 +1909,14 @@ class QueryClient {
1909
1909
  * limitRecord: 0,
1910
1910
  * sortBy: "desc(field_name)"
1911
1911
  * })
1912
+ *
1913
+ * @example
1914
+ * await client.query.listTransactions("8cfec329267", {
1915
+ * limitRecord: 1,
1916
+ * parameters: {
1917
+ * "operation(eq)": "Reject"
1918
+ * }
1919
+ * })
1912
1920
  */
1913
1921
  listTransactions(entry, request = {}, requestOptions) {
1914
1922
  return core.HttpResponsePromise.fromPromise(this.__listTransactions(entry, request, requestOptions));
@@ -1992,6 +2000,14 @@ class QueryClient {
1992
2000
  * limitRecord: 0,
1993
2001
  * sortBy: "desc(field_name)"
1994
2002
  * })
2003
+ *
2004
+ * @example
2005
+ * await client.query.listTransactionsOrg(123, {
2006
+ * limitRecord: 1,
2007
+ * parameters: {
2008
+ * "operation(eq)": "Reject"
2009
+ * }
2010
+ * })
1995
2011
  */
1996
2012
  listTransactionsOrg(orgId, request = {}, requestOptions) {
1997
2013
  return core.HttpResponsePromise.fromPromise(this.__listTransactionsOrg(orgId, request, requestOptions));
@@ -2800,6 +2816,150 @@ class QueryClient {
2800
2816
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/vcards/{entry}");
2801
2817
  });
2802
2818
  }
2819
+ /**
2820
+ * Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
2821
+ *
2822
+ * @param {Payabli.Entry} entry
2823
+ * @param {Payabli.ListVcardsTransactionsRequest} request
2824
+ * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
2825
+ *
2826
+ * @throws {@link Payabli.BadRequestError}
2827
+ * @throws {@link Payabli.UnauthorizedError}
2828
+ * @throws {@link Payabli.InternalServerError}
2829
+ * @throws {@link Payabli.ServiceUnavailableError}
2830
+ *
2831
+ * @example
2832
+ * await client.query.listVcardsTransactions("8cfec329267", {
2833
+ * fromRecord: 0,
2834
+ * limitRecord: 20,
2835
+ * sortBy: "desc(CreatedOn)"
2836
+ * })
2837
+ */
2838
+ listVcardsTransactions(entry, request = {}, requestOptions) {
2839
+ return core.HttpResponsePromise.fromPromise(this.__listVcardsTransactions(entry, request, requestOptions));
2840
+ }
2841
+ __listVcardsTransactions(entry_1) {
2842
+ return __awaiter(this, arguments, void 0, function* (entry, request = {}, requestOptions) {
2843
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
2844
+ const { fromRecord, limitRecord, parameters, sortBy } = request;
2845
+ const _queryParams = {
2846
+ fromRecord,
2847
+ limitRecord,
2848
+ parameters: parameters != null ? (0, json_js_1.toJson)(parameters) : undefined,
2849
+ sortBy,
2850
+ };
2851
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
2852
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
2853
+ const _response = yield core.fetcher({
2854
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Query/vcardsTransactions/${core.url.encodePathParam(entry)}`),
2855
+ method: "GET",
2856
+ headers: _headers,
2857
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
2858
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
2859
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
2860
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
2861
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
2862
+ logging: this._options.logging,
2863
+ });
2864
+ if (_response.ok) {
2865
+ return {
2866
+ data: _response.body,
2867
+ rawResponse: _response.rawResponse,
2868
+ };
2869
+ }
2870
+ if (_response.error.reason === "status-code") {
2871
+ switch (_response.error.statusCode) {
2872
+ case 400:
2873
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
2874
+ case 401:
2875
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
2876
+ case 500:
2877
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
2878
+ case 503:
2879
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
2880
+ default:
2881
+ throw new errors.PayabliError({
2882
+ statusCode: _response.error.statusCode,
2883
+ body: _response.error.body,
2884
+ rawResponse: _response.rawResponse,
2885
+ });
2886
+ }
2887
+ }
2888
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/vcardsTransactions/{entry}");
2889
+ });
2890
+ }
2891
+ /**
2892
+ * Retrieve a list of virtual card transactions for an organization. Use filters to limit results.
2893
+ *
2894
+ * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
2895
+ * @param {Payabli.ListVcardsTransactionsOrgRequest} request
2896
+ * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
2897
+ *
2898
+ * @throws {@link Payabli.BadRequestError}
2899
+ * @throws {@link Payabli.UnauthorizedError}
2900
+ * @throws {@link Payabli.InternalServerError}
2901
+ * @throws {@link Payabli.ServiceUnavailableError}
2902
+ *
2903
+ * @example
2904
+ * await client.query.listVcardsTransactionsOrg(123, {
2905
+ * fromRecord: 0,
2906
+ * limitRecord: 20,
2907
+ * sortBy: "desc(CreatedOn)"
2908
+ * })
2909
+ */
2910
+ listVcardsTransactionsOrg(orgId, request = {}, requestOptions) {
2911
+ return core.HttpResponsePromise.fromPromise(this.__listVcardsTransactionsOrg(orgId, request, requestOptions));
2912
+ }
2913
+ __listVcardsTransactionsOrg(orgId_1) {
2914
+ return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
2915
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
2916
+ const { fromRecord, limitRecord, parameters, sortBy } = request;
2917
+ const _queryParams = {
2918
+ fromRecord,
2919
+ limitRecord,
2920
+ parameters: parameters != null ? (0, json_js_1.toJson)(parameters) : undefined,
2921
+ sortBy,
2922
+ };
2923
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
2924
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
2925
+ const _response = yield core.fetcher({
2926
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Query/vcardsTransactions/org/${core.url.encodePathParam(orgId)}`),
2927
+ method: "GET",
2928
+ headers: _headers,
2929
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
2930
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
2931
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
2932
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
2933
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
2934
+ logging: this._options.logging,
2935
+ });
2936
+ if (_response.ok) {
2937
+ return {
2938
+ data: _response.body,
2939
+ rawResponse: _response.rawResponse,
2940
+ };
2941
+ }
2942
+ if (_response.error.reason === "status-code") {
2943
+ switch (_response.error.statusCode) {
2944
+ case 400:
2945
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
2946
+ case 401:
2947
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
2948
+ case 500:
2949
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
2950
+ case 503:
2951
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
2952
+ default:
2953
+ throw new errors.PayabliError({
2954
+ statusCode: _response.error.statusCode,
2955
+ body: _response.error.body,
2956
+ rawResponse: _response.rawResponse,
2957
+ });
2958
+ }
2959
+ }
2960
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/vcardsTransactions/org/{orgId}");
2961
+ });
2962
+ }
2803
2963
  /**
2804
2964
  * Retrieve a list of vcards (virtual credit cards) issued for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
2805
2965
  *
@@ -70,6 +70,7 @@ export interface ListSubscriptionsOrgRequest {
70
70
  * - `orgName` (ne, eq, ct, nct)
71
71
  * - `externalPaypointId` (ct, nct, ne, eq)
72
72
  * - `subId` (eq, ne)
73
+ * - `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
73
74
  * - `orderDescription` (ct, nct)
74
75
  * - `cycles` (eq, ne, gt, ge, lt, le)
75
76
  * - `leftcycles` (eq, ne, gt, ge, lt, le)
@@ -70,6 +70,7 @@ export interface ListSubscriptionsRequest {
70
70
  * - `orgName` (ne, eq, ct, nct)
71
71
  * - `externalPaypointId` (ct, nct, ne, eq)
72
72
  * - `subId` (eq, ne)
73
+ * - `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
73
74
  * - `orderDescription` (ct, nct)
74
75
  * - `cycles` (eq, ne, gt, ge, lt, le)
75
76
  * - `leftcycles` (eq, ne, gt, ge, lt, le)
@@ -6,6 +6,14 @@ import type * as Payabli from "../../../../index.js";
6
6
  * limitRecord: 0,
7
7
  * sortBy: "desc(field_name)"
8
8
  * }
9
+ *
10
+ * @example
11
+ * {
12
+ * limitRecord: 1,
13
+ * parameters: {
14
+ * "operation(eq)": "Reject"
15
+ * }
16
+ * }
9
17
  */
10
18
  export interface ListTransactionsOrgRequest {
11
19
  exportFormat?: Payabli.ExportFormat;
@@ -39,6 +47,7 @@ export interface ListTransactionsOrgRequest {
39
47
  * - `scheduleId` (ne, eq)
40
48
  * - `returnId` (ne, eq)
41
49
  * - `refundId` (ne, eq)
50
+ * - `rejectId` (ne, eq)
42
51
  * - `idTrans` (ne, eq)
43
52
  * - `orgId` (ne, eq)
44
53
  * - `paypointId` (ne, eq)
@@ -6,6 +6,14 @@ import type * as Payabli from "../../../../index.js";
6
6
  * limitRecord: 0,
7
7
  * sortBy: "desc(field_name)"
8
8
  * }
9
+ *
10
+ * @example
11
+ * {
12
+ * limitRecord: 1,
13
+ * parameters: {
14
+ * "operation(eq)": "Reject"
15
+ * }
16
+ * }
9
17
  */
10
18
  export interface ListTransactionsRequest {
11
19
  exportFormat?: Payabli.ExportFormat;
@@ -39,6 +47,7 @@ export interface ListTransactionsRequest {
39
47
  * - `scheduleId` (ne, eq)
40
48
  * - `returnId` (ne, eq)
41
49
  * - `refundId` (ne, eq)
50
+ * - `rejectId` (ne, eq)
42
51
  * - `idTrans` (ne, eq)
43
52
  * - `orgId` (ne, eq)
44
53
  * - `paypointId` (ne, eq)
@@ -30,13 +30,13 @@ export interface ListVcardsOrgRequest {
30
30
  * </Info>
31
31
  * List of field names accepted:
32
32
  *
33
- * - `status` (in, nin, eq, ne)
33
+ * - `status` (eq, ne, ct, nct, sw, ew)
34
34
  * - `createdAt` (gt, ge, lt, le, eq, ne)
35
35
  * - `cardToken` (ct, nct, eq, ne)
36
36
  * - `lastFour` (ct, nct, eq, ne)
37
37
  * - `expirationDate` (ct, nct, eq, ne)
38
- * - `payoutId` (ct, nct, eq, ne, in, nin)
39
- * - `vendorId` (ct, nct, eq, ne, in, nin)
38
+ * - `payoutId` (eq, ne, gt, ge, lt, le)
39
+ * - `vendorId` (eq, ne, gt, ge, lt, le)
40
40
  * - `miscData1` (ct, nct, eq, ne)
41
41
  * - `miscData2` (ct, nct, eq, ne)
42
42
  * - `currentUses` (gt, ge, lt, le, eq, ne)
@@ -44,10 +44,10 @@ export interface ListVcardsOrgRequest {
44
44
  * - `balance` (gt, ge, lt, le, eq, ne)
45
45
  * - `paypointLegal` (ne, eq, ct, nct)
46
46
  * - `paypointDba` (ne, eq, ct, nct)
47
- * - `orgName` (ne, eq, ct, nct)
47
+ * - `orgName` (eq, ne, ct, nct, sw, ew)
48
48
  * - `externalPaypointId` (ct, nct, eq, ne)
49
- * - `paypointId` (in, nin, eq, ne)
50
- * - `cardType` (eq)
49
+ * - `paypointId` (eq, ne, gt, ge, lt, le)
50
+ * - `cardType` (eq, ne, gt, ge, lt, le)
51
51
  *
52
52
  * List of comparison accepted - enclosed between parentheses:
53
53
  *
@@ -59,6 +59,8 @@ export interface ListVcardsOrgRequest {
59
59
  * - ne => not equal
60
60
  * - ct => contains
61
61
  * - nct => not contains
62
+ * - sw => starts with
63
+ * - ew => ends with
62
64
  * - in => inside array separated by "|"
63
65
  * - nin => not inside array separated by "|"
64
66
  */
@@ -30,13 +30,13 @@ export interface ListVcardsRequest {
30
30
  * </Info>
31
31
  * List of field names accepted:
32
32
  *
33
- * - `status` (in, nin, eq, ne)
33
+ * - `status` (eq, ne, ct, nct, sw, ew)
34
34
  * - `createdAt` (gt, ge, lt, le, eq, ne)
35
35
  * - `cardToken` (ct, nct, eq, ne)
36
36
  * - `lastFour` (ct, nct, eq, ne)
37
37
  * - `expirationDate` (ct, nct, eq, ne)
38
- * - `payoutId` (ct, nct, eq, ne, in, nin)
39
- * - `vendorId` (ct, nct, eq, ne, in, nin)
38
+ * - `payoutId` (eq, ne, gt, ge, lt, le)
39
+ * - `vendorId` (eq, ne, gt, ge, lt, le)
40
40
  * - `miscData1` (ct, nct, eq, ne)
41
41
  * - `miscData2` (ct, nct, eq, ne)
42
42
  * - `currentUses` (gt, ge, lt, le, eq, ne)
@@ -44,10 +44,10 @@ export interface ListVcardsRequest {
44
44
  * - `balance` (gt, ge, lt, le, eq, ne)
45
45
  * - `paypointLegal` (ne, eq, ct, nct)
46
46
  * - `paypointDba` (ne, eq, ct, nct)
47
- * - `orgName` (ne, eq, ct, nct)
47
+ * - `orgName` (eq, ne, ct, nct, sw, ew)
48
48
  * - `externalPaypointId` (ct, nct, eq, ne)
49
- * - `paypointId` (in, nin, eq, ne)
50
- * - `cardType` (eq)
49
+ * - `paypointId` (eq, ne, gt, ge, lt, le)
50
+ * - `cardType` (eq, ne, gt, ge, lt, le)
51
51
  *
52
52
  * List of comparison accepted - enclosed between parentheses:
53
53
  *
@@ -59,6 +59,8 @@ export interface ListVcardsRequest {
59
59
  * - ne => not equal
60
60
  * - ct => contains
61
61
  * - nct => not contains
62
+ * - sw => starts with
63
+ * - ew => ends with
62
64
  * - in => inside array separated by "|"
63
65
  * - nin => not inside array separated by "|"
64
66
  */
@@ -0,0 +1,72 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * fromRecord: 0,
5
+ * limitRecord: 20,
6
+ * sortBy: "desc(CreatedOn)"
7
+ * }
8
+ */
9
+ export interface ListVcardsTransactionsOrgRequest {
10
+ /** The number of records to skip before starting to collect the result set. */
11
+ fromRecord?: number;
12
+ /** Max number of records to return for the query. Use `0` or negative value to return all records. */
13
+ limitRecord?: number;
14
+ /**
15
+ * Collection of field names, conditions, and values used to filter the query.
16
+ *
17
+ * <Info>
18
+ * **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
19
+ *
20
+ * Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
21
+ *
22
+ * For example:
23
+ *
24
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?parameters=transactionAmount(gt)=100&limitRecord=20
25
+ *
26
+ * should become:
27
+ *
28
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?transactionAmount(gt)=100&limitRecord=20
29
+ * </Info>
30
+ *
31
+ * List of field names accepted:
32
+ *
33
+ * - `identifier` (eq, ne, ct, nct)
34
+ * - `transactionType` (eq, ne, ct, nct)
35
+ * - `transactionStatus` (eq, ne, ct, nct, in, nin)
36
+ * - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
37
+ * - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
38
+ * - `cardToken` (ct, nct, eq, ne)
39
+ * - `lastFour` (ct, nct, eq, ne)
40
+ * - `expirationDate` (ct, nct, eq, ne)
41
+ * - `mcc` (ct, nct, eq, ne)
42
+ * - `payoutId` (gt, lt, eq, ne)
43
+ * - `customerId` (gt, lt, eq, ne)
44
+ * - `vendorId` (gt, lt, eq, ne)
45
+ * - `miscData1` (ct, nct, eq, ne)
46
+ * - `miscData2` (ct, nct, eq, ne)
47
+ * - `currentUses` (gt, ge, lt, le, eq, ne)
48
+ * - `amount` (gt, ge, lt, le, eq, ne)
49
+ * - `balance` (gt, ge, lt, le, eq, ne)
50
+ * - `paypointLegal` (ne, eq, ct, nct)
51
+ * - `paypointDba` (ne, eq, ct, nct)
52
+ * - `orgName` (ne, eq, ct, nct, in, nin)
53
+ * - `externalPaypointID` (ct, nct, eq, ne)
54
+ * - `paypointId` (gt, lt, eq, ne)
55
+ *
56
+ * List of comparison accepted - enclosed between parentheses:
57
+ *
58
+ * - eq or empty => equal
59
+ * - gt => greater than
60
+ * - ge => greater or equal
61
+ * - lt => less than
62
+ * - le => less or equal
63
+ * - ne => not equal
64
+ * - ct => contains
65
+ * - nct => not contains
66
+ * - in => inside array separated by "|"
67
+ * - nin => not inside array separated by "|"
68
+ */
69
+ parameters?: Record<string, string>;
70
+ /** The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. */
71
+ sortBy?: string;
72
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,72 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * fromRecord: 0,
5
+ * limitRecord: 20,
6
+ * sortBy: "desc(CreatedOn)"
7
+ * }
8
+ */
9
+ export interface ListVcardsTransactionsRequest {
10
+ /** The number of records to skip before starting to collect the result set. */
11
+ fromRecord?: number;
12
+ /** Max number of records to return for the query. Use `0` or negative value to return all records. */
13
+ limitRecord?: number;
14
+ /**
15
+ * Collection of field names, conditions, and values used to filter the query.
16
+ *
17
+ * <Info>
18
+ * **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
19
+ *
20
+ * Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
21
+ *
22
+ * For example:
23
+ *
24
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?parameters=transactionAmount(gt)=100&limitRecord=20
25
+ *
26
+ * should become:
27
+ *
28
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?transactionAmount(gt)=100&limitRecord=20
29
+ * </Info>
30
+ *
31
+ * List of field names accepted:
32
+ *
33
+ * - `identifier` (eq, ne, ct, nct)
34
+ * - `transactionType` (eq, ne, ct, nct)
35
+ * - `transactionStatus` (eq, ne, ct, nct, in, nin)
36
+ * - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
37
+ * - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
38
+ * - `cardToken` (ct, nct, eq, ne)
39
+ * - `lastFour` (ct, nct, eq, ne)
40
+ * - `expirationDate` (ct, nct, eq, ne)
41
+ * - `mcc` (ct, nct, eq, ne)
42
+ * - `payoutId` (gt, lt, eq, ne)
43
+ * - `customerId` (gt, lt, eq, ne)
44
+ * - `vendorId` (gt, lt, eq, ne)
45
+ * - `miscData1` (ct, nct, eq, ne)
46
+ * - `miscData2` (ct, nct, eq, ne)
47
+ * - `currentUses` (gt, ge, lt, le, eq, ne)
48
+ * - `amount` (gt, ge, lt, le, eq, ne)
49
+ * - `balance` (gt, ge, lt, le, eq, ne)
50
+ * - `paypointLegal` (ne, eq, ct, nct)
51
+ * - `paypointDba` (ne, eq, ct, nct)
52
+ * - `orgName` (ne, eq, ct, nct, in, nin)
53
+ * - `externalPaypointID` (ct, nct, eq, ne)
54
+ * - `paypointId` (gt, lt, eq, ne)
55
+ *
56
+ * List of comparison accepted - enclosed between parentheses:
57
+ *
58
+ * - eq or empty => equal
59
+ * - gt => greater than
60
+ * - ge => greater or equal
61
+ * - lt => less than
62
+ * - le => less or equal
63
+ * - ne => not equal
64
+ * - ct => contains
65
+ * - nct => not contains
66
+ * - in => inside array separated by "|"
67
+ * - nin => not inside array separated by "|"
68
+ */
69
+ parameters?: Record<string, string>;
70
+ /** The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. */
71
+ sortBy?: string;
72
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -39,6 +39,7 @@ export interface ListVendorsOrgRequest {
39
39
  * - `ein` (ct, nct, eq, ne)
40
40
  * - `phone` (ct, nct, eq, ne)
41
41
  * - `email` (ct, nct, eq, ne)
42
+ * - `remitEmail` (ct, nct, eq, ne)
42
43
  * - `address` (ct, nct, eq, ne)
43
44
  * - `city` (ct, nct, eq, ne)
44
45
  * - `state` (ct, nct, eq, ne)
@@ -39,6 +39,7 @@ export interface ListVendorsRequest {
39
39
  * - `ein` (ct, nct, eq, ne)
40
40
  * - `phone` (ct, nct, eq, ne)
41
41
  * - `email` (ct, nct, eq, ne)
42
+ * - `remitEmail` (ct, nct, eq, ne)
42
43
  * - `address` (ct, nct, eq, ne)
43
44
  * - `city` (ct, nct, eq, ne)
44
45
  * - `state` (ct, nct, eq, ne)
@@ -36,5 +36,7 @@ export type { ListUsersOrgRequest } from "./ListUsersOrgRequest.js";
36
36
  export type { ListUsersPaypointRequest } from "./ListUsersPaypointRequest.js";
37
37
  export type { ListVcardsOrgRequest } from "./ListVcardsOrgRequest.js";
38
38
  export type { ListVcardsRequest } from "./ListVcardsRequest.js";
39
+ export type { ListVcardsTransactionsOrgRequest } from "./ListVcardsTransactionsOrgRequest.js";
40
+ export type { ListVcardsTransactionsRequest } from "./ListVcardsTransactionsRequest.js";
39
41
  export type { ListVendorsOrgRequest } from "./ListVendorsOrgRequest.js";
40
42
  export type { ListVendorsRequest } from "./ListVendorsRequest.js";
@@ -43,6 +43,8 @@ export declare namespace QueryTransferDetailResponse {
43
43
  netTransferAmount: number | null;
44
44
  /** Total amount directed to split funding destinations */
45
45
  splitFundingAmount: number | null;
46
+ /** Total amount rejected by card networks or issuing banks after authorization or settling in this transaction */
47
+ cardRejectedAmount: number | null;
46
48
  billingFeesDetails: Payabli.BillingFeeDetail[] | null;
47
49
  ParentOrgName: Payabli.OrgParentName | null;
48
50
  PaypointDbaname: Payabli.Dbaname | null;
@@ -31,6 +31,8 @@ export interface QueryTransferSummary {
31
31
  refunds: number | null;
32
32
  /** Funds being held for fraud or risk concerns. */
33
33
  heldAmount: number | null;
34
+ /** Total amount rejected by card networks or issuing banks after authorization or settling. This value is the sum of all rejected amounts for transactions in the transfer. */
35
+ cardRejectedAmount: number | null;
34
36
  /** Number of records in the response. */
35
37
  totalRecords: Payabli.Totalrecords | null;
36
38
  /** The total sum of the transfers in the response. */