@companix/yookassa 0.0.2 → 0.0.4

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 (79) hide show
  1. package/dist/api/common.d.ts +644 -0
  2. package/dist/api/enums/common.d.ts +21 -0
  3. package/dist/api/enums/common.js +21 -0
  4. package/dist/api/enums/common.js.map +1 -1
  5. package/dist/api/enums/currency.enum.d.ts +123 -118
  6. package/dist/api/enums/currency.enum.js +6 -1
  7. package/dist/api/enums/currency.enum.js.map +1 -1
  8. package/dist/api/notifications.d.ts +12 -0
  9. package/dist/api/requests/deal.d.ts +68 -0
  10. package/dist/api/requests/invoice.d.ts +102 -0
  11. package/dist/api/requests/me.d.ts +14 -0
  12. package/dist/api/requests/payment-method.d.ts +27 -0
  13. package/dist/api/requests/payment.d.ts +584 -0
  14. package/dist/api/requests/payout.d.ts +189 -0
  15. package/dist/api/requests/personal-data.d.ts +48 -0
  16. package/dist/api/requests/receipt.d.ts +266 -0
  17. package/dist/api/requests/refund.d.ts +110 -0
  18. package/dist/api/requests/webhook.d.ts +13 -0
  19. package/dist/api/responses/deal.d.ts +74 -0
  20. package/dist/api/responses/invoice.d.ts +125 -0
  21. package/dist/api/responses/me.d.ts +81 -0
  22. package/dist/api/responses/payment-method.d.ts +60 -0
  23. package/dist/api/responses/payment.d.ts +934 -0
  24. package/dist/api/responses/payout.d.ts +185 -0
  25. package/dist/api/responses/personal-data.d.ts +65 -0
  26. package/dist/api/responses/receipt.d.ts +245 -0
  27. package/dist/api/responses/refund.d.ts +148 -0
  28. package/dist/api/responses/sbp-banks.d.ts +25 -0
  29. package/dist/api/responses/webhook.d.ts +28 -0
  30. package/dist/index.d.ts +1 -4
  31. package/dist/index.js +4 -4
  32. package/dist/index.js.map +1 -1
  33. package/dist/modules/deal/deal.service.d.ts +16 -0
  34. package/dist/modules/deal/deal.service.js +16 -0
  35. package/dist/modules/deal/deal.service.js.map +1 -1
  36. package/dist/modules/invoice/invoice.service.d.ts +12 -0
  37. package/dist/modules/invoice/invoice.service.js +12 -0
  38. package/dist/modules/invoice/invoice.service.js.map +1 -1
  39. package/dist/modules/me/me.service.d.ts +7 -0
  40. package/dist/modules/me/me.service.js +7 -0
  41. package/dist/modules/me/me.service.js.map +1 -1
  42. package/dist/modules/payment/payment.service.d.ts +35 -0
  43. package/dist/modules/payment/payment.service.js +35 -0
  44. package/dist/modules/payment/payment.service.js.map +1 -1
  45. package/dist/modules/payment-method/payment-method.service.d.ts +12 -0
  46. package/dist/modules/payment-method/payment-method.service.js +12 -0
  47. package/dist/modules/payment-method/payment-method.service.js.map +1 -1
  48. package/dist/modules/payout/payout.service.d.ts +26 -0
  49. package/dist/modules/payout/payout.service.js +26 -0
  50. package/dist/modules/payout/payout.service.js.map +1 -1
  51. package/dist/modules/personal-data/personal-data.service.d.ts +13 -0
  52. package/dist/modules/personal-data/personal-data.service.js +13 -0
  53. package/dist/modules/personal-data/personal-data.service.js.map +1 -1
  54. package/dist/modules/receipt/receipt.service.d.ts +19 -0
  55. package/dist/modules/receipt/receipt.service.js +19 -0
  56. package/dist/modules/receipt/receipt.service.js.map +1 -1
  57. package/dist/modules/refund/refund.service.d.ts +20 -0
  58. package/dist/modules/refund/refund.service.js +20 -0
  59. package/dist/modules/refund/refund.service.js.map +1 -1
  60. package/dist/modules/sbp-banks/sbp-banks.service.d.ts +7 -0
  61. package/dist/modules/sbp-banks/sbp-banks.service.js +7 -0
  62. package/dist/modules/sbp-banks/sbp-banks.service.js.map +1 -1
  63. package/dist/modules/webhook/constants/yookassa-ip-whitelist.d.ts +4 -0
  64. package/dist/modules/webhook/constants/yookassa-ip-whitelist.js +4 -0
  65. package/dist/modules/webhook/constants/yookassa-ip-whitelist.js.map +1 -1
  66. package/dist/modules/webhook/decorators/yookassa-webhook.decorator.d.ts +13 -0
  67. package/dist/modules/webhook/decorators/yookassa-webhook.decorator.js +13 -0
  68. package/dist/modules/webhook/decorators/yookassa-webhook.decorator.js.map +1 -1
  69. package/dist/modules/webhook/utils/ip-matcher.util.d.ts +9 -0
  70. package/dist/modules/webhook/utils/ip-matcher.util.js +9 -0
  71. package/dist/modules/webhook/utils/ip-matcher.util.js.map +1 -1
  72. package/dist/modules/webhook/webhook.service.d.ts +18 -0
  73. package/dist/modules/webhook/webhook.service.js +18 -0
  74. package/dist/modules/webhook/webhook.service.js.map +1 -1
  75. package/dist/yookassa.interface.d.ts +26 -0
  76. package/dist/yookassa.module.d.ts +32 -0
  77. package/dist/yookassa.module.js +32 -0
  78. package/dist/yookassa.module.js.map +1 -1
  79. package/package.json +1 -1
@@ -110,12 +110,33 @@ export declare enum VatRateEnum {
110
110
  Value20 = "20",
111
111
  Value22 = "22"
112
112
  }
113
+ /**
114
+ * Типы событий, о которых YooKassa отправляет уведомления.
115
+ */
113
116
  export declare enum NotificationEventEnum {
117
+ /**
118
+ * Платеж ожидает подтверждения.
119
+ */
114
120
  PAYMENT_WAITING_FOR_CAPTURE = "payment.waiting_for_capture",
121
+ /**
122
+ * Платеж успешно завершен.
123
+ */
115
124
  PAYMENT_SUCCEEDED = "payment.succeeded",
125
+ /**
126
+ * Платеж отменен.
127
+ */
116
128
  PAYMENT_CANCELED = "payment.canceled",
129
+ /**
130
+ * Возврат успешно завершен.
131
+ */
117
132
  REFUND_SUCCEEDED = "refund.succeeded"
118
133
  }
134
+ /**
135
+ * Тип уведомления.
136
+ */
119
137
  export declare enum NotificationTypeEnum {
138
+ /**
139
+ * Уведомление о событии.
140
+ */
120
141
  NOTIFICATION = "notification"
121
142
  }
@@ -131,15 +131,36 @@ var VatRateEnum;
131
131
  VatRateEnum["Value20"] = "20";
132
132
  VatRateEnum["Value22"] = "22";
133
133
  })(VatRateEnum || (exports.VatRateEnum = VatRateEnum = {}));
134
+ /**
135
+ * Типы событий, о которых YooKassa отправляет уведомления.
136
+ */
134
137
  var NotificationEventEnum;
135
138
  (function (NotificationEventEnum) {
139
+ /**
140
+ * Платеж ожидает подтверждения.
141
+ */
136
142
  NotificationEventEnum["PAYMENT_WAITING_FOR_CAPTURE"] = "payment.waiting_for_capture";
143
+ /**
144
+ * Платеж успешно завершен.
145
+ */
137
146
  NotificationEventEnum["PAYMENT_SUCCEEDED"] = "payment.succeeded";
147
+ /**
148
+ * Платеж отменен.
149
+ */
138
150
  NotificationEventEnum["PAYMENT_CANCELED"] = "payment.canceled";
151
+ /**
152
+ * Возврат успешно завершен.
153
+ */
139
154
  NotificationEventEnum["REFUND_SUCCEEDED"] = "refund.succeeded";
140
155
  })(NotificationEventEnum || (exports.NotificationEventEnum = NotificationEventEnum = {}));
156
+ /**
157
+ * Тип уведомления.
158
+ */
141
159
  var NotificationTypeEnum;
142
160
  (function (NotificationTypeEnum) {
161
+ /**
162
+ * Уведомление о событии.
163
+ */
143
164
  NotificationTypeEnum["NOTIFICATION"] = "notification";
144
165
  })(NotificationTypeEnum || (exports.NotificationTypeEnum = NotificationTypeEnum = {}));
145
166
  //# sourceMappingURL=common.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/api/enums/common.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,wCAAkB,CAAA;IAClB,4CAAsB,CAAA;IACtB,8CAAwB,CAAA;AAC1B,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,IAAY,gBAgBX;AAhBD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,iCAAa,CAAA;IACb,+BAAW,CAAA;IACX,yCAAqB,CAAA;IACrB,+BAAW,CAAA;IACX,uDAAmC,CAAA;IACnC,6CAAyB,CAAA;IACzB,iDAA6B,CAAA;IAC7B,iDAA6B,CAAA;IAC7B,qDAAiC,CAAA;IACjC,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,iCAAa,CAAA;IACb,qCAAiB,CAAA;IACjB,uCAAmB,CAAA;AACrB,CAAC,EAhBW,gBAAgB,gCAAhB,gBAAgB,QAgB3B;AAED,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACtC,qDAAqB,CAAA;IACrB,sDAAsB,CAAA;AACxB,CAAC,EAHW,4BAA4B,4CAA5B,4BAA4B,QAGvC;AAED,IAAY,6BAMX;AAND,WAAY,6BAA6B;IACvC,qEAAoC,CAAA;IACpC,mEAAkC,CAAA;IAClC,mEAAkC,CAAA;IAClC,qEAAoC,CAAA;IACpC,uFAAsD,CAAA;AACxD,CAAC,EANW,6BAA6B,6CAA7B,6BAA6B,QAMxC;AAED,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;IACnB,0CAAiB,CAAA;AACnB,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,2DAAsC,CAAA;IACtC,+CAA0B,CAAA;AAC5B,CAAC,EAHW,iBAAiB,iCAAjB,iBAAiB,QAG5B;AAED,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED,IAAY,yBAgBX;AAhBD,WAAY,yBAAyB;IACnC,kDAAqB,CAAA;IACrB,uDAA0B,CAAA;IAC1B,2CAAc,CAAA;IACd,0CAAa,CAAA;IACb,uDAA0B,CAAA;IAC1B,2DAA8B,CAAA;IAC9B,8CAAiB,CAAA;IACjB,mDAAsB,CAAA;IACtB,qDAAwB,CAAA;IACxB,8CAAiB,CAAA;IACjB,iDAAoB,CAAA;IACpB,kDAAqB,CAAA;IACrB,uDAA0B,CAAA;IAC1B,8CAAiB,CAAA;IACjB,iDAAoB,CAAA;AACtB,CAAC,EAhBW,yBAAyB,yCAAzB,yBAAyB,QAgBpC;AAED,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,4BAAc,CAAA;IACd,4BAAc,CAAA;AAChB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAED,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;AACvB,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAED,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,qEAAyC,CAAA;IACzC,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACvB,CAAC,EAJW,wBAAwB,wCAAxB,wBAAwB,QAInC;AAED,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,4CAAiB,CAAA;IACjB,gDAAqB,CAAA;AACvB,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAED,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;AACvB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAED,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,8DAAyC,CAAA;IACzC,4CAAuB,CAAA;IACvB,0CAAqB,CAAA;AACvB,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,0CAAsB,CAAA;IACtB,0CAAsB,CAAA;IACtB,+BAAW,CAAA;AACb,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAED,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,uEAA6C,CAAA;IAC7C,2CAAiB,CAAA;IACjB,+CAAqB,CAAA;AACvB,CAAC,EAJW,sBAAsB,sCAAtB,sBAAsB,QAIjC;AAED,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,mEAA2C,CAAA;IAC3C,+EAAuD,CAAA;AACzD,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B;AAED,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,2BAAY,CAAA;IACZ,2BAAY,CAAA;IACZ,6BAAc,CAAA;IACd,6BAAc,CAAA;IACd,6BAAc,CAAA;AAChB,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AAKD,IAAY,qBAoBX;AApBD,WAAY,qBAAqB;IAI/B,oFAA2D,CAAA;IAK3D,gEAAuC,CAAA;IAKvC,8DAAqC,CAAA;IAKrC,8DAAqC,CAAA;AACvC,CAAC,EApBW,qBAAqB,qCAArB,qBAAqB,QAoBhC;AAKD,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAI9B,qDAA6B,CAAA;AAC/B,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B"}
1
+ {"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/api/enums/common.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,wCAAkB,CAAA;IAClB,4CAAsB,CAAA;IACtB,8CAAwB,CAAA;AAC1B,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,IAAY,gBAgBX;AAhBD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,iCAAa,CAAA;IACb,+BAAW,CAAA;IACX,yCAAqB,CAAA;IACrB,+BAAW,CAAA;IACX,uDAAmC,CAAA;IACnC,6CAAyB,CAAA;IACzB,iDAA6B,CAAA;IAC7B,iDAA6B,CAAA;IAC7B,qDAAiC,CAAA;IACjC,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,iCAAa,CAAA;IACb,qCAAiB,CAAA;IACjB,uCAAmB,CAAA;AACrB,CAAC,EAhBW,gBAAgB,gCAAhB,gBAAgB,QAgB3B;AAED,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACtC,qDAAqB,CAAA;IACrB,sDAAsB,CAAA;AACxB,CAAC,EAHW,4BAA4B,4CAA5B,4BAA4B,QAGvC;AAED,IAAY,6BAMX;AAND,WAAY,6BAA6B;IACvC,qEAAoC,CAAA;IACpC,mEAAkC,CAAA;IAClC,mEAAkC,CAAA;IAClC,qEAAoC,CAAA;IACpC,uFAAsD,CAAA;AACxD,CAAC,EANW,6BAA6B,6CAA7B,6BAA6B,QAMxC;AAED,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;IACnB,0CAAiB,CAAA;AACnB,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,2DAAsC,CAAA;IACtC,+CAA0B,CAAA;AAC5B,CAAC,EAHW,iBAAiB,iCAAjB,iBAAiB,QAG5B;AAED,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED,IAAY,yBAgBX;AAhBD,WAAY,yBAAyB;IACnC,kDAAqB,CAAA;IACrB,uDAA0B,CAAA;IAC1B,2CAAc,CAAA;IACd,0CAAa,CAAA;IACb,uDAA0B,CAAA;IAC1B,2DAA8B,CAAA;IAC9B,8CAAiB,CAAA;IACjB,mDAAsB,CAAA;IACtB,qDAAwB,CAAA;IACxB,8CAAiB,CAAA;IACjB,iDAAoB,CAAA;IACpB,kDAAqB,CAAA;IACrB,uDAA0B,CAAA;IAC1B,8CAAiB,CAAA;IACjB,iDAAoB,CAAA;AACtB,CAAC,EAhBW,yBAAyB,yCAAzB,yBAAyB,QAgBpC;AAED,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,4BAAc,CAAA;IACd,4BAAc,CAAA;AAChB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAED,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;AACvB,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAED,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,qEAAyC,CAAA;IACzC,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACvB,CAAC,EAJW,wBAAwB,wCAAxB,wBAAwB,QAInC;AAED,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,4CAAiB,CAAA;IACjB,gDAAqB,CAAA;AACvB,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAED,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;AACvB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAED,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,8DAAyC,CAAA;IACzC,4CAAuB,CAAA;IACvB,0CAAqB,CAAA;AACvB,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,0CAAsB,CAAA;IACtB,0CAAsB,CAAA;IACtB,+BAAW,CAAA;AACb,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAED,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,uEAA6C,CAAA;IAC7C,2CAAiB,CAAA;IACjB,+CAAqB,CAAA;AACvB,CAAC,EAJW,sBAAsB,sCAAtB,sBAAsB,QAIjC;AAED,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,mEAA2C,CAAA;IAC3C,+EAAuD,CAAA;AACzD,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B;AAED,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,2BAAY,CAAA;IACZ,2BAAY,CAAA;IACZ,6BAAc,CAAA;IACd,6BAAc,CAAA;IACd,6BAAc,CAAA;AAChB,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AAED;;GAEG;AACH,IAAY,qBAoBX;AApBD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,oFAA2D,CAAA;IAE3D;;OAEG;IACH,gEAAuC,CAAA;IAEvC;;OAEG;IACH,8DAAqC,CAAA;IAErC;;OAEG;IACH,8DAAqC,CAAA;AACvC,CAAC,EApBW,qBAAqB,qCAArB,qBAAqB,QAoBhC;AAED;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,qDAA6B,CAAA;AAC/B,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B"}
@@ -1,121 +1,126 @@
1
+ /**
2
+ * Перечисление поддерживаемых валют.
3
+ * Каждая валюта представлена в виде трехбуквенного кода.
4
+ * @enum {string}
5
+ */
1
6
  export declare enum CurrencyEnum {
2
- USD = "USD",
3
- CAD = "CAD",
4
- EUR = "EUR",
5
- AED = "AED",
6
- AFN = "AFN",
7
- ALL = "ALL",
8
- AMD = "AMD",
9
- ARS = "ARS",
10
- AUD = "AUD",
11
- AZN = "AZN",
12
- BAM = "BAM",
13
- BDT = "BDT",
14
- BGN = "BGN",
15
- BHD = "BHD",
16
- BIF = "BIF",
17
- BND = "BND",
18
- BOB = "BOB",
19
- BRL = "BRL",
20
- BWP = "BWP",
21
- BYN = "BYN",
22
- BZD = "BZD",
23
- CDF = "CDF",
24
- CHF = "CHF",
25
- CLP = "CLP",
26
- CNY = "CNY",
27
- COP = "COP",
28
- CRC = "CRC",
29
- CVE = "CVE",
30
- CZK = "CZK",
31
- DJF = "DJF",
32
- DKK = "DKK",
33
- DOP = "DOP",
34
- DZD = "DZD",
35
- EEK = "EEK",
36
- EGP = "EGP",
37
- ERN = "ERN",
38
- ETB = "ETB",
39
- GBP = "GBP",
40
- GEL = "GEL",
41
- GHS = "GHS",
42
- GNF = "GNF",
43
- GTQ = "GTQ",
44
- HKD = "HKD",
45
- HNL = "HNL",
46
- HRK = "HRK",
47
- HUF = "HUF",
48
- IDR = "IDR",
49
- ILS = "ILS",
50
- INR = "INR",
51
- IQD = "IQD",
52
- IRR = "IRR",
53
- ISK = "ISK",
54
- JMD = "JMD",
55
- JOD = "JOD",
56
- JPY = "JPY",
57
- KES = "KES",
58
- KHR = "KHR",
59
- KMF = "KMF",
60
- KRW = "KRW",
61
- KWD = "KWD",
62
- KZT = "KZT",
63
- LBP = "LBP",
64
- LKR = "LKR",
65
- LTL = "LTL",
66
- LVL = "LVL",
67
- LYD = "LYD",
68
- MAD = "MAD",
69
- MDL = "MDL",
70
- MGA = "MGA",
71
- MKD = "MKD",
72
- MMK = "MMK",
73
- MOP = "MOP",
74
- MUR = "MUR",
75
- MXN = "MXN",
76
- MYR = "MYR",
77
- MZN = "MZN",
78
- NAD = "NAD",
79
- NGN = "NGN",
80
- NIO = "NIO",
81
- NOK = "NOK",
82
- NPR = "NPR",
83
- NZD = "NZD",
84
- OMR = "OMR",
85
- PAB = "PAB",
86
- PEN = "PEN",
87
- PHP = "PHP",
88
- PKR = "PKR",
89
- PLN = "PLN",
90
- PYG = "PYG",
91
- QAR = "QAR",
92
- RON = "RON",
93
- RSD = "RSD",
94
- RUB = "RUB",
95
- RWF = "RWF",
96
- SAR = "SAR",
97
- SDG = "SDG",
98
- SEK = "SEK",
99
- SGD = "SGD",
100
- SOS = "SOS",
101
- SYP = "SYP",
102
- THB = "THB",
103
- TND = "TND",
104
- TOP = "TOP",
105
- TRY = "TRY",
106
- TTD = "TTD",
107
- TWD = "TWD",
108
- TZS = "TZS",
109
- UAH = "UAH",
110
- UGX = "UGX",
111
- UYU = "UYU",
112
- UZS = "UZS",
113
- VEF = "VEF",
114
- VND = "VND",
115
- XAF = "XAF",
116
- XOF = "XOF",
117
- YER = "YER",
118
- ZAR = "ZAR",
119
- ZMK = "ZMK",
7
+ USD = "USD",// Доллар США
8
+ CAD = "CAD",// Канадский доллар
9
+ EUR = "EUR",// Евро
10
+ AED = "AED",// Дирхам ОАЭ
11
+ AFN = "AFN",// Афгани
12
+ ALL = "ALL",// Албанский лек
13
+ AMD = "AMD",// Армянский драм
14
+ ARS = "ARS",// Аргентинский песо
15
+ AUD = "AUD",// Австралийский доллар
16
+ AZN = "AZN",// Азербайджанский манат
17
+ BAM = "BAM",// Конвертируемая марка (Босния и Герцеговина)
18
+ BDT = "BDT",// Бангладешская така
19
+ BGN = "BGN",// Болгарский лев
20
+ BHD = "BHD",// Бахрейнский динар
21
+ BIF = "BIF",// Бурундийский франк
22
+ BND = "BND",// Брунейский доллар
23
+ BOB = "BOB",// Боливийский боливиано
24
+ BRL = "BRL",// Бразильский реал
25
+ BWP = "BWP",// Ботсванская пула
26
+ BYN = "BYN",// Белорусский рубль
27
+ BZD = "BZD",// Белизский доллар
28
+ CDF = "CDF",// Конголезский франк
29
+ CHF = "CHF",// Швейцарский франк
30
+ CLP = "CLP",// Чилийский песо
31
+ CNY = "CNY",// Китайский юань
32
+ COP = "COP",// Колумбийский песо
33
+ CRC = "CRC",// Коста-риканский колон
34
+ CVE = "CVE",// Эскудо Кабо-Верде
35
+ CZK = "CZK",// Чешская крона
36
+ DJF = "DJF",// Франк Джибути
37
+ DKK = "DKK",// Датская крона
38
+ DOP = "DOP",// Доминиканский песо
39
+ DZD = "DZD",// Алжирский динар
40
+ EEK = "EEK",// Эстонская крона
41
+ EGP = "EGP",// Египетский фунт
42
+ ERN = "ERN",// Эритрейская накфа
43
+ ETB = "ETB",// Эфиопский бирр
44
+ GBP = "GBP",// Фунт стерлингов
45
+ GEL = "GEL",// Грузинский лари
46
+ GHS = "GHS",// Ганский седи
47
+ GNF = "GNF",// Гвинейский франк
48
+ GTQ = "GTQ",// Гватемальский кетсаль
49
+ HKD = "HKD",// Гонконгский доллар
50
+ HNL = "HNL",// Гондурасская лемпира
51
+ HRK = "HRK",// Хорватская куна
52
+ HUF = "HUF",// Венгерский форинт
53
+ IDR = "IDR",// Индонезийская рупия
54
+ ILS = "ILS",// Израильский шекель
55
+ INR = "INR",// Индийская рупия
56
+ IQD = "IQD",// Иракский динар
57
+ IRR = "IRR",// Иранский риал
58
+ ISK = "ISK",// Исландская крона
59
+ JMD = "JMD",// Ямайский доллар
60
+ JOD = "JOD",// Иорданский динар
61
+ JPY = "JPY",// Японская иена
62
+ KES = "KES",// Кенийский шиллинг
63
+ KHR = "KHR",// Камбоджийский риель
64
+ KMF = "KMF",// Франк Коморских островов
65
+ KRW = "KRW",// Южнокорейская вона
66
+ KWD = "KWD",// Кувейтский динар
67
+ KZT = "KZT",// Казахстанский тенге
68
+ LBP = "LBP",// Ливанский фунт
69
+ LKR = "LKR",// Шри-ланкийская рупия
70
+ LTL = "LTL",// Литовский лит
71
+ LVL = "LVL",// Латвийский лат
72
+ LYD = "LYD",// Ливийский динар
73
+ MAD = "MAD",// Марокканский дирхам
74
+ MDL = "MDL",// Молдавский лей
75
+ MGA = "MGA",// Мадагаскарский ариари
76
+ MKD = "MKD",// Македонский денар
77
+ MMK = "MMK",// Мьянмский кьят
78
+ MOP = "MOP",// Патака Макао
79
+ MUR = "MUR",// Маврикийская рупия
80
+ MXN = "MXN",// Мексиканское песо
81
+ MYR = "MYR",// Малайзийский ринггит
82
+ MZN = "MZN",// Мозамбикское метикал
83
+ NAD = "NAD",// Намибийский доллар
84
+ NGN = "NGN",// Нигерийская найра
85
+ NIO = "NIO",// Никарагуанская кордоба
86
+ NOK = "NOK",// Норвежская крона
87
+ NPR = "NPR",// Непальская рупия
88
+ NZD = "NZD",// Новозеландский доллар
89
+ OMR = "OMR",// Оманский риал
90
+ PAB = "PAB",// Панамский балбоа
91
+ PEN = "PEN",// Перуанский соль
92
+ PHP = "PHP",// Филиппинское песо
93
+ PKR = "PKR",// Пакистанская рупия
94
+ PLN = "PLN",// Польский злотый
95
+ PYG = "PYG",// Парагвайский гуарани
96
+ QAR = "QAR",// Катарский риал
97
+ RON = "RON",// Румынский лей
98
+ RSD = "RSD",// Сербский динар
99
+ RUB = "RUB",// Российский рубль
100
+ RWF = "RWF",// Руандийский франк
101
+ SAR = "SAR",// Саудовский риал
102
+ SDG = "SDG",// Суданский фунт
103
+ SEK = "SEK",// Шведская крона
104
+ SGD = "SGD",// Сингапурский доллар
105
+ SOS = "SOS",// Сомалийский шиллинг
106
+ SYP = "SYP",// Сирийский фунт
107
+ THB = "THB",// Таиландский бат
108
+ TND = "TND",// Тунисский динар
109
+ TOP = "TOP",// Тонгана паанга
110
+ TRY = "TRY",// Турецкая лира
111
+ TTD = "TTD",// Тринидад и Тобаго доллар
112
+ TWD = "TWD",// Новый тайваньский доллар
113
+ TZS = "TZS",// Танзанийский шиллинг
114
+ UAH = "UAH",// Украинская гривна
115
+ UGX = "UGX",// Угандийский шиллинг
116
+ UYU = "UYU",// Уругвайское песо
117
+ UZS = "UZS",// Узбекский сум
118
+ VEF = "VEF",// Венесуэльский боливар
119
+ VND = "VND",// Вьетнамский донг
120
+ XAF = "XAF",// Франк Центральноафриканского CFA
121
+ XOF = "XOF",// Франк Западноафриканского CFA
122
+ YER = "YER",// Йеменский риал
123
+ ZAR = "ZAR",// Южноафриканский рэнд
124
+ ZMK = "ZMK",// Замбийская квача
120
125
  ZWL = "ZWL"
121
126
  }
@@ -1,6 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.CurrencyEnum = void 0;
4
+ /**
5
+ * Перечисление поддерживаемых валют.
6
+ * Каждая валюта представлена в виде трехбуквенного кода.
7
+ * @enum {string}
8
+ */
4
9
  var CurrencyEnum;
5
10
  (function (CurrencyEnum) {
6
11
  CurrencyEnum["USD"] = "USD";
@@ -121,6 +126,6 @@ var CurrencyEnum;
121
126
  CurrencyEnum["YER"] = "YER";
122
127
  CurrencyEnum["ZAR"] = "ZAR";
123
128
  CurrencyEnum["ZMK"] = "ZMK";
124
- CurrencyEnum["ZWL"] = "ZWL";
129
+ CurrencyEnum["ZWL"] = "ZWL"; // Зимбабвийский доллар
125
130
  })(CurrencyEnum || (exports.CurrencyEnum = CurrencyEnum = {}));
126
131
  //# sourceMappingURL=currency.enum.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"currency.enum.js","sourceRoot":"","sources":["../../../src/api/enums/currency.enum.ts"],"names":[],"mappings":";;;AAKA,IAAY,YAwHX;AAxHD,WAAY,YAAY;IACvB,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;AACZ,CAAC,EAxHW,YAAY,4BAAZ,YAAY,QAwHvB"}
1
+ {"version":3,"file":"currency.enum.js","sourceRoot":"","sources":["../../../src/api/enums/currency.enum.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,YAwHX;AAxHD,WAAY,YAAY;IACvB,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,2BAAW,CAAA,CAAC,uBAAuB;AACpC,CAAC,EAxHW,YAAY,4BAAZ,YAAY,QAwHvB"}
@@ -1,8 +1,20 @@
1
1
  import { NotificationEventEnum, NotificationTypeEnum } from './enums';
2
2
  import { Payment } from './responses';
3
+ /**
4
+ * Базовый интерфейс уведомления вебхука Юкассы.
5
+ */
3
6
  export interface BaseWebhookNotification<E extends NotificationEventEnum, T> {
7
+ /**
8
+ * Тип уведомления.
9
+ */
4
10
  type: NotificationTypeEnum;
11
+ /**
12
+ * Тип события.
13
+ */
5
14
  event: E;
15
+ /**
16
+ * Объект события (платеж, возврат и т.д.).
17
+ */
6
18
  object: T;
7
19
  }
8
20
  export interface PaymentWebHook extends BaseWebhookNotification<NotificationEventEnum.PAYMENT_WAITING_FOR_CAPTURE | NotificationEventEnum.PAYMENT_SUCCEEDED | NotificationEventEnum.PAYMENT_CANCELED | NotificationEventEnum.REFUND_SUCCEEDED, Payment> {
@@ -1,21 +1,89 @@
1
1
  import { DealFeeMomentEnum } from '../enums';
2
+ /**
3
+ * Создание сделки
4
+ *
5
+ * Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу.
6
+ */
2
7
  export interface CreateDealRequest {
8
+ /**
9
+ * Тип сделки. Фиксированное значение: safe_deal — Безопасная сделка.
10
+ */
3
11
  "type": string;
12
+ /**
13
+ * Момент перечисления вам вознаграждения платформы. Возможные значения:
14
+ *
15
+ * payment_succeeded — после успешной оплаты;
16
+ *
17
+ * deal_closed — при закрытии сделки после успешной выплаты.
18
+ */
4
19
  fee_moment: DealFeeMomentEnum;
20
+ /**
21
+ * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
22
+ */
5
23
  metadata?: Record<string, unknown>;
24
+ /**
25
+ * Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок.
26
+ */
6
27
  description?: string;
7
28
  }
29
+ /**
30
+ * Список сделок
31
+ *
32
+ * Запрос позволяет получить список сделок, отфильтрованный по заданным критериям. Подробнее о работе со списками
33
+ */
8
34
  export interface GetDealsListRequest {
35
+ /**
36
+ * Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z
37
+ */
9
38
  "created_at.gte"?: string;
39
+ /**
40
+ * Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z
41
+ */
10
42
  "created_at.gt"?: string;
43
+ /**
44
+ * Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z
45
+ */
11
46
  "created_at.lte"?: string;
47
+ /**
48
+ * Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z
49
+ */
12
50
  "created_at.lt"?: string;
51
+ /**
52
+ * Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601. Пример: expires_at.gte=2018-07-18T10:51:18.139Z
53
+ */
13
54
  "expires_at.gte"?: string;
55
+ /**
56
+ * Фильтр по времени автоматического закрытия сделки: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601. Пример: expires_at.gt=2018-07-18T10:51:18.139Z
57
+ */
14
58
  "expires_at.gt"?: string;
59
+ /**
60
+ * Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601. Пример: expires_at.lte=2018-07-18T10:51:18.139Z
61
+ */
15
62
  "expires_at.lte"?: string;
63
+ /**
64
+ * Фильтр по времени автоматического закрытия сделки: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601. Пример: expires_at.lt=2018-07-18T10:51:18.139Z
65
+ */
16
66
  "expires_at.lt"?: string;
67
+ /**
68
+ * Фильтр по статусу сделки. Пример: status=closed
69
+ */
17
70
  status?: string;
71
+ /**
72
+ * Фильтр по описанию сделки — параметру description (например, идентификатор сделки на стороне вашей интернет-площадки в ЮKassa, идентификатор покупателя или продавца). От 4 до 128 символов.
73
+ *
74
+ * Пример: 123554642-2432FF344R
75
+ */
18
76
  full_text_search?: string;
77
+ /**
78
+ * Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50
79
+ *
80
+ * Значение по умолчанию: 10
81
+ */
19
82
  limit?: number;
83
+ /**
84
+ * Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15
85
+ *
86
+ * В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования
87
+ */
20
88
  cursor?: string;
21
89
  }
@@ -1,33 +1,135 @@
1
1
  import type { CommonAmount, CommonCart, CommonReceipt, CommonRecipient } from '../common';
2
2
  import { LocaleEnum } from '../enums';
3
+ /**
4
+ * Создание счета
5
+ *
6
+ * Используйте этот запрос, чтобы создать в ЮKassa объект счета. В запросе необходимо передать данные о заказе, которые отобразятся на странице счета, и данные для проведения платежа.
7
+ */
3
8
  export interface CreateInvoiceRequest {
9
+ /**
10
+ * Данные для проведения платежа по выставленному счету.
11
+ */
4
12
  payment_data: CreateInvoiceRequestPaymentData;
13
+ /**
14
+ * Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.
15
+ */
5
16
  cart: CommonCart[];
17
+ /**
18
+ * Данные о способе доставки счета пользователю. Подробнее о способах доставки счетов
19
+ */
6
20
  delivery_method_data?: CreateInvoiceRequestDeliveryMethodData;
21
+ /**
22
+ * Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z
23
+ */
7
24
  expires_at: string;
25
+ /**
26
+ * Язык интерфейса, писем и смс, которые будет видеть или получать пользователь. Формат соответствует ISO/IEC 15897. Возможные значения: ru_RU, en_US. Регистр важен.
27
+ */
8
28
  locale?: LocaleEnum;
29
+ /**
30
+ * Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».
31
+ */
9
32
  description?: string;
33
+ /**
34
+ * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
35
+ */
10
36
  metadata?: Record<string, unknown>;
11
37
  }
38
+ /**
39
+ * Данные для проведения платежа по выставленному счету.
40
+ */
12
41
  export interface CreateInvoiceRequestPaymentData {
42
+ /**
43
+ * Сумма платежа. Должна укладываться в лимиты.
44
+ *
45
+ * Сумма указывается с кодом валюты. Если вы разделяете потоки платежей, валюта платежа должна соответствовать валюте субаккаунта (recipient.gateway_id), если не разделяете — валюте аккаунта shopId в личном кабинете).
46
+ */
13
47
  amount: CommonAmount;
48
+ /**
49
+ * Данные для формирования чека.
50
+ *
51
+ * Необходимо передавать в этих случаях:
52
+ *
53
+ * вы компания или ИП и для оплаты с соблюдением требований 54-ФЗ используете Чеки от ЮKassa;
54
+ *
55
+ * вы компания или ИП, для оплаты с соблюдением требований 54-ФЗ используете стороннюю онлайн-кассу и отправляете данные для чеков по одному из сценариев: Платеж и чек одновременно или Сначала чек, потом платеж.
56
+ */
14
57
  receipt?: CommonReceipt;
58
+ /**
59
+ * Получатель платежа. Нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес другого аккаунта.
60
+ */
15
61
  recipient?: CommonRecipient;
62
+ /**
63
+ * Сохранение платежных данных для проведения автоплатежей. Возможные значения:
64
+ *
65
+ * true — сохранить способ оплаты (сохранить платежные данные);
66
+ *
67
+ * false — провести платеж без сохранения способа оплаты.
68
+ *
69
+ * Доступно только после согласования с менеджером ЮKassa.
70
+ */
16
71
  save_payment_method?: boolean;
72
+ /**
73
+ * Автоматический прием поступившего платежа. Возможные значения:
74
+ *
75
+ * true — оплата списывается сразу (платеж в одну стадию);
76
+ *
77
+ * false — оплата холдируется и списывается по вашему запросу (платеж в две стадии).
78
+ *
79
+ * По умолчанию false.
80
+ */
17
81
  capture?: boolean;
82
+ /**
83
+ * IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения.
84
+ */
18
85
  client_ip?: string;
86
+ /**
87
+ * Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru».
88
+ */
19
89
  description?: string;
90
+ /**
91
+ * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
92
+ */
20
93
  metadata?: Record<string, unknown>;
21
94
  }
95
+ /**
96
+ * Данные для выставления счета с самостоятельной доставкой ссылки на счет.
97
+ */
22
98
  export interface CreateInvoiceRequestDeliveryMethodDataSelf {
99
+ /**
100
+ * Код способа доставки счета пользователю.
101
+ */
23
102
  "type": "self";
24
103
  }
104
+ /**
105
+ * Данные для выставления счета с доставкой ссылки на счет в смс.
106
+ */
25
107
  export interface CreateInvoiceRequestDeliveryMethodDataSms {
108
+ /**
109
+ * Код способа доставки счета пользователю.
110
+ */
26
111
  "type": "sms";
112
+ /**
113
+ * Номер телефона, на который ЮKassa отправит смс со ссылкой на счет. Указывается в формате ITU-T E.164, например 79000000000.
114
+ */
27
115
  phone: string;
28
116
  }
117
+ /**
118
+ * Данные для выставления счета с отправкой по электронной почте.
119
+ */
29
120
  export interface CreateInvoiceRequestDeliveryMethodDataEmail {
121
+ /**
122
+ * Код способа доставки счета пользователю.
123
+ */
30
124
  "type": "email";
125
+ /**
126
+ * Адрес электронной почты, на который ЮKassa отправит письмо со ссылкой на счет.
127
+ */
31
128
  email: string;
32
129
  }
130
+ /**
131
+ * Данные о способе доставки счета пользователю. Подробнее о способах доставки счетов
132
+ *
133
+ * Способ доставки счета
134
+ */
33
135
  export type CreateInvoiceRequestDeliveryMethodData = CreateInvoiceRequestDeliveryMethodDataSelf | CreateInvoiceRequestDeliveryMethodDataSms | CreateInvoiceRequestDeliveryMethodDataEmail;
@@ -1,3 +1,17 @@
1
+ /**
2
+ * Информация о настройках магазина или шлюза
3
+ *
4
+ * С помощью этого запроса вы можете получить информацию о магазине или шлюзе:
5
+ *
6
+ * Для Сплитования платежей: в запросе необходимо передать параметр on_behalf_of с идентификатором магазина продавца и ваши данные для аутентификации (идентификатор и секретный ключ вашей платформы).
7
+ *
8
+ * Для партнеров: в запросе необходимо передать OAuth-токен магазина.
9
+ *
10
+ * Для выплат: в запросе необходимо передать ваши данные для аутентификации (идентификатор и секретный ключ вашего шлюза).
11
+ */
1
12
  export interface GetMeRequest {
13
+ /**
14
+ * Только для тех, кто использует Сплитование платежей. Идентификатор магазина продавца, подключенного к вашей платформе, информацию о котором вы хотите узнать.
15
+ */
2
16
  on_behalf_of?: string;
3
17
  }