@rewloy/node 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +31 -0
- package/README.md +73 -1
- package/dist/client.d.ts +3 -1
- package/dist/client.js +16 -3
- package/dist/errors.d.ts +4 -0
- package/dist/errors.js +3 -0
- package/dist/generated/methods.d.ts +58 -34
- package/dist/generated/methods.js +61 -35
- package/dist/generated/operations.d.ts +1 -1
- package/dist/generated/operations.js +6 -2
- package/dist/generated/types.d.ts +179 -90
- package/dist/generated/types.js +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/types.d.ts +14 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { EventStream } from '../sse.js';
|
|
2
2
|
import type { Page, RequestOptions, StreamOptions } from '../types.js';
|
|
3
3
|
/** Every error code the API can answer with (the catalogue: https://rewloy.com/gelistiriciler/hatalar). New codes may be added without notice: keep a default branch. */
|
|
4
|
-
export type ErrorCode = 'VALIDATION' | 'BAD_REQUEST' | 'INVALID_JSON' | 'UNSUPPORTED_MEDIA_TYPE' | 'PAYLOAD_TOO_LARGE' | 'IDEMPOTENCY_KEY_REQUIRED' | 'IDEMPOTENCY_KEY_REUSED' | 'IDEMPOTENCY_IN_PROGRESS' | 'CONFIRM_REQUIRED' | 'REASON_REQUIRED' | 'NOT_FOUND' | 'RATE_LIMITED' | 'INTERNAL' | 'CROSS_SITE' | 'UNAUTHENTICATED' | 'INVALID_API_KEY' | 'KEY_MODE_MISMATCH' | 'TOKEN_INVALID' | 'FLOW_EXPIRED' | 'PASSKEY_REFUSED' | 'CODE_INVALID' | 'CODE_LOCKED' | 'PHONE_BUSY' | 'LAST_WAY_IN' | 'CHANGE_PENDING' | 'WAY_IN_TOO_NEW' | 'NOT_ENABLED' | 'PUSH_ENDPOINT_REFUSED' | 'PUSH_DEVICE_REFUSED' | 'PUSH_KEY_MISMATCH' | 'PUSH_NOT_SUBSCRIBED' | 'PROVIDER_REFUSED' | 'PROVIDER_UNAVAILABLE' | 'DEVICE_RENEWAL' | 'DEVICE_RENEWAL_REFUSED' | 'DEVICE_PROOF' | 'DEVICE_KEY_REFUSED' | 'MERGE_REQUIRED' | 'IDENT_SAME' | 'LOGIN_FAILED' | 'MFA_REQUIRED' | 'MFA_INVALID' | 'MFA_NOT_SET' | 'MFA_ALREADY_ENABLED' | 'MFA_REQUIRED_BY_TEAM' | 'MFA_OWNER_FIRST' | 'STEP_UP_FAILED' | 'CREDENTIAL_NOT_ALLOWED' | 'MERCHANT_REQUIRED' | 'SEAT_INACTIVE' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'OUT_OF_SCOPE' | 'PLAN_FEATURE_MISSING' | 'READ_ONLY' | 'VIEW_AS_READ_ONLY' | 'SEAT_LIMIT' | 'LIMIT' | 'PROGRAM_NOT_FOUND' | 'PASS_NOT_FOUND' | 'CUSTOMER_NOT_FOUND' | 'SEGMENT_NOT_FOUND' | 'CAMPAIGN_NOT_FOUND' | 'AUTOMATION_NOT_FOUND' | 'SEQUENCE_NOT_FOUND' | 'LOCATION_NOT_FOUND' | 'GROUP_NOT_FOUND' | 'MEMBER_NOT_FOUND' | 'SEAT_NOT_FOUND' | 'ERASURE_NOT_FOUND' | 'JOIN_CLOSED' | 'INVITE_NOT_FOUND' | 'GRANT_NOT_FOUND' | 'BATCH_NOT_FOUND' | 'KEY_NOT_FOUND' | 'WEBHOOK_NOT_FOUND' | 'SHOP_NOT_FOUND' | 'SHOP_PROGRAM_MISMATCH' | 'CONNECT_TOKEN_INVALID' | 'CONNECT_TOKEN_NOT_FOUND' | 'NO_PLUGIN_KEY' | 'CODE_EXPIRED' | 'CODE_USED' | 'INVITE_SIGN_IN' | 'INVITE_OTHER_ACCOUNT' | 'CODE_RELEASED' | 'CODE_NOT_ACCEPTED_HERE' | 'CURRENCY_MISMATCH' | 'SHOP_PAUSED' | 'VOUCHER_NOT_ONLINE' | 'NOT_ONLINE' | 'TOO_MANY_CODES' | 'CODE_ATTACHED' | 'CODE_NOT_FOUND' | 'CARD_IN_ORDER' | 'ORDER_CODES_LIMIT' | 'HOLD_UNBACKED' | 'REDEMPTION_NOT_FOUND' | 'REFUND_TOO_LARGE' | 'NOT_REFUNDABLE' | 'NOT_HELD' | 'TICKET_NOT_FOUND' | 'NOTIFICATION_NOT_FOUND' | 'EXPORT_NOT_FOUND' | 'SESSION_NOT_FOUND' | 'PASS_REFUSED' | 'PASS_INACTIVE' | 'PASS_EXPIRED' | 'PASS_USED_UP' | 'WRONG_CARD_TYPE' | 'INSUFFICIENT_BALANCE' | 'REWARD_NOT_READY' | 'OWNER_EMAIL_UNVERIFIED' | 'SALE_NOT_FOUND' | 'SALE_AMBIGUOUS' | 'SALE_ALREADY_SPENT' | 'WRONG_LOCATION' | 'INVALID_PROMOTION' | 'PROMOTION_NOT_FOUND' | 'VISIT_ALREADY_COUNTED' | 'ALREADY_ENDED' | 'PASS_STILL_ACTIVE' | 'CLAIM_CODE' | 'BAD_ACTION' | 'CONSENT_REQUIRED' | 'LEADERBOARD_OFF' | 'LEADERBOARD_ANONYMOUS' | 'WALLET_UNAVAILABLE' | 'INVALID_CONFIG' | 'BAD_IMAGE' | 'PROGRAM_HAS_CARDS' | 'ALREADY_ARCHIVED' | 'NOT_ARCHIVED' | 'NOT_AN_INSTRUMENT' | 'INVALID_BATCH' | 'BATCH_CLOSED' | 'BATCH_EXPIRED' | 'BATCH_FULL' | 'ALREADY_CLAIMED' | 'CURRENCY_LOCKED' | 'INVALID_CUSTOMER' | 'FIELD_REQUIRED' | 'INVALID_BIRTHDAY' | 'INVALID_PHONE' | 'EMAIL_BLOCKED' | 'PHONE_BLOCKED' | 'CUSTOMER_BLOCKED' | 'NO_EMAIL' | 'INVALID_SEGMENT' | 'CAMPAIGN_REFUSED' | 'NOT_CANCELLABLE' | 'AUTOMATION_REFUSED' | 'SEQUENCE_REFUSED' | 'TEAM_REFUSED' | 'GROUP_IN_USE' | 'LAST_LOCATION' | 'PLACES_OFF' | 'PLACES_UNAVAILABLE' | 'PLACE_CHOICE' | 'ACCOUNT_EXISTS' | 'TICKET_CLOSED' | 'SELF_CHANGE' | 'TEST_MODE_MISMATCH' | 'TEST_ENV_ONLY' | 'TEST_ENV_NESTED' | 'TEST_ENV_NO_INVITE' | 'TEST_LIMIT_REACHED' | 'TEST_CARD_NO_WALLET' | 'INVALID_KEY' | 'BAD_WEBHOOK_URL' | 'ALREADY_CLOSED' | 'NOT_REOPENABLE' | 'INCIDENT_CLOSED' | 'INCIDENT_INCOMPLETE' | 'INTELLIGENCE_DISABLED' | 'PEOPLE_DISABLED' | 'DUPLICATE' | 'RECOVERY_DECIDED' | 'SECRET_NOT_ALLOWED';
|
|
4
|
+
export type ErrorCode = 'VALIDATION' | 'BAD_REQUEST' | 'INVALID_JSON' | 'UNSUPPORTED_MEDIA_TYPE' | 'PAYLOAD_TOO_LARGE' | 'IDEMPOTENCY_KEY_REQUIRED' | 'IDEMPOTENCY_KEY_REUSED' | 'IDEMPOTENCY_IN_PROGRESS' | 'CONFIRM_REQUIRED' | 'REASON_REQUIRED' | 'NOT_FOUND' | 'RATE_LIMITED' | 'INTERNAL' | 'CROSS_SITE' | 'UNAUTHENTICATED' | 'INVALID_API_KEY' | 'KEY_MODE_MISMATCH' | 'TOKEN_INVALID' | 'FLOW_EXPIRED' | 'PASSKEY_REFUSED' | 'CODE_INVALID' | 'CODE_LOCKED' | 'PHONE_BUSY' | 'LAST_WAY_IN' | 'CHANGE_PENDING' | 'WAY_IN_TOO_NEW' | 'NOT_ENABLED' | 'PUSH_ENDPOINT_REFUSED' | 'PUSH_DEVICE_REFUSED' | 'PUSH_KEY_MISMATCH' | 'PUSH_NOT_SUBSCRIBED' | 'PROVIDER_REFUSED' | 'PROVIDER_UNAVAILABLE' | 'DEVICE_RENEWAL' | 'DEVICE_RENEWAL_REFUSED' | 'DEVICE_PROOF' | 'DEVICE_KEY_REFUSED' | 'MERGE_REQUIRED' | 'IDENT_SAME' | 'LOGIN_FAILED' | 'MFA_REQUIRED' | 'MFA_INVALID' | 'MFA_NOT_SET' | 'MFA_ALREADY_ENABLED' | 'MFA_REQUIRED_BY_TEAM' | 'MFA_OWNER_FIRST' | 'STEP_UP_FAILED' | 'CREDENTIAL_NOT_ALLOWED' | 'MERCHANT_REQUIRED' | 'SEAT_INACTIVE' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'OUT_OF_SCOPE' | 'PLAN_FEATURE_MISSING' | 'READ_ONLY' | 'VIEW_AS_READ_ONLY' | 'SEAT_LIMIT' | 'LIMIT' | 'PROGRAM_NOT_FOUND' | 'PASS_NOT_FOUND' | 'CUSTOMER_NOT_FOUND' | 'SEGMENT_NOT_FOUND' | 'CAMPAIGN_NOT_FOUND' | 'AUTOMATION_NOT_FOUND' | 'SEQUENCE_NOT_FOUND' | 'LOCATION_NOT_FOUND' | 'GROUP_NOT_FOUND' | 'MEMBER_NOT_FOUND' | 'SEAT_NOT_FOUND' | 'ERASURE_NOT_FOUND' | 'JOIN_CLOSED' | 'INVITE_NOT_FOUND' | 'GRANT_NOT_FOUND' | 'BATCH_NOT_FOUND' | 'KEY_NOT_FOUND' | 'WEBHOOK_NOT_FOUND' | 'SHOP_NOT_FOUND' | 'SHOP_PROGRAM_MISMATCH' | 'CONNECT_TOKEN_INVALID' | 'CONNECT_TOKEN_NOT_FOUND' | 'NO_PLUGIN_KEY' | 'CODE_EXPIRED' | 'CODE_USED' | 'INVITE_SIGN_IN' | 'INVITE_OTHER_ACCOUNT' | 'CODE_RELEASED' | 'CODE_NOT_ACCEPTED_HERE' | 'CURRENCY_MISMATCH' | 'SHOP_PAUSED' | 'VOUCHER_NOT_ONLINE' | 'NOT_ONLINE' | 'TOO_MANY_CODES' | 'CODE_ATTACHED' | 'CODE_NOT_FOUND' | 'CARD_IN_ORDER' | 'ORDER_CODES_LIMIT' | 'HOLD_UNBACKED' | 'REDEMPTION_NOT_FOUND' | 'REFUND_TOO_LARGE' | 'NOT_REFUNDABLE' | 'NOT_HELD' | 'TICKET_NOT_FOUND' | 'NOTIFICATION_NOT_FOUND' | 'EXPORT_NOT_FOUND' | 'SESSION_NOT_FOUND' | 'PASS_REFUSED' | 'PASS_INACTIVE' | 'PASS_EXPIRED' | 'PASS_USED_UP' | 'WRONG_CARD_TYPE' | 'INSUFFICIENT_BALANCE' | 'REWARD_NOT_READY' | 'OWNER_EMAIL_UNVERIFIED' | 'SALE_NOT_FOUND' | 'SALE_AMBIGUOUS' | 'SALE_ALREADY_SPENT' | 'ACTION_NOT_FOUND' | 'ACTION_AMBIGUOUS' | 'ACTION_NOT_REVERSIBLE' | 'WRONG_LOCATION' | 'INVALID_PROMOTION' | 'PROMOTION_NOT_FOUND' | 'VISIT_ALREADY_COUNTED' | 'ALREADY_ENDED' | 'PASS_STILL_ACTIVE' | 'CLAIM_CODE' | 'BAD_ACTION' | 'CONSENT_REQUIRED' | 'LEADERBOARD_OFF' | 'LEADERBOARD_ANONYMOUS' | 'WALLET_UNAVAILABLE' | 'INVALID_CONFIG' | 'BAD_IMAGE' | 'PROGRAM_HAS_CARDS' | 'ALREADY_ARCHIVED' | 'NOT_ARCHIVED' | 'NOT_AN_INSTRUMENT' | 'INVALID_BATCH' | 'BATCH_CLOSED' | 'BATCH_EXPIRED' | 'BATCH_FULL' | 'ALREADY_CLAIMED' | 'CURRENCY_LOCKED' | 'INVALID_CUSTOMER' | 'FIELD_REQUIRED' | 'INVALID_BIRTHDAY' | 'INVALID_PHONE' | 'EMAIL_BLOCKED' | 'PHONE_BLOCKED' | 'CUSTOMER_BLOCKED' | 'NO_EMAIL' | 'INVALID_SEGMENT' | 'CAMPAIGN_REFUSED' | 'NOT_CANCELLABLE' | 'AUTOMATION_REFUSED' | 'SEQUENCE_REFUSED' | 'TEAM_REFUSED' | 'GROUP_IN_USE' | 'LAST_LOCATION' | 'PLACES_OFF' | 'PLACES_UNAVAILABLE' | 'PLACE_CHOICE' | 'ACCOUNT_EXISTS' | 'TICKET_CLOSED' | 'SELF_CHANGE' | 'TEST_MODE_MISMATCH' | 'TEST_ENV_ONLY' | 'TEST_ENV_NESTED' | 'TEST_ENV_NO_INVITE' | 'TEST_LIMIT_REACHED' | 'TEST_CARD_NO_WALLET' | 'INVALID_KEY' | 'BAD_WEBHOOK_URL' | 'ALREADY_CLOSED' | 'NOT_REOPENABLE' | 'INCIDENT_CLOSED' | 'INCIDENT_INCOMPLETE' | 'INTELLIGENCE_DISABLED' | 'PEOPLE_DISABLED' | 'DUPLICATE' | 'RECOVERY_DECIDED' | 'SECRET_NOT_ALLOWED';
|
|
5
5
|
/** The body of an error answer. `C` narrows `error.code` to the codes a status can carry. */
|
|
6
6
|
export interface ErrorBody<C extends string = ErrorCode> {
|
|
7
7
|
error: {
|
|
@@ -26,7 +26,7 @@ export interface PageMeta {
|
|
|
26
26
|
export interface IssuePassHeaders {
|
|
27
27
|
/** Ekip oturumu birden fazla işletmede koltuk taşıyorsa hangi işletme için olduğu (tek işletmede gerekmez). */
|
|
28
28
|
'Rewloy-Merchant'?: string;
|
|
29
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
29
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
30
30
|
'Idempotency-Key'?: string;
|
|
31
31
|
}
|
|
32
32
|
/** Request body of `issuePass`. */
|
|
@@ -78,7 +78,7 @@ export interface IssuePassArgs extends RequestOptions {
|
|
|
78
78
|
/** The JSON body. */
|
|
79
79
|
body: IssuePassBody;
|
|
80
80
|
/**
|
|
81
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
81
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
82
82
|
*
|
|
83
83
|
* `Idempotency-Key`: 8–64 printable ASCII characters. When omitted, the client generates a UUID and sends the same one on every retry of this call.
|
|
84
84
|
*/
|
|
@@ -106,9 +106,9 @@ export interface GetPassData {
|
|
|
106
106
|
programId: string;
|
|
107
107
|
type: 'stamp' | 'points' | 'discount' | 'vip' | 'giftcard' | 'voucher' | 'cashback';
|
|
108
108
|
status: string;
|
|
109
|
-
/** Programın adı
|
|
109
|
+
/** Programın adı */
|
|
110
110
|
programName: string;
|
|
111
|
-
/** Kartın para birimi (ISO 4217, ör. `TRY`, `EUR`): programın para birimi — cashback ve hediye kartında programın kendi para birimi, öteki türlerde işletmeninki. Bu karttaki satışın ve işlemlerin `amountMinor`'ı bu birimdedir ve `currency` alanları bununla karşılaştırılır
|
|
111
|
+
/** Kartın para birimi (ISO 4217, ör. `TRY`, `EUR`): programın para birimi — cashback ve hediye kartında programın kendi para birimi, öteki türlerde işletmeninki. Bu karttaki satışın ve işlemlerin `amountMinor`'ı bu birimdedir ve `currency` alanları bununla karşılaştırılır */
|
|
112
112
|
currency: string;
|
|
113
113
|
/** Türe göre birimi değişir: damga kartında damga, puan kartında puan, VIP'te ziyaret, cashback ve hediye kartında kuruş (`money.currency` cinsinden); kupon ve indirim kartının bakiyesi yoktur (0). Yeni kodda türe özgü alanları okuyun: `stamps`, `points`, `money`. */
|
|
114
114
|
balance: number | null;
|
|
@@ -220,7 +220,7 @@ export interface PassActionParams {
|
|
|
220
220
|
export interface PassActionHeaders {
|
|
221
221
|
/** Ekip oturumu birden fazla işletmede koltuk taşıyorsa hangi işletme için olduğu (tek işletmede gerekmez). */
|
|
222
222
|
'Rewloy-Merchant'?: string;
|
|
223
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
223
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
224
224
|
'Idempotency-Key': string;
|
|
225
225
|
}
|
|
226
226
|
/** Request body of `passAction`. */
|
|
@@ -233,20 +233,31 @@ export interface PassActionBody {
|
|
|
233
233
|
rewardIndex?: number;
|
|
234
234
|
/** İsteğe bağlı: tutarın para birimi (ISO 4217, ör. `TRY`, `EUR`, büyük-küçük harf önemsiz). Tutar **kartın para birimindedir** (programın para birimi: `GET /v1/passes/{serial}` → `currency`, `GET /v1/programs/{id}`); verilirse onunla karşılaştırılır, farklıysa `422 CURRENCY_MISMATCH` (`details.currency` kartınki) ve hiçbir şey yazılmaz. Tutar çevrilmez. */
|
|
235
235
|
currency?: string;
|
|
236
|
+
/** İsteğe bağlı: fiş ya da sipariş numarası. Kaydın notuna yazılır (müşterinin geçmişi, işlem dökümü); işlemi `POST /v1/passes/{serial}/actions/reverse` ile geri alırken onu bulmanın bir yolu. Kişisel bilgi yazmayın. */
|
|
237
|
+
reference?: string;
|
|
236
238
|
}
|
|
237
239
|
/** The `data` of `passAction`'s answer. */
|
|
238
|
-
export
|
|
240
|
+
export type PassActionData = {
|
|
241
|
+
/** İşlemden sonra kartın bakiyesi: damga, puan, ziyaret ya da kuruş */
|
|
239
242
|
balance: number;
|
|
240
243
|
duplicate: boolean;
|
|
241
|
-
/** Damga: ödül hazır oldu · puan: karşılanabilen en yüksek ödül · VIP: seviye */
|
|
244
|
+
/** Damga: ödül hazır oldu (`reward-ready`) · puan: karşılanabilen en yüksek ödül · VIP: seviye · hediye kartı: bakiye bitti, kart kapandı (`ended`) */
|
|
242
245
|
detail?: string;
|
|
243
|
-
/** Bu kazanımı katlayan kasa kampanyası
|
|
246
|
+
/** Bu kazanımı katlayan kasa kampanyası */
|
|
244
247
|
promotion?: {
|
|
245
248
|
id: string;
|
|
246
249
|
name: string;
|
|
247
250
|
factor: number;
|
|
248
251
|
};
|
|
249
|
-
}
|
|
252
|
+
} | {
|
|
253
|
+
/** Kartın durumu: `active`, ya da kullanım hakkı bu kullanımla dolduysa `redeemed` (kart kapandı); bir tekrarda kartın şimdiki durumu */
|
|
254
|
+
status: string;
|
|
255
|
+
duplicate: boolean;
|
|
256
|
+
/** Kartın şimdiye kadarki kullanımı */
|
|
257
|
+
uses: number;
|
|
258
|
+
/** Kalan kullanım; null: sınırsız */
|
|
259
|
+
usesLeft: number | null;
|
|
260
|
+
};
|
|
250
261
|
/** Arguments of `passAction`. */
|
|
251
262
|
export interface PassActionArgs extends RequestOptions {
|
|
252
263
|
/** Path parameters. */
|
|
@@ -254,7 +265,7 @@ export interface PassActionArgs extends RequestOptions {
|
|
|
254
265
|
/** The JSON body. */
|
|
255
266
|
body: PassActionBody;
|
|
256
267
|
/**
|
|
257
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
268
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
258
269
|
*
|
|
259
270
|
* `Idempotency-Key`, required: 8–64 printable ASCII characters. The client never makes one up (a generated key would not survive a restart of your app); it sends this one on every retry of the call.
|
|
260
271
|
*/
|
|
@@ -275,7 +286,7 @@ export interface RecordSaleParams {
|
|
|
275
286
|
export interface RecordSaleHeaders {
|
|
276
287
|
/** Ekip oturumu birden fazla işletmede koltuk taşıyorsa hangi işletme için olduğu (tek işletmede gerekmez). */
|
|
277
288
|
'Rewloy-Merchant'?: string;
|
|
278
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
289
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
279
290
|
'Idempotency-Key': string;
|
|
280
291
|
}
|
|
281
292
|
/** Request body of `recordSale`. */
|
|
@@ -288,6 +299,8 @@ export interface RecordSaleBody {
|
|
|
288
299
|
reference?: string;
|
|
289
300
|
/** İsteğe bağlı: tutarın para birimi (ISO 4217, ör. `TRY`, `EUR`, büyük-küçük harf önemsiz). Tutar **kartın para birimindedir** (programın para birimi: `GET /v1/passes/{serial}` → `currency`, `GET /v1/programs/{id}`); verilirse onunla karşılaştırılır, farklıysa `422 CURRENCY_MISMATCH` (`details.currency` kartınki) ve hiçbir şey yazılmaz. Tutar çevrilmez. */
|
|
290
301
|
currency?: string;
|
|
302
|
+
/** İsteğe bağlı: satışın gerçekten olduğu an (ISO 8601, saat dilimiyle), satış sonradan yazılıyorsa (çevrimdışı kasanın kuyruğu). Gelecekte olamaz (2 dakika saat farkı kabul edilir), en fazla 72 saat geriye gider ve kartın verildiği andan önce olamaz; değilse `400 VALIDATION`. VIP ziyareti bu ana göre sayılır, kasa kampanyası bu anda çalışan (ve o anda zaten açılmış) kampanyadır; kaydın kendi zamanı yazıldığı andır. Idempotency değişmez: aynı anahtar ve aynı gövde, `occurredAt` farklı olsa da tekrardır. */
|
|
303
|
+
occurredAt?: string;
|
|
291
304
|
}
|
|
292
305
|
/** The `data` of `recordSale`'s answer. */
|
|
293
306
|
export interface RecordSaleData {
|
|
@@ -302,7 +315,7 @@ export interface RecordSaleData {
|
|
|
302
315
|
duplicate: boolean;
|
|
303
316
|
/** Damga: ödül hazır oldu · VIP: seviye */
|
|
304
317
|
detail?: string;
|
|
305
|
-
/** Bu kazanımı katlayan kasa kampanyası
|
|
318
|
+
/** Bu kazanımı katlayan kasa kampanyası */
|
|
306
319
|
promotion?: {
|
|
307
320
|
id: string;
|
|
308
321
|
name: string;
|
|
@@ -318,7 +331,7 @@ export interface RecordSaleArgs extends RequestOptions {
|
|
|
318
331
|
/** The JSON body. */
|
|
319
332
|
body: RecordSaleBody;
|
|
320
333
|
/**
|
|
321
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
334
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
322
335
|
*
|
|
323
336
|
* `Idempotency-Key`, required: 8–64 printable ASCII characters. The client never makes one up (a generated key would not survive a restart of your app); it sends this one on every retry of the call.
|
|
324
337
|
*/
|
|
@@ -344,7 +357,7 @@ export interface ReverseSaleHeaders {
|
|
|
344
357
|
export interface ReverseSaleBody {
|
|
345
358
|
/** Satışın `Idempotency-Key`'i (aynı kimlikle gönderilmiş) */
|
|
346
359
|
saleKey?: string;
|
|
347
|
-
/** Satışın `reference`'ı; bu kartta tek bir
|
|
360
|
+
/** Satışın `reference`'ı; bu kartta bu kimliğin tek bir satışında olmalı */
|
|
348
361
|
reference?: string;
|
|
349
362
|
/** Geri almanın yapıldığı şube (isteğe bağlı) */
|
|
350
363
|
locationId?: string;
|
|
@@ -376,6 +389,60 @@ export interface ReverseSaleArgs extends RequestOptions {
|
|
|
376
389
|
*/
|
|
377
390
|
merchant?: string | undefined;
|
|
378
391
|
}
|
|
392
|
+
/** Path parameters of `reverseAction`. */
|
|
393
|
+
export interface ReverseActionParams {
|
|
394
|
+
/** Kart seri numarası, XXXX-XXXX-XXXX */
|
|
395
|
+
serial: string;
|
|
396
|
+
}
|
|
397
|
+
/** Header parameters of `reverseAction`, as sent on the wire. */
|
|
398
|
+
export interface ReverseActionHeaders {
|
|
399
|
+
/** Ekip oturumu birden fazla işletmede koltuk taşıyorsa hangi işletme için olduğu (tek işletmede gerekmez). */
|
|
400
|
+
'Rewloy-Merchant'?: string;
|
|
401
|
+
}
|
|
402
|
+
/** Request body of `reverseAction`. */
|
|
403
|
+
export interface ReverseActionBody {
|
|
404
|
+
/** İşlemin `Idempotency-Key`'i (aynı kimlikle gönderilmiş) */
|
|
405
|
+
actionKey?: string;
|
|
406
|
+
/** İşlemin `reference`'ı; bu kartta bu kimliğin tek bir işleminde olmalı */
|
|
407
|
+
reference?: string;
|
|
408
|
+
/** Geri almanın yapıldığı şube (isteğe bağlı) */
|
|
409
|
+
locationId?: string;
|
|
410
|
+
}
|
|
411
|
+
/** The `data` of `reverseAction`'s answer. */
|
|
412
|
+
export interface ReverseActionData {
|
|
413
|
+
type: 'stamp' | 'points' | 'discount' | 'vip' | 'giftcard' | 'voucher' | 'cashback';
|
|
414
|
+
/** Geri alınan: bir harcama (`spend`), bir ödül ya da puan harcaması (`redeem`: `redeem-stamps`, `redeem-reward`, `spend-points`), bir kullanım (`use`) */
|
|
415
|
+
undone: 'spend' | 'redeem' | 'use';
|
|
416
|
+
/** Geri verilen: damga, puan ya da kuruş; kullanımda 1 */
|
|
417
|
+
restored: number;
|
|
418
|
+
/** Geri almadan sonra kartın bakiyesi; kupon ve indirim kartında null */
|
|
419
|
+
balance: number | null;
|
|
420
|
+
/** Kupon ve indirim kartı: kullanım sayısı; öteki kartlarda null */
|
|
421
|
+
uses: number | null;
|
|
422
|
+
/** Kupon ve indirim kartı: kalan kullanım (null: sınırsız ya da bakiyeli kart) */
|
|
423
|
+
usesLeft: number | null;
|
|
424
|
+
/** Kartın şimdiki durumu */
|
|
425
|
+
status: string;
|
|
426
|
+
/** true: kart bu işlemle kapanmıştı (hediye kartı sıfıra indi, kuponun hakkı doldu) ve yeniden açıldı */
|
|
427
|
+
reopened: boolean;
|
|
428
|
+
/** true: işlem daha önce geri alınmıştı; şimdi hiçbir şey yazılmadı */
|
|
429
|
+
duplicate: boolean;
|
|
430
|
+
rewardReady: boolean;
|
|
431
|
+
rewardsReady: number;
|
|
432
|
+
}
|
|
433
|
+
/** Arguments of `reverseAction`. */
|
|
434
|
+
export interface ReverseActionArgs extends RequestOptions {
|
|
435
|
+
/** Path parameters. */
|
|
436
|
+
params: ReverseActionParams;
|
|
437
|
+
/** The JSON body. */
|
|
438
|
+
body?: ReverseActionBody;
|
|
439
|
+
/**
|
|
440
|
+
* Ekip oturumu birden fazla işletmede koltuk taşıyorsa hangi işletme için olduğu (tek işletmede gerekmez).
|
|
441
|
+
*
|
|
442
|
+
* `Rewloy-Merchant`. Defaults to the client's `merchant`.
|
|
443
|
+
*/
|
|
444
|
+
merchant?: string | undefined;
|
|
445
|
+
}
|
|
379
446
|
/** Path parameters of `publicProgram`. */
|
|
380
447
|
export interface PublicProgramParams {
|
|
381
448
|
id: string;
|
|
@@ -615,11 +682,11 @@ export interface LoginData {
|
|
|
615
682
|
requires2fa: boolean;
|
|
616
683
|
/** Bu işletmede herhangi bir şubede taşınan yetkiler (menü göstermek için; asıl kontrol her istekte yapılır). */
|
|
617
684
|
permissions: string[];
|
|
618
|
-
/** `test`: bir test
|
|
685
|
+
/** `test`: bir test ortamı. Buna `Rewloy-Merchant` başlığıyla açıkça seçerek ulaşılır; başlıksız istek onu seçmez. */
|
|
619
686
|
mode: 'live' | 'test';
|
|
620
687
|
/** Test ortamında, ait olduğu gerçek işletme; gerçek işletmede `null` */
|
|
621
688
|
testOf: string | null;
|
|
622
|
-
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir
|
|
689
|
+
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir */
|
|
623
690
|
currency: string;
|
|
624
691
|
}[];
|
|
625
692
|
}
|
|
@@ -692,11 +759,11 @@ export type MeData = {
|
|
|
692
759
|
requires2fa: boolean;
|
|
693
760
|
/** Bu işletmede herhangi bir şubede taşınan yetkiler (menü göstermek için; asıl kontrol her istekte yapılır). */
|
|
694
761
|
permissions: string[];
|
|
695
|
-
/** `test`: bir test
|
|
762
|
+
/** `test`: bir test ortamı. Buna `Rewloy-Merchant` başlığıyla açıkça seçerek ulaşılır; başlıksız istek onu seçmez. */
|
|
696
763
|
mode: 'live' | 'test';
|
|
697
764
|
/** Test ortamında, ait olduğu gerçek işletme; gerçek işletmede `null` */
|
|
698
765
|
testOf: string | null;
|
|
699
|
-
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir
|
|
766
|
+
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir */
|
|
700
767
|
currency: string;
|
|
701
768
|
}[];
|
|
702
769
|
activeMerchantId: string | null;
|
|
@@ -713,7 +780,7 @@ export type MeData = {
|
|
|
713
780
|
rateLimitPerMinute: number;
|
|
714
781
|
/** Bağlantı koduyla kurulmuş bir mağaza eklentisinin anahtarıysa ait olduğu mağaza bağlantısı (yalnız onu görür ve yönetir); değilse null. */
|
|
715
782
|
shopId: string | null;
|
|
716
|
-
/** Bir eklentinin ekranlarını açıp kapatmak için, yetkilerden okunur
|
|
783
|
+
/** Bir eklentinin ekranlarını açıp kapatmak için, yetkilerden okunur: `view` = `passes.read` ve `analytics.read` (kart durumu, programın sayıları ve son işlemleri; müşterinin kişisel bilgisi yok); `till` = `scan.use` tam olarak bir şubede (o şubenin kasası: `getPassTill`, `recordSale`, `passAction`). Birden çok şubede ya da her yerde `scan.use` taşıyan anahtarın tek bir kasası olmadığından `till` yazılmaz. */
|
|
717
784
|
abilities: Array<'view' | 'till'>;
|
|
718
785
|
/** `till` varken kasanın şubesi (işlemlerde `locationId` olarak gönderilir); yoksa null. */
|
|
719
786
|
tillLocationId: string | null;
|
|
@@ -723,7 +790,7 @@ export type MeData = {
|
|
|
723
790
|
business: {
|
|
724
791
|
id: string;
|
|
725
792
|
name: string;
|
|
726
|
-
/** İşletmenin para birimi (ISO 4217, ör. `TRY`, `EUR`): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir. Varsayılan `TRY`; para kartı verilene dek `PATCH /v1/business` ile değişir
|
|
793
|
+
/** İşletmenin para birimi (ISO 4217, ör. `TRY`, `EUR`): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir. Varsayılan `TRY`; para kartı verilene dek `PATCH /v1/business` ile değişir */
|
|
727
794
|
currency: string;
|
|
728
795
|
};
|
|
729
796
|
permissions: string[];
|
|
@@ -740,7 +807,7 @@ export interface MeArgs extends RequestOptions {
|
|
|
740
807
|
}
|
|
741
808
|
/** Header parameters of `holderLogin`, as sent on the wire. */
|
|
742
809
|
export interface HolderLoginHeaders {
|
|
743
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
810
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
744
811
|
'Idempotency-Key'?: string;
|
|
745
812
|
}
|
|
746
813
|
/** Request body of `holderLogin`. */
|
|
@@ -768,7 +835,7 @@ export interface HolderLoginArgs extends RequestOptions {
|
|
|
768
835
|
/** The JSON body. */
|
|
769
836
|
body?: HolderLoginBody;
|
|
770
837
|
/**
|
|
771
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
838
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
772
839
|
*
|
|
773
840
|
* `Idempotency-Key`: 8–64 printable ASCII characters. When omitted, the client generates a UUID and sends the same one on every retry of this call.
|
|
774
841
|
*/
|
|
@@ -945,11 +1012,11 @@ export interface SignupData {
|
|
|
945
1012
|
requires2fa: boolean;
|
|
946
1013
|
/** Bu işletmede herhangi bir şubede taşınan yetkiler (menü göstermek için; asıl kontrol her istekte yapılır). */
|
|
947
1014
|
permissions: string[];
|
|
948
|
-
/** `test`: bir test
|
|
1015
|
+
/** `test`: bir test ortamı. Buna `Rewloy-Merchant` başlığıyla açıkça seçerek ulaşılır; başlıksız istek onu seçmez. */
|
|
949
1016
|
mode: 'live' | 'test';
|
|
950
1017
|
/** Test ortamında, ait olduğu gerçek işletme; gerçek işletmede `null` */
|
|
951
1018
|
testOf: string | null;
|
|
952
|
-
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir
|
|
1019
|
+
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir */
|
|
953
1020
|
currency: string;
|
|
954
1021
|
}[];
|
|
955
1022
|
merchantId: string;
|
|
@@ -1066,11 +1133,11 @@ export interface AcceptInviteData {
|
|
|
1066
1133
|
requires2fa: boolean;
|
|
1067
1134
|
/** Bu işletmede herhangi bir şubede taşınan yetkiler (menü göstermek için; asıl kontrol her istekte yapılır). */
|
|
1068
1135
|
permissions: string[];
|
|
1069
|
-
/** `test`: bir test
|
|
1136
|
+
/** `test`: bir test ortamı. Buna `Rewloy-Merchant` başlığıyla açıkça seçerek ulaşılır; başlıksız istek onu seçmez. */
|
|
1070
1137
|
mode: 'live' | 'test';
|
|
1071
1138
|
/** Test ortamında, ait olduğu gerçek işletme; gerçek işletmede `null` */
|
|
1072
1139
|
testOf: string | null;
|
|
1073
|
-
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir
|
|
1140
|
+
/** İşletmenin para birimi (ISO 4217): satışların `amountMinor`'ı ve para kartlarının tutarları bu birimdedir */
|
|
1074
1141
|
currency: string;
|
|
1075
1142
|
}[];
|
|
1076
1143
|
}
|
|
@@ -1543,7 +1610,7 @@ export interface CreateProgramBody {
|
|
|
1543
1610
|
stampAccentColor?: string;
|
|
1544
1611
|
/** Kart sayfasında son 90 günün sıralaması (hediye kartı, kupon ve indirimde yok) */
|
|
1545
1612
|
leaderboard?: boolean;
|
|
1546
|
-
/** Kasanın bu programın kartlarında işlem yapabileceği şubeler
|
|
1613
|
+
/** Kasanın bu programın kartlarında işlem yapabileceği şubeler; boş = hepsi. Başka şubede `WRONG_LOCATION` döner; online siparişler etkilenmez. */
|
|
1547
1614
|
validLocationIds?: string[];
|
|
1548
1615
|
/** Katılım formunda e-postadan başka sorulanlar */
|
|
1549
1616
|
signupFields?: {
|
|
@@ -1617,7 +1684,7 @@ export interface CreateProgramBody {
|
|
|
1617
1684
|
cashbackRate?: number;
|
|
1618
1685
|
/** Kupon: teklif metni */
|
|
1619
1686
|
offerText?: string;
|
|
1620
|
-
/** Kupon: online mağazada kullanıldığında değeri
|
|
1687
|
+
/** Kupon: online mağazada kullanıldığında değeri. Yoksa (ya da null) kupon yalnız mağazada geçer; kodun kendi online değeri ya da tutarı bunun önüne geçer. */
|
|
1621
1688
|
onlineValue?: {
|
|
1622
1689
|
kind: 'amount' | 'percent';
|
|
1623
1690
|
/** amount: kuruş (100 – 10.000.000); percent: 1 – 100 */
|
|
@@ -1806,7 +1873,7 @@ export interface UpdateProgramBody {
|
|
|
1806
1873
|
stampAccentColor?: string;
|
|
1807
1874
|
/** Kart sayfasında son 90 günün sıralaması (hediye kartı, kupon ve indirimde yok) */
|
|
1808
1875
|
leaderboard?: boolean;
|
|
1809
|
-
/** Kasanın bu programın kartlarında işlem yapabileceği şubeler
|
|
1876
|
+
/** Kasanın bu programın kartlarında işlem yapabileceği şubeler; boş = hepsi. Başka şubede `WRONG_LOCATION` döner; online siparişler etkilenmez. */
|
|
1810
1877
|
validLocationIds?: string[];
|
|
1811
1878
|
/** Katılım formunda e-postadan başka sorulanlar */
|
|
1812
1879
|
signupFields?: {
|
|
@@ -1880,7 +1947,7 @@ export interface UpdateProgramBody {
|
|
|
1880
1947
|
cashbackRate?: number;
|
|
1881
1948
|
/** Kupon: teklif metni */
|
|
1882
1949
|
offerText?: string;
|
|
1883
|
-
/** Kupon: online mağazada kullanıldığında değeri
|
|
1950
|
+
/** Kupon: online mağazada kullanıldığında değeri. Yoksa (ya da null) kupon yalnız mağazada geçer; kodun kendi online değeri ya da tutarı bunun önüne geçer. */
|
|
1884
1951
|
onlineValue?: {
|
|
1885
1952
|
kind: 'amount' | 'percent';
|
|
1886
1953
|
/** amount: kuruş (100 – 10.000.000); percent: 1 – 100 */
|
|
@@ -1988,7 +2055,7 @@ export interface PreviewProgramBody {
|
|
|
1988
2055
|
stampAccentColor?: string;
|
|
1989
2056
|
/** Kart sayfasında son 90 günün sıralaması (hediye kartı, kupon ve indirimde yok) */
|
|
1990
2057
|
leaderboard?: boolean;
|
|
1991
|
-
/** Kasanın bu programın kartlarında işlem yapabileceği şubeler
|
|
2058
|
+
/** Kasanın bu programın kartlarında işlem yapabileceği şubeler; boş = hepsi. Başka şubede `WRONG_LOCATION` döner; online siparişler etkilenmez. */
|
|
1992
2059
|
validLocationIds?: string[];
|
|
1993
2060
|
/** Katılım formunda e-postadan başka sorulanlar */
|
|
1994
2061
|
signupFields?: {
|
|
@@ -2062,7 +2129,7 @@ export interface PreviewProgramBody {
|
|
|
2062
2129
|
cashbackRate?: number;
|
|
2063
2130
|
/** Kupon: teklif metni */
|
|
2064
2131
|
offerText?: string;
|
|
2065
|
-
/** Kupon: online mağazada kullanıldığında değeri
|
|
2132
|
+
/** Kupon: online mağazada kullanıldığında değeri. Yoksa (ya da null) kupon yalnız mağazada geçer; kodun kendi online değeri ya da tutarı bunun önüne geçer. */
|
|
2066
2133
|
onlineValue?: {
|
|
2067
2134
|
kind: 'amount' | 'percent';
|
|
2068
2135
|
/** amount: kuruş (100 – 10.000.000); percent: 1 – 100 */
|
|
@@ -2377,7 +2444,7 @@ export interface ListCustomersItem {
|
|
|
2377
2444
|
displayName: string;
|
|
2378
2445
|
/** **Kullanımdan kalkıyor:** 5 Nisan 2027 tarihine kadar gelir; yerine `identifiers`. */
|
|
2379
2446
|
email: string | null;
|
|
2380
|
-
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman
|
|
2447
|
+
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman */
|
|
2381
2448
|
identifiers: {
|
|
2382
2449
|
kind: 'email' | 'phone';
|
|
2383
2450
|
/** Adres (küçük harf) ya da numara (E.164, +905…) */
|
|
@@ -2464,7 +2531,7 @@ export interface ListCustomerCardsItem {
|
|
|
2464
2531
|
displayName: string;
|
|
2465
2532
|
/** **Kullanımdan kalkıyor:** 5 Nisan 2027 tarihine kadar gelir; yerine `identifiers`. */
|
|
2466
2533
|
email: string | null;
|
|
2467
|
-
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman
|
|
2534
|
+
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman */
|
|
2468
2535
|
identifiers: {
|
|
2469
2536
|
kind: 'email' | 'phone';
|
|
2470
2537
|
/** Adres (küçük harf) ya da numara (E.164, +905…) */
|
|
@@ -2505,7 +2572,7 @@ export interface GetCustomerData {
|
|
|
2505
2572
|
lastName: string | null;
|
|
2506
2573
|
/** **Kullanımdan kalkıyor:** 5 Nisan 2027 tarihine kadar gelir; yerine `identifiers`. */
|
|
2507
2574
|
email: string | null;
|
|
2508
|
-
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman
|
|
2575
|
+
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman */
|
|
2509
2576
|
identifiers: {
|
|
2510
2577
|
kind: 'email' | 'phone';
|
|
2511
2578
|
/** Adres (küçük harf) ya da numara (E.164, +905…) */
|
|
@@ -2519,7 +2586,7 @@ export interface GetCustomerData {
|
|
|
2519
2586
|
phone: string | null;
|
|
2520
2587
|
birthday: string | null;
|
|
2521
2588
|
createdAt: string;
|
|
2522
|
-
/** **Kullanımdan kalkıyor:** 5 Nisan 2027 tarihine kadar gelir; yerine `identifiers`. Kişinin gelen kodla doğruladığı numaralar (Rewloy Cüzdan
|
|
2589
|
+
/** **Kullanımdan kalkıyor:** 5 Nisan 2027 tarihine kadar gelir; yerine `identifiers`. Kişinin gelen kodla doğruladığı numaralar (Rewloy Cüzdan): `phone`dan ayrı; `identifiers` içindeki numaraların aynısı */
|
|
2523
2590
|
verifiedPhones: {
|
|
2524
2591
|
/** E.164 */
|
|
2525
2592
|
phone: string;
|
|
@@ -2608,7 +2675,7 @@ export interface CustomerTimelineHeaders {
|
|
|
2608
2675
|
/** One item of `customerTimeline`'s list. */
|
|
2609
2676
|
export interface CustomerTimelineItem {
|
|
2610
2677
|
at: string;
|
|
2611
|
-
/** earn, redeem, spend, load, …; hold, release, refund (online ödeme kodu
|
|
2678
|
+
/** earn, redeem, spend, load, …; hold, release, refund (online ödeme kodu); visit; campaign, automation:<tür>, sequence; issued; verified:phone; changed:email, changed:phone */
|
|
2612
2679
|
kind: string;
|
|
2613
2680
|
group: 'points' | 'rewards' | 'spend' | 'visits' | 'messages' | 'cards' | 'contact';
|
|
2614
2681
|
/** Defter değişimi (damga, puan ya da kuruş) */
|
|
@@ -3014,7 +3081,7 @@ export interface CreateBatchBody {
|
|
|
3014
3081
|
kind: 'amount' | 'percent';
|
|
3015
3082
|
value: number;
|
|
3016
3083
|
};
|
|
3017
|
-
/** Kartların kasada kabul edileceği şubeler
|
|
3084
|
+
/** Kartların kasada kabul edileceği şubeler; boş ya da yok = programın kuralı. Şube kapsamlı bir kimlik yalnız kendi şubelerini seçebilir. */
|
|
3018
3085
|
locationIds?: string[];
|
|
3019
3086
|
}
|
|
3020
3087
|
/** The `data` of `createBatch`'s answer. */
|
|
@@ -3051,7 +3118,7 @@ export interface CreateBatchData {
|
|
|
3051
3118
|
revoked: number;
|
|
3052
3119
|
uses: number;
|
|
3053
3120
|
};
|
|
3054
|
-
/** Kodun kendi şube listesi; null = programın kuralı
|
|
3121
|
+
/** Kodun kendi şube listesi; null = programın kuralı */
|
|
3055
3122
|
locationIds: string[] | null;
|
|
3056
3123
|
/** Bu koddan verilen kartların kasada kabul edildiği şubeler; boş = hepsi */
|
|
3057
3124
|
branchNames: string[];
|
|
@@ -3059,7 +3126,7 @@ export interface CreateBatchData {
|
|
|
3059
3126
|
spentMinor: number;
|
|
3060
3127
|
/** Hediye kartı: açık kartlarda kalan (defter bakiyeleri), kuruş */
|
|
3061
3128
|
outstandingMinor: number;
|
|
3062
|
-
/** Kupon: online mağazada kullanıldığındaki değeri
|
|
3129
|
+
/** Kupon: online mağazada kullanıldığındaki değeri; null = kodun tutarı, yoksa programın `onlineValue`'su, o da yoksa yalnız mağazada */
|
|
3063
3130
|
onlineValue: {
|
|
3064
3131
|
kind: 'amount' | 'percent';
|
|
3065
3132
|
value: number;
|
|
@@ -3121,7 +3188,7 @@ export interface GetBatchData {
|
|
|
3121
3188
|
revoked: number;
|
|
3122
3189
|
uses: number;
|
|
3123
3190
|
};
|
|
3124
|
-
/** Kodun kendi şube listesi; null = programın kuralı
|
|
3191
|
+
/** Kodun kendi şube listesi; null = programın kuralı */
|
|
3125
3192
|
locationIds: string[] | null;
|
|
3126
3193
|
/** Bu koddan verilen kartların kasada kabul edildiği şubeler; boş = hepsi */
|
|
3127
3194
|
branchNames: string[];
|
|
@@ -3129,7 +3196,7 @@ export interface GetBatchData {
|
|
|
3129
3196
|
spentMinor: number;
|
|
3130
3197
|
/** Hediye kartı: açık kartlarda kalan (defter bakiyeleri), kuruş */
|
|
3131
3198
|
outstandingMinor: number;
|
|
3132
|
-
/** Kupon: online mağazada kullanıldığındaki değeri
|
|
3199
|
+
/** Kupon: online mağazada kullanıldığındaki değeri; null = kodun tutarı, yoksa programın `onlineValue`'su, o da yoksa yalnız mağazada */
|
|
3133
3200
|
onlineValue: {
|
|
3134
3201
|
kind: 'amount' | 'percent';
|
|
3135
3202
|
value: number;
|
|
@@ -3166,9 +3233,9 @@ export interface ListBatchCardsItem {
|
|
|
3166
3233
|
passId: string;
|
|
3167
3234
|
serial: string;
|
|
3168
3235
|
name: string;
|
|
3169
|
-
/** **Kullanımdan kalkıyor:** 5 Nisan 2027 tarihine kadar gelir; yerine `identifiers`. Kartı alanın adresi; `identifiers` gibi yalnız `customers.read` yetkisiyle ve kimliğin şube kapsamındaki kişiler için gelir, yoksa null
|
|
3236
|
+
/** **Kullanımdan kalkıyor:** 5 Nisan 2027 tarihine kadar gelir; yerine `identifiers`. Kartı alanın adresi; `identifiers` gibi yalnız `customers.read` yetkisiyle ve kimliğin şube kapsamındaki kişiler için gelir, yoksa null. Yerine geçen `identifiers`. */
|
|
3170
3237
|
email: string | null;
|
|
3171
|
-
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman
|
|
3238
|
+
/** Kişinin bu işletmedeki adresleri ve numaraları, durumlarıyla: önce adresler, sonra numaralar. Yalnız bu işletmenin kaydı; kişinin Rewloy Cüzdan hesabı ya da başka işletmeleri hiçbir zaman. Yalnız `customers.read` yetkisiyle, kimliğin şube kapsamındaki kişiler için gelir */
|
|
3172
3239
|
identifiers?: {
|
|
3173
3240
|
kind: 'email' | 'phone';
|
|
3174
3241
|
/** Adres (küçük harf) ya da numara (E.164, +905…) */
|
|
@@ -3269,7 +3336,7 @@ export interface CloseBatchData {
|
|
|
3269
3336
|
revoked: number;
|
|
3270
3337
|
uses: number;
|
|
3271
3338
|
};
|
|
3272
|
-
/** Kodun kendi şube listesi; null = programın kuralı
|
|
3339
|
+
/** Kodun kendi şube listesi; null = programın kuralı */
|
|
3273
3340
|
locationIds: string[] | null;
|
|
3274
3341
|
/** Bu koddan verilen kartların kasada kabul edildiği şubeler; boş = hepsi */
|
|
3275
3342
|
branchNames: string[];
|
|
@@ -3277,7 +3344,7 @@ export interface CloseBatchData {
|
|
|
3277
3344
|
spentMinor: number;
|
|
3278
3345
|
/** Hediye kartı: açık kartlarda kalan (defter bakiyeleri), kuruş */
|
|
3279
3346
|
outstandingMinor: number;
|
|
3280
|
-
/** Kupon: online mağazada kullanıldığındaki değeri
|
|
3347
|
+
/** Kupon: online mağazada kullanıldığındaki değeri; null = kodun tutarı, yoksa programın `onlineValue`'su, o da yoksa yalnız mağazada */
|
|
3281
3348
|
onlineValue: {
|
|
3282
3349
|
kind: 'amount' | 'percent';
|
|
3283
3350
|
value: number;
|
|
@@ -4032,7 +4099,7 @@ export interface ListCampaignsArgs extends RequestOptions {
|
|
|
4032
4099
|
export interface SendCampaignHeaders {
|
|
4033
4100
|
/** Ekip oturumu birden fazla işletmede koltuk taşıyorsa hangi işletme için olduğu (tek işletmede gerekmez). */
|
|
4034
4101
|
'Rewloy-Merchant'?: string;
|
|
4035
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
4102
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
4036
4103
|
'Idempotency-Key': string;
|
|
4037
4104
|
}
|
|
4038
4105
|
/** Request body of `sendCampaign`. */
|
|
@@ -4112,7 +4179,7 @@ export interface SendCampaignArgs extends RequestOptions {
|
|
|
4112
4179
|
/** The JSON body. */
|
|
4113
4180
|
body: SendCampaignBody;
|
|
4114
4181
|
/**
|
|
4115
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
4182
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
4116
4183
|
*
|
|
4117
4184
|
* `Idempotency-Key`, required: 8–64 printable ASCII characters. The client never makes one up (a generated key would not survive a restart of your app); it sends this one on every retry of the call.
|
|
4118
4185
|
*/
|
|
@@ -5566,6 +5633,8 @@ export interface ListActivityItem {
|
|
|
5566
5633
|
/** Ekip üyesinin e-postası, "API: <anahtar adı>" ya da "sistem" */
|
|
5567
5634
|
actor: string;
|
|
5568
5635
|
actorKind: string;
|
|
5636
|
+
/** Satış sonradan yazıldıysa (`recordSale`'in `occurredAt`'ı) olduğu an; değilse null (olduğu an `at`). */
|
|
5637
|
+
occurredAt?: string | null;
|
|
5569
5638
|
}
|
|
5570
5639
|
/** Arguments of `listActivity`. */
|
|
5571
5640
|
export interface ListActivityArgs extends RequestOptions {
|
|
@@ -6374,7 +6443,7 @@ export interface ListShopsItem {
|
|
|
6374
6443
|
id: string;
|
|
6375
6444
|
prefix: string;
|
|
6376
6445
|
name: string;
|
|
6377
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
6446
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
6378
6447
|
abilities: Array<'view' | 'till'>;
|
|
6379
6448
|
/** Kasa açıksa şubesi; değilse null */
|
|
6380
6449
|
tillLocationId: string | null;
|
|
@@ -6385,7 +6454,7 @@ export interface ListShopsItem {
|
|
|
6385
6454
|
} | null;
|
|
6386
6455
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
6387
6456
|
shopName: string | null;
|
|
6388
|
-
/** Ödeme adımındaki kart kodlarının
|
|
6457
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
6389
6458
|
settings: {
|
|
6390
6459
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
6391
6460
|
tax: {
|
|
@@ -6483,7 +6552,7 @@ export interface CreateShopData {
|
|
|
6483
6552
|
id: string;
|
|
6484
6553
|
prefix: string;
|
|
6485
6554
|
name: string;
|
|
6486
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
6555
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
6487
6556
|
abilities: Array<'view' | 'till'>;
|
|
6488
6557
|
/** Kasa açıksa şubesi; değilse null */
|
|
6489
6558
|
tillLocationId: string | null;
|
|
@@ -6494,7 +6563,7 @@ export interface CreateShopData {
|
|
|
6494
6563
|
} | null;
|
|
6495
6564
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
6496
6565
|
shopName: string | null;
|
|
6497
|
-
/** Ödeme adımındaki kart kodlarının
|
|
6566
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
6498
6567
|
settings: {
|
|
6499
6568
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
6500
6569
|
tax: {
|
|
@@ -6589,7 +6658,7 @@ export interface GetShopData {
|
|
|
6589
6658
|
id: string;
|
|
6590
6659
|
prefix: string;
|
|
6591
6660
|
name: string;
|
|
6592
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
6661
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
6593
6662
|
abilities: Array<'view' | 'till'>;
|
|
6594
6663
|
/** Kasa açıksa şubesi; değilse null */
|
|
6595
6664
|
tillLocationId: string | null;
|
|
@@ -6600,7 +6669,7 @@ export interface GetShopData {
|
|
|
6600
6669
|
} | null;
|
|
6601
6670
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
6602
6671
|
shopName: string | null;
|
|
6603
|
-
/** Ödeme adımındaki kart kodlarının
|
|
6672
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
6604
6673
|
settings: {
|
|
6605
6674
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
6606
6675
|
tax: {
|
|
@@ -6697,7 +6766,7 @@ export interface SetShopEnabledData {
|
|
|
6697
6766
|
id: string;
|
|
6698
6767
|
prefix: string;
|
|
6699
6768
|
name: string;
|
|
6700
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
6769
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
6701
6770
|
abilities: Array<'view' | 'till'>;
|
|
6702
6771
|
/** Kasa açıksa şubesi; değilse null */
|
|
6703
6772
|
tillLocationId: string | null;
|
|
@@ -6708,7 +6777,7 @@ export interface SetShopEnabledData {
|
|
|
6708
6777
|
} | null;
|
|
6709
6778
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
6710
6779
|
shopName: string | null;
|
|
6711
|
-
/** Ödeme adımındaki kart kodlarının
|
|
6780
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
6712
6781
|
settings: {
|
|
6713
6782
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
6714
6783
|
tax: {
|
|
@@ -6824,9 +6893,9 @@ export interface ListShopConnectTokensItem {
|
|
|
6824
6893
|
expiresAt: string;
|
|
6825
6894
|
/** Kodu oluşturan kişinin e-postası */
|
|
6826
6895
|
createdBy: string | null;
|
|
6827
|
-
/** Kurulacak anahtar Görüntüleme yetkisini alır mı
|
|
6896
|
+
/** Kurulacak anahtar Görüntüleme yetkisini alır mı */
|
|
6828
6897
|
view: boolean;
|
|
6829
|
-
/** Kurulacak anahtarın kasası bu şubede açılır; null = kasa kapalı
|
|
6898
|
+
/** Kurulacak anahtarın kasası bu şubede açılır; null = kasa kapalı */
|
|
6830
6899
|
tillLocationId: string | null;
|
|
6831
6900
|
/** Kasanın şubesinin adı */
|
|
6832
6901
|
tillLocationName: string | null;
|
|
@@ -6854,7 +6923,7 @@ export interface CreateShopConnectTokenBody {
|
|
|
6854
6923
|
perAmountMinor?: number;
|
|
6855
6924
|
step?: number;
|
|
6856
6925
|
password: string;
|
|
6857
|
-
/** Görüntüleme: kartlar, durumları, programın sayıları ve son işlemleri. Gönderilmezse
|
|
6926
|
+
/** Görüntüleme: kartlar, durumları, programın sayıları ve son işlemleri. Gönderilmezse kapalı: eski istemcinin anahtarı eskisi gibi kalır */
|
|
6858
6927
|
view?: boolean;
|
|
6859
6928
|
/** Kasa: bu şubenin kasası; gönderilmezse ya da null ise kasa kapalı */
|
|
6860
6929
|
tillLocationId?: string | null;
|
|
@@ -6871,9 +6940,9 @@ export interface CreateShopConnectTokenData {
|
|
|
6871
6940
|
expiresAt: string;
|
|
6872
6941
|
/** Kodu oluşturan kişinin e-postası */
|
|
6873
6942
|
createdBy: string | null;
|
|
6874
|
-
/** Kurulacak anahtar Görüntüleme yetkisini alır mı
|
|
6943
|
+
/** Kurulacak anahtar Görüntüleme yetkisini alır mı */
|
|
6875
6944
|
view: boolean;
|
|
6876
|
-
/** Kurulacak anahtarın kasası bu şubede açılır; null = kasa kapalı
|
|
6945
|
+
/** Kurulacak anahtarın kasası bu şubede açılır; null = kasa kapalı */
|
|
6877
6946
|
tillLocationId: string | null;
|
|
6878
6947
|
/** Kasanın şubesinin adı */
|
|
6879
6948
|
tillLocationName: string | null;
|
|
@@ -6958,7 +7027,7 @@ export interface ConnectShopData {
|
|
|
6958
7027
|
id: string;
|
|
6959
7028
|
prefix: string;
|
|
6960
7029
|
name: string;
|
|
6961
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
7030
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
6962
7031
|
abilities: Array<'view' | 'till'>;
|
|
6963
7032
|
/** Kasa açıksa şubesi; değilse null */
|
|
6964
7033
|
tillLocationId: string | null;
|
|
@@ -6969,7 +7038,7 @@ export interface ConnectShopData {
|
|
|
6969
7038
|
} | null;
|
|
6970
7039
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
6971
7040
|
shopName: string | null;
|
|
6972
|
-
/** Ödeme adımındaki kart kodlarının
|
|
7041
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
6973
7042
|
settings: {
|
|
6974
7043
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
6975
7044
|
tax: {
|
|
@@ -7010,7 +7079,7 @@ export interface ConnectShopData {
|
|
|
7010
7079
|
role: string;
|
|
7011
7080
|
/** `rwk_…` (test ortamında `rwk_test_…`): yalnız bu yanıtta; Rewloy yalnız özetini saklar. */
|
|
7012
7081
|
token: string;
|
|
7013
|
-
/** Kodu alan kişinin seçtiği yetkiler
|
|
7082
|
+
/** Kodu alan kişinin seçtiği yetkiler: `view`, `till` */
|
|
7014
7083
|
abilities: Array<'view' | 'till'>;
|
|
7015
7084
|
/** Kasa açıksa şubesi (işlemlerde `locationId`); değilse null */
|
|
7016
7085
|
tillLocationId: string | null;
|
|
@@ -7081,7 +7150,7 @@ export interface SetShopPluginAbilitiesData {
|
|
|
7081
7150
|
id: string;
|
|
7082
7151
|
prefix: string;
|
|
7083
7152
|
name: string;
|
|
7084
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
7153
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
7085
7154
|
abilities: Array<'view' | 'till'>;
|
|
7086
7155
|
/** Kasa açıksa şubesi; değilse null */
|
|
7087
7156
|
tillLocationId: string | null;
|
|
@@ -7092,7 +7161,7 @@ export interface SetShopPluginAbilitiesData {
|
|
|
7092
7161
|
} | null;
|
|
7093
7162
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
7094
7163
|
shopName: string | null;
|
|
7095
|
-
/** Ödeme adımındaki kart kodlarının
|
|
7164
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
7096
7165
|
settings: {
|
|
7097
7166
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
7098
7167
|
tax: {
|
|
@@ -7154,7 +7223,7 @@ export interface QuoteCheckoutCodeBody {
|
|
|
7154
7223
|
currency: string;
|
|
7155
7224
|
/** İsteğe bağlı: alışverişçinin kişisel veri taşımayan anahtarı (ör. WooCommerce oturumunun HMAC'i); kendi soru bütçesi olur */
|
|
7156
7225
|
shopper?: string;
|
|
7157
|
-
/** İsteğe bağlı: kodu soran sipariş. Kod bu siparişteyse `CODE_USED` yerine bu siparişin kullanımı döner
|
|
7226
|
+
/** İsteğe bağlı: kodu soran sipariş. Kod bu siparişteyse `CODE_USED` yerine bu siparişin kullanımı döner. */
|
|
7158
7227
|
orderId?: string;
|
|
7159
7228
|
}
|
|
7160
7229
|
/** The `data` of `quoteCheckoutCode`'s answer. */
|
|
@@ -7686,7 +7755,7 @@ export interface RefundShopRedemptionParams {
|
|
|
7686
7755
|
export interface RefundShopRedemptionHeaders {
|
|
7687
7756
|
/** Ekip oturumu birden fazla işletmede koltuk taşıyorsa hangi işletme için olduğu (tek işletmede gerekmez). */
|
|
7688
7757
|
'Rewloy-Merchant'?: string;
|
|
7689
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
7758
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
7690
7759
|
'Idempotency-Key': string;
|
|
7691
7760
|
}
|
|
7692
7761
|
/** Request body of `refundShopRedemption`. */
|
|
@@ -7736,7 +7805,7 @@ export interface RefundShopRedemptionArgs extends RequestOptions {
|
|
|
7736
7805
|
/** The JSON body. */
|
|
7737
7806
|
body: RefundShopRedemptionBody;
|
|
7738
7807
|
/**
|
|
7739
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
7808
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
7740
7809
|
*
|
|
7741
7810
|
* `Idempotency-Key`, required: 8–64 printable ASCII characters. The client never makes one up (a generated key would not survive a restart of your app); it sends this one on every retry of the call.
|
|
7742
7811
|
*/
|
|
@@ -7811,7 +7880,7 @@ export interface SetShopSettingsData {
|
|
|
7811
7880
|
id: string;
|
|
7812
7881
|
prefix: string;
|
|
7813
7882
|
name: string;
|
|
7814
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
7883
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
7815
7884
|
abilities: Array<'view' | 'till'>;
|
|
7816
7885
|
/** Kasa açıksa şubesi; değilse null */
|
|
7817
7886
|
tillLocationId: string | null;
|
|
@@ -7822,7 +7891,7 @@ export interface SetShopSettingsData {
|
|
|
7822
7891
|
} | null;
|
|
7823
7892
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
7824
7893
|
shopName: string | null;
|
|
7825
|
-
/** Ödeme adımındaki kart kodlarının
|
|
7894
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
7826
7895
|
settings: {
|
|
7827
7896
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
7828
7897
|
tax: {
|
|
@@ -7921,7 +7990,7 @@ export interface SetShopCeilingData {
|
|
|
7921
7990
|
id: string;
|
|
7922
7991
|
prefix: string;
|
|
7923
7992
|
name: string;
|
|
7924
|
-
/** Anahtarın bağlantının dışında yapabildikleri
|
|
7993
|
+
/** Anahtarın bağlantının dışında yapabildikleri: `view` Görüntüleme (kartlar, durumları, programın sayıları ve son işlemleri; kişisel veri yok), `till` Kasa (tek bir şubede) */
|
|
7925
7994
|
abilities: Array<'view' | 'till'>;
|
|
7926
7995
|
/** Kasa açıksa şubesi; değilse null */
|
|
7927
7996
|
tillLocationId: string | null;
|
|
@@ -7932,7 +8001,7 @@ export interface SetShopCeilingData {
|
|
|
7932
8001
|
} | null;
|
|
7933
8002
|
/** Mağazanın adı (eklenti bağlanırken gönderdi): kart sahibi bir kodun nerede kullanıldığını bu adla görür. Yoksa null. */
|
|
7934
8003
|
shopName: string | null;
|
|
7935
|
-
/** Ödeme adımındaki kart kodlarının
|
|
8004
|
+
/** Ödeme adımındaki kart kodlarının ayarları. `PATCH /v1/shops/{id}/settings` değiştirir. */
|
|
7936
8005
|
settings: {
|
|
7937
8006
|
/** Kart değerinin siparişe nasıl uygulanacağı; eklenti uygular. Hangisinin doğru olduğu muhasebecinizin kararıdır. */
|
|
7938
8007
|
tax: {
|
|
@@ -8685,7 +8754,7 @@ export interface ListWebhooksItem {
|
|
|
8685
8754
|
pending: number;
|
|
8686
8755
|
};
|
|
8687
8756
|
lastDelivered: string | null;
|
|
8688
|
-
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur
|
|
8757
|
+
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur. */
|
|
8689
8758
|
createdByKey: {
|
|
8690
8759
|
id: string;
|
|
8691
8760
|
name: string;
|
|
@@ -8730,7 +8799,7 @@ export interface CreateWebhookData {
|
|
|
8730
8799
|
pending: number;
|
|
8731
8800
|
};
|
|
8732
8801
|
lastDelivered: string | null;
|
|
8733
|
-
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur
|
|
8802
|
+
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur. */
|
|
8734
8803
|
createdByKey: {
|
|
8735
8804
|
id: string;
|
|
8736
8805
|
name: string;
|
|
@@ -8738,6 +8807,8 @@ export interface CreateWebhookData {
|
|
|
8738
8807
|
};
|
|
8739
8808
|
/** whsec_…; yalnız bu yanıtta */
|
|
8740
8809
|
secret: string;
|
|
8810
|
+
/** Yalnız canlı olmayan bir kurulumda (geliştirme, staging) ve adres canlı ortamda reddedilecekse: neden. Böyle bir kurulum http ve iç ağ adreslerini kabul eder; canlı ortam etmez (`422 BAD_WEBHOOK_URL`). Canlı ortamda bu alan gelmez. */
|
|
8811
|
+
warnings?: string[];
|
|
8741
8812
|
}
|
|
8742
8813
|
/** Arguments of `createWebhook`. */
|
|
8743
8814
|
export interface CreateWebhookArgs extends RequestOptions {
|
|
@@ -8776,7 +8847,7 @@ export interface GetWebhookData {
|
|
|
8776
8847
|
pending: number;
|
|
8777
8848
|
};
|
|
8778
8849
|
lastDelivered: string | null;
|
|
8779
|
-
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur
|
|
8850
|
+
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur. */
|
|
8780
8851
|
createdByKey: {
|
|
8781
8852
|
id: string;
|
|
8782
8853
|
name: string;
|
|
@@ -8823,7 +8894,7 @@ export interface SetWebhookStatusData {
|
|
|
8823
8894
|
pending: number;
|
|
8824
8895
|
};
|
|
8825
8896
|
lastDelivered: string | null;
|
|
8826
|
-
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur
|
|
8897
|
+
/** Webhook'u ekleyen API anahtarı; bir kişi eklediyse null. Anahtar kaldırılınca, süresi dolunca ya da olayları okuyamaz olunca webhook kendiliğinden kapanır (`disabledReason`). Bir kişi onu yeniden açarsa webhook o kişinin olur. */
|
|
8827
8898
|
createdByKey: {
|
|
8828
8899
|
id: string;
|
|
8829
8900
|
name: string;
|
|
@@ -9996,7 +10067,7 @@ export interface HolderAccountData {
|
|
|
9996
10067
|
}[];
|
|
9997
10068
|
/** Oturumu açık cihazlar (`GET /v1/holder/devices`) */
|
|
9998
10069
|
devices: number;
|
|
9999
|
-
/** Bekleyen giriş yolu değişikliği
|
|
10070
|
+
/** Bekleyen giriş yolu değişikliği: hesaba girmenin 72 saatten eski başka bir yolu yokken yapılan değişiklik süre dolana kadar bekler. `byThisDevice` ise kişiye "Vazgeç", değilse "Bu değişikliği ben yapmadım" gösterin; ikisi de `DELETE /v1/holder/changes/{id}`. */
|
|
10000
10071
|
pendingChange: {
|
|
10001
10072
|
id: string;
|
|
10002
10073
|
kind: 'email' | 'phone';
|
|
@@ -10009,7 +10080,7 @@ export interface HolderAccountData {
|
|
|
10009
10080
|
/** Değişikliği bu cihaz istedi */
|
|
10010
10081
|
byThisDevice: boolean;
|
|
10011
10082
|
} | null;
|
|
10012
|
-
/** Bu hesap için onaylanmış ve bekleyen bir kurtarma talebi
|
|
10083
|
+
/** Bu hesap için onaylanmış ve bekleyen bir kurtarma talebi: süre dolunca hesap yeni adrese ya da numaraya taşınır ve bütün oturumlar kapanır. Kişiye "Bu değişikliği ben yapmadım" gösterin: `DELETE /v1/holder/changes/{id}`. */
|
|
10013
10084
|
pendingRecovery: {
|
|
10014
10085
|
id: string;
|
|
10015
10086
|
/** Talebin numarası (K-7Q2M9X) */
|
|
@@ -10103,7 +10174,7 @@ export interface RemoveHolderPasskeyArgs extends RequestOptions {
|
|
|
10103
10174
|
}
|
|
10104
10175
|
/** Header parameters of `addHolderEmail`, as sent on the wire. */
|
|
10105
10176
|
export interface AddHolderEmailHeaders {
|
|
10106
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
10177
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
10107
10178
|
'Idempotency-Key'?: string;
|
|
10108
10179
|
}
|
|
10109
10180
|
/** Request body of `addHolderEmail`. */
|
|
@@ -10120,7 +10191,7 @@ export interface AddHolderEmailArgs extends RequestOptions {
|
|
|
10120
10191
|
/** The JSON body. */
|
|
10121
10192
|
body: AddHolderEmailBody;
|
|
10122
10193
|
/**
|
|
10123
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
10194
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
10124
10195
|
*
|
|
10125
10196
|
* `Idempotency-Key`: 8–64 printable ASCII characters. When omitted, the client generates a UUID and sends the same one on every retry of this call.
|
|
10126
10197
|
*/
|
|
@@ -10145,7 +10216,7 @@ export interface VerifyHolderEmailArgs extends RequestOptions {
|
|
|
10145
10216
|
}
|
|
10146
10217
|
/** Header parameters of `addHolderPhone`, as sent on the wire. */
|
|
10147
10218
|
export interface AddHolderPhoneHeaders {
|
|
10148
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
10219
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
10149
10220
|
'Idempotency-Key'?: string;
|
|
10150
10221
|
}
|
|
10151
10222
|
/** Request body of `addHolderPhone`. */
|
|
@@ -10167,7 +10238,7 @@ export interface AddHolderPhoneArgs extends RequestOptions {
|
|
|
10167
10238
|
/** The JSON body. */
|
|
10168
10239
|
body: AddHolderPhoneBody;
|
|
10169
10240
|
/**
|
|
10170
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
10241
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
10171
10242
|
*
|
|
10172
10243
|
* `Idempotency-Key`: 8–64 printable ASCII characters. When omitted, the client generates a UUID and sends the same one on every retry of this call.
|
|
10173
10244
|
*/
|
|
@@ -10201,7 +10272,7 @@ export interface MergeHolderAccountsData {
|
|
|
10201
10272
|
merged: boolean;
|
|
10202
10273
|
/** Bu oturumun bundan sonraki hesabı */
|
|
10203
10274
|
accountId: string;
|
|
10204
|
-
/** Soruyu bir giriş yolu değişikliği sorduysa (`POST /v1/holder/identities/{id}/replace/verify
|
|
10275
|
+
/** Soruyu bir giriş yolu değişikliği sorduysa (`POST /v1/holder/identities/{id}/replace/verify`): birleşince yapılan değişiklik; `keep` ise ya da soruyu başka bir adım sorduysa `null` */
|
|
10205
10276
|
change: {
|
|
10206
10277
|
/** applied: yenisi eskisinin yerini hemen aldı (hesaba girmenin en az 72 saatlik başka bir yolu vardı); pending: böyle bir yol olmadığı için süre dolana kadar bekliyor */
|
|
10207
10278
|
status: 'applied' | 'pending';
|
|
@@ -10240,7 +10311,7 @@ export interface ReplaceHolderIdentityParams {
|
|
|
10240
10311
|
}
|
|
10241
10312
|
/** Header parameters of `replaceHolderIdentity`, as sent on the wire. */
|
|
10242
10313
|
export interface ReplaceHolderIdentityHeaders {
|
|
10243
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
10314
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
10244
10315
|
'Idempotency-Key'?: string;
|
|
10245
10316
|
}
|
|
10246
10317
|
/** Request body of `replaceHolderIdentity`. */
|
|
@@ -10266,7 +10337,7 @@ export interface ReplaceHolderIdentityArgs extends RequestOptions {
|
|
|
10266
10337
|
/** The JSON body. */
|
|
10267
10338
|
body?: ReplaceHolderIdentityBody;
|
|
10268
10339
|
/**
|
|
10269
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
10340
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
10270
10341
|
*
|
|
10271
10342
|
* `Idempotency-Key`: 8–64 printable ASCII characters. When omitted, the client generates a UUID and sends the same one on every retry of this call.
|
|
10272
10343
|
*/
|
|
@@ -10526,7 +10597,7 @@ export interface HolderConsentsArgs extends RequestOptions {
|
|
|
10526
10597
|
export interface HolderDataData {
|
|
10527
10598
|
generatedAt: string;
|
|
10528
10599
|
controllerNote: string;
|
|
10529
|
-
/** Rewloy Cüzdan hesabı: createdAt, lastSeenAt, flaggedAt (hesap işaretlendiyse ne zaman: bir değişiklik ya da kurtarma talebi "Bu değişikliği ben yapmadım" ile iptal edildi ya da ekip işaretledi
|
|
10600
|
+
/** Rewloy Cüzdan hesabı: createdAt, lastSeenAt, flaggedAt (hesap işaretlendiyse ne zaman: bir değişiklik ya da kurtarma talebi "Bu değişikliği ben yapmadım" ile iptal edildi ya da ekip işaretledi), emails, phones (doğrulanmış numaralar: phone, provenAt, lastProvenAt), passkeys, signIns, devices (her biri keySetAt ve lastRenewedAt ile: cihaz anahtarı, web), cardsAddedByLink, favorites (serial, business, program, position, starredAt), hiddenCards (listeden kaldırılan kartlar: serial, business, program, hiddenAt), identityChanges (giriş yolu değişiklikleri: kind, from ve to — maskeli —, state, requestedAt, dueAt, settledAt), recoveryRequests (hesap için açılan kurtarma talepleri: number, oldIdentifier ve newIdentifier — maskeli —, state, requestedAt, dueAt, appliedAt, cancelledAt), trail; bildirimler açıkken ya da kayıtları dururken notifications (transactionNotifications, devices: cihaz, platform — web, apns ya da fcm —, servis, ne zamandan beri, son kabul; sent: tür, işletme, kart, başlık, metin, zaman, her cihazın platformu ve sonucu; bildirim adresleri, anahtarlar ve belirteçler yazılmaz) */
|
|
10530
10601
|
account: Record<string, unknown>;
|
|
10531
10602
|
addresses: Record<string, unknown>[];
|
|
10532
10603
|
numbers: Record<string, unknown>[];
|
|
@@ -10728,7 +10799,7 @@ export interface TestHolderDevicePushArgs extends RequestOptions {
|
|
|
10728
10799
|
}
|
|
10729
10800
|
/** Header parameters of `startHolderRecovery`, as sent on the wire. */
|
|
10730
10801
|
export interface StartHolderRecoveryHeaders {
|
|
10731
|
-
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. */
|
|
10802
|
+
/** Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil. */
|
|
10732
10803
|
'Idempotency-Key'?: string;
|
|
10733
10804
|
}
|
|
10734
10805
|
/** Request body of `startHolderRecovery`. */
|
|
@@ -10762,7 +10833,7 @@ export interface StartHolderRecoveryArgs extends RequestOptions {
|
|
|
10762
10833
|
/** The JSON body. */
|
|
10763
10834
|
body: StartHolderRecoveryBody;
|
|
10764
10835
|
/**
|
|
10765
|
-
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür.
|
|
10836
|
+
* Aynı işlemin iki kez yapılmasını önler: aynı anahtarla tekrar, ilk sonucu döndürür. 8–64 yazdırılabilir ASCII karakter (ş, ğ, ı gibi harfler `400 VALIDATION`); bu kimlik için tekil.
|
|
10766
10837
|
*
|
|
10767
10838
|
* `Idempotency-Key`: 8–64 printable ASCII characters. When omitted, the client generates a UUID and sends the same one on every retry of this call.
|
|
10768
10839
|
*/
|
|
@@ -10956,6 +11027,24 @@ export interface Operations {
|
|
|
10956
11027
|
500: ErrorBody<'INTERNAL'>;
|
|
10957
11028
|
};
|
|
10958
11029
|
};
|
|
11030
|
+
reverseAction: {
|
|
11031
|
+
args: ReverseActionArgs;
|
|
11032
|
+
result: ReverseActionData;
|
|
11033
|
+
data: ReverseActionData;
|
|
11034
|
+
responses: {
|
|
11035
|
+
200: {
|
|
11036
|
+
data: ReverseActionData;
|
|
11037
|
+
};
|
|
11038
|
+
400: ErrorBody<'VALIDATION' | 'MERCHANT_REQUIRED'>;
|
|
11039
|
+
401: ErrorBody<'UNAUTHENTICATED' | 'INVALID_API_KEY' | 'TOKEN_INVALID' | 'MFA_REQUIRED'>;
|
|
11040
|
+
403: ErrorBody<'FORBIDDEN' | 'PLAN_FEATURE_MISSING' | 'CREDENTIAL_NOT_ALLOWED'>;
|
|
11041
|
+
404: ErrorBody<'PASS_NOT_FOUND' | 'LOCATION_NOT_FOUND' | 'ACTION_NOT_FOUND'>;
|
|
11042
|
+
409: ErrorBody<'ACTION_AMBIGUOUS' | 'ACTION_NOT_REVERSIBLE'>;
|
|
11043
|
+
410: ErrorBody<'TOKEN_INVALID'>;
|
|
11044
|
+
429: ErrorBody<'RATE_LIMITED'>;
|
|
11045
|
+
500: ErrorBody<'INTERNAL'>;
|
|
11046
|
+
};
|
|
11047
|
+
};
|
|
10959
11048
|
publicProgram: {
|
|
10960
11049
|
args: PublicProgramArgs;
|
|
10961
11050
|
result: PublicProgramData;
|