@peable.to/contracts 6.2.0 → 6.3.0
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/dist/cjs/resources/connect/reporting.js +250 -2
- package/dist/cjs/vocabulary/errors.js +1 -0
- package/dist/cjs/vocabulary/reporting.js +28 -1
- package/dist/esm/resources/connect/reporting.js +251 -3
- package/dist/esm/vocabulary/errors.js +1 -0
- package/dist/esm/vocabulary/reporting.js +27 -0
- package/dist/types/resources/connect/index.d.ts +671 -0
- package/dist/types/resources/connect/reporting.d.ts +894 -0
- package/dist/types/vocabulary/errors.d.ts +1 -0
- package/dist/types/vocabulary/reporting.d.ts +23 -0
- package/package.json +1 -1
|
@@ -85,12 +85,103 @@ export declare const reportRunSchema: z.ZodObject<{
|
|
|
85
85
|
error: z.ZodNullable<z.ZodString>;
|
|
86
86
|
result: z.ZodNullable<z.ZodType<import("../..").Ref<"file">, import("../..").Ref<"file">, z.core.$ZodTypeInternals<import("../..").Ref<"file">, import("../..").Ref<"file">>>>;
|
|
87
87
|
succeeded_at: z.ZodNullable<z.ZodNumber>;
|
|
88
|
+
report_schedule: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">>>>;
|
|
88
89
|
}, z.core.$strict>;
|
|
89
90
|
export type ReportRun = Expand<z.output<typeof reportRunSchema>>;
|
|
91
|
+
/** When a schedule fires (Stripe's payout-schedule spelling). */
|
|
92
|
+
export declare const reportScheduleCadenceSchema: z.ZodObject<{
|
|
93
|
+
interval: z.ZodEnum<{
|
|
94
|
+
monthly: "monthly";
|
|
95
|
+
daily: "daily";
|
|
96
|
+
weekly: "weekly";
|
|
97
|
+
}>;
|
|
98
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
99
|
+
monday: "monday";
|
|
100
|
+
tuesday: "tuesday";
|
|
101
|
+
wednesday: "wednesday";
|
|
102
|
+
thursday: "thursday";
|
|
103
|
+
friday: "friday";
|
|
104
|
+
saturday: "saturday";
|
|
105
|
+
sunday: "sunday";
|
|
106
|
+
}>>;
|
|
107
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
108
|
+
}, z.core.$strict>;
|
|
109
|
+
/**
|
|
110
|
+
* `reporting.report_schedule` (`frs_…`): a report run on a cadence. Each
|
|
111
|
+
* occurrence is local midnight in `timezone`; it creates an ordinary report
|
|
112
|
+
* run over the time since the previous occurrence, and emails `recipients` a
|
|
113
|
+
* link to it in Orbit once it succeeded (or failed). The CSV is never attached
|
|
114
|
+
* and never public: a recipient signs in to Orbit to download it.
|
|
115
|
+
*/
|
|
116
|
+
export declare const reportScheduleSchema: z.ZodObject<{
|
|
117
|
+
id: z.ZodString;
|
|
118
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
119
|
+
livemode: z.ZodBoolean;
|
|
120
|
+
created: z.ZodNumber;
|
|
121
|
+
report_type: z.ZodEnum<{
|
|
122
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
123
|
+
"balance.summary.1": "balance.summary.1";
|
|
124
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
125
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
126
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
127
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
128
|
+
}>;
|
|
129
|
+
parameters: z.ZodObject<{
|
|
130
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
131
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
132
|
+
FAIR: "FAIR";
|
|
133
|
+
EUR: "EUR";
|
|
134
|
+
USD: "USD";
|
|
135
|
+
GBP: "GBP";
|
|
136
|
+
CHF: "CHF";
|
|
137
|
+
SEK: "SEK";
|
|
138
|
+
NOK: "NOK";
|
|
139
|
+
DKK: "DKK";
|
|
140
|
+
PLN: "PLN";
|
|
141
|
+
CZK: "CZK";
|
|
142
|
+
CAD: "CAD";
|
|
143
|
+
AUD: "AUD";
|
|
144
|
+
JPY: "JPY";
|
|
145
|
+
}>>;
|
|
146
|
+
}, z.core.$strict>;
|
|
147
|
+
schedule: z.ZodObject<{
|
|
148
|
+
interval: z.ZodEnum<{
|
|
149
|
+
monthly: "monthly";
|
|
150
|
+
daily: "daily";
|
|
151
|
+
weekly: "weekly";
|
|
152
|
+
}>;
|
|
153
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
154
|
+
monday: "monday";
|
|
155
|
+
tuesday: "tuesday";
|
|
156
|
+
wednesday: "wednesday";
|
|
157
|
+
thursday: "thursday";
|
|
158
|
+
friday: "friday";
|
|
159
|
+
saturday: "saturday";
|
|
160
|
+
sunday: "sunday";
|
|
161
|
+
}>>;
|
|
162
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
163
|
+
}, z.core.$strict>;
|
|
164
|
+
timezone: z.ZodString;
|
|
165
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
166
|
+
locale: z.ZodEnum<{
|
|
167
|
+
en: "en";
|
|
168
|
+
es: "es";
|
|
169
|
+
}>;
|
|
170
|
+
status: z.ZodEnum<{
|
|
171
|
+
active: "active";
|
|
172
|
+
canceled: "canceled";
|
|
173
|
+
paused: "paused";
|
|
174
|
+
}>;
|
|
175
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
176
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
177
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
178
|
+
}, z.core.$strict>;
|
|
179
|
+
export type ReportSchedule = Expand<z.output<typeof reportScheduleSchema>>;
|
|
90
180
|
declare module '../../common/objects' {
|
|
91
181
|
interface ObjectMap {
|
|
92
182
|
'reporting.report_type': ReportType;
|
|
93
183
|
'reporting.report_run': ReportRun;
|
|
184
|
+
'reporting.report_schedule': ReportSchedule;
|
|
94
185
|
}
|
|
95
186
|
}
|
|
96
187
|
/** `POST /v1/reporting/report_runs`. */
|
|
@@ -149,8 +240,140 @@ export declare const listReportRunsQuery: z.ZodObject<{
|
|
|
149
240
|
"refunds.itemized.1": "refunds.itemized.1";
|
|
150
241
|
"disputes.itemized.1": "disputes.itemized.1";
|
|
151
242
|
}>>;
|
|
243
|
+
report_schedule: z.ZodOptional<z.ZodString>;
|
|
152
244
|
}, z.core.$strict>;
|
|
153
245
|
export type ListReportRunsParams = z.input<typeof listReportRunsQuery>;
|
|
246
|
+
/** `POST /v1/reporting/report_schedules`. */
|
|
247
|
+
export declare const createReportScheduleParams: z.ZodObject<{
|
|
248
|
+
report_type: z.ZodEnum<{
|
|
249
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
250
|
+
"balance.summary.1": "balance.summary.1";
|
|
251
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
252
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
253
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
254
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
255
|
+
}>;
|
|
256
|
+
parameters: z.ZodOptional<z.ZodObject<{
|
|
257
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
258
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
259
|
+
FAIR: "FAIR";
|
|
260
|
+
EUR: "EUR";
|
|
261
|
+
USD: "USD";
|
|
262
|
+
GBP: "GBP";
|
|
263
|
+
CHF: "CHF";
|
|
264
|
+
SEK: "SEK";
|
|
265
|
+
NOK: "NOK";
|
|
266
|
+
DKK: "DKK";
|
|
267
|
+
PLN: "PLN";
|
|
268
|
+
CZK: "CZK";
|
|
269
|
+
CAD: "CAD";
|
|
270
|
+
AUD: "AUD";
|
|
271
|
+
JPY: "JPY";
|
|
272
|
+
}>>;
|
|
273
|
+
}, z.core.$strict>>;
|
|
274
|
+
schedule: z.ZodObject<{
|
|
275
|
+
interval: z.ZodEnum<{
|
|
276
|
+
monthly: "monthly";
|
|
277
|
+
daily: "daily";
|
|
278
|
+
weekly: "weekly";
|
|
279
|
+
}>;
|
|
280
|
+
weekly_anchor: z.ZodOptional<z.ZodEnum<{
|
|
281
|
+
monday: "monday";
|
|
282
|
+
tuesday: "tuesday";
|
|
283
|
+
wednesday: "wednesday";
|
|
284
|
+
thursday: "thursday";
|
|
285
|
+
friday: "friday";
|
|
286
|
+
saturday: "saturday";
|
|
287
|
+
sunday: "sunday";
|
|
288
|
+
}>>;
|
|
289
|
+
monthly_anchor: z.ZodOptional<z.ZodNumber>;
|
|
290
|
+
}, z.core.$strict>;
|
|
291
|
+
timezone: z.ZodOptional<z.ZodString>;
|
|
292
|
+
recipients: z.ZodOptional<z.ZodArray<z.ZodEmail>>;
|
|
293
|
+
locale: z.ZodOptional<z.ZodEnum<{
|
|
294
|
+
en: "en";
|
|
295
|
+
es: "es";
|
|
296
|
+
}>>;
|
|
297
|
+
}, z.core.$strict>;
|
|
298
|
+
export type CreateReportScheduleParams = z.input<typeof createReportScheduleParams>;
|
|
299
|
+
/** `POST /v1/reporting/report_schedules/{id}`: each field sent replaces the stored one. */
|
|
300
|
+
export declare const updateReportScheduleParams: z.ZodObject<{
|
|
301
|
+
report_type: z.ZodOptional<z.ZodEnum<{
|
|
302
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
303
|
+
"balance.summary.1": "balance.summary.1";
|
|
304
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
305
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
306
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
307
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
308
|
+
}>>;
|
|
309
|
+
parameters: z.ZodOptional<z.ZodObject<{
|
|
310
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
311
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
312
|
+
FAIR: "FAIR";
|
|
313
|
+
EUR: "EUR";
|
|
314
|
+
USD: "USD";
|
|
315
|
+
GBP: "GBP";
|
|
316
|
+
CHF: "CHF";
|
|
317
|
+
SEK: "SEK";
|
|
318
|
+
NOK: "NOK";
|
|
319
|
+
DKK: "DKK";
|
|
320
|
+
PLN: "PLN";
|
|
321
|
+
CZK: "CZK";
|
|
322
|
+
CAD: "CAD";
|
|
323
|
+
AUD: "AUD";
|
|
324
|
+
JPY: "JPY";
|
|
325
|
+
}>>;
|
|
326
|
+
}, z.core.$strict>>;
|
|
327
|
+
schedule: z.ZodOptional<z.ZodObject<{
|
|
328
|
+
interval: z.ZodEnum<{
|
|
329
|
+
monthly: "monthly";
|
|
330
|
+
daily: "daily";
|
|
331
|
+
weekly: "weekly";
|
|
332
|
+
}>;
|
|
333
|
+
weekly_anchor: z.ZodOptional<z.ZodEnum<{
|
|
334
|
+
monday: "monday";
|
|
335
|
+
tuesday: "tuesday";
|
|
336
|
+
wednesday: "wednesday";
|
|
337
|
+
thursday: "thursday";
|
|
338
|
+
friday: "friday";
|
|
339
|
+
saturday: "saturday";
|
|
340
|
+
sunday: "sunday";
|
|
341
|
+
}>>;
|
|
342
|
+
monthly_anchor: z.ZodOptional<z.ZodNumber>;
|
|
343
|
+
}, z.core.$strict>>;
|
|
344
|
+
timezone: z.ZodOptional<z.ZodString>;
|
|
345
|
+
recipients: z.ZodOptional<z.ZodArray<z.ZodEmail>>;
|
|
346
|
+
locale: z.ZodOptional<z.ZodEnum<{
|
|
347
|
+
en: "en";
|
|
348
|
+
es: "es";
|
|
349
|
+
}>>;
|
|
350
|
+
}, z.core.$strict>;
|
|
351
|
+
export type UpdateReportScheduleParams = z.input<typeof updateReportScheduleParams>;
|
|
352
|
+
/** Pause, resume and cancel take no parameters. */
|
|
353
|
+
export declare const reportScheduleActionParams: z.ZodObject<{}, z.core.$strict>;
|
|
354
|
+
export declare const listReportSchedulesQuery: z.ZodObject<{
|
|
355
|
+
limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
|
|
356
|
+
starting_after: z.ZodOptional<z.ZodString>;
|
|
357
|
+
ending_before: z.ZodOptional<z.ZodString>;
|
|
358
|
+
created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
|
|
359
|
+
gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
360
|
+
gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
361
|
+
lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
362
|
+
lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
363
|
+
}, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
|
|
364
|
+
gt?: number | undefined;
|
|
365
|
+
gte?: number | undefined;
|
|
366
|
+
lt?: number | undefined;
|
|
367
|
+
lte?: number | undefined;
|
|
368
|
+
}>>]>>;
|
|
369
|
+
expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
|
|
370
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
371
|
+
active: "active";
|
|
372
|
+
canceled: "canceled";
|
|
373
|
+
paused: "paused";
|
|
374
|
+
}>>;
|
|
375
|
+
}, z.core.$strict>;
|
|
376
|
+
export type ListReportSchedulesParams = z.input<typeof listReportSchedulesQuery>;
|
|
154
377
|
/**
|
|
155
378
|
* A download's query: a run's `parameters`, spelled as a query string
|
|
156
379
|
* (`columns[]=a&columns[]=b`, or one `columns=a`).
|
|
@@ -361,6 +584,7 @@ export declare const reportingRoutes: readonly [{
|
|
|
361
584
|
error: z.ZodNullable<z.ZodString>;
|
|
362
585
|
result: z.ZodNullable<z.ZodType<import("../..").Ref<"file">, import("../..").Ref<"file">, z.core.$ZodTypeInternals<import("../..").Ref<"file">, import("../..").Ref<"file">>>>;
|
|
363
586
|
succeeded_at: z.ZodNullable<z.ZodNumber>;
|
|
587
|
+
report_schedule: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">>>>;
|
|
364
588
|
}, z.core.$strict>;
|
|
365
589
|
readonly sdk: "reporting.reportRuns.create";
|
|
366
590
|
}, {
|
|
@@ -395,6 +619,7 @@ export declare const reportingRoutes: readonly [{
|
|
|
395
619
|
"refunds.itemized.1": "refunds.itemized.1";
|
|
396
620
|
"disputes.itemized.1": "disputes.itemized.1";
|
|
397
621
|
}>>;
|
|
622
|
+
report_schedule: z.ZodOptional<z.ZodString>;
|
|
398
623
|
}, z.core.$strict>;
|
|
399
624
|
readonly response: z.ZodObject<{
|
|
400
625
|
object: z.ZodLiteral<"list">;
|
|
@@ -439,6 +664,7 @@ export declare const reportingRoutes: readonly [{
|
|
|
439
664
|
error: z.ZodNullable<z.ZodString>;
|
|
440
665
|
result: z.ZodNullable<z.ZodType<import("../..").Ref<"file">, import("../..").Ref<"file">, z.core.$ZodTypeInternals<import("../..").Ref<"file">, import("../..").Ref<"file">>>>;
|
|
441
666
|
succeeded_at: z.ZodNullable<z.ZodNumber>;
|
|
667
|
+
report_schedule: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">>>>;
|
|
442
668
|
}, z.core.$strict>>;
|
|
443
669
|
has_more: z.ZodBoolean;
|
|
444
670
|
url: z.ZodString;
|
|
@@ -500,7 +726,675 @@ export declare const reportingRoutes: readonly [{
|
|
|
500
726
|
error: z.ZodNullable<z.ZodString>;
|
|
501
727
|
result: z.ZodNullable<z.ZodType<import("../..").Ref<"file">, import("../..").Ref<"file">, z.core.$ZodTypeInternals<import("../..").Ref<"file">, import("../..").Ref<"file">>>>;
|
|
502
728
|
succeeded_at: z.ZodNullable<z.ZodNumber>;
|
|
729
|
+
report_schedule: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_schedule">, string | import("../..").Ref<"reporting.report_schedule">>>>;
|
|
503
730
|
}, z.core.$strict>;
|
|
504
731
|
readonly sdk: "reporting.reportRuns.retrieve";
|
|
505
732
|
readonly expandable: "reporting.report_run";
|
|
733
|
+
}, {
|
|
734
|
+
readonly operationId: "createReportSchedule";
|
|
735
|
+
readonly method: "post";
|
|
736
|
+
readonly path: "/v1/reporting/report_schedules";
|
|
737
|
+
readonly tag: "Reporting";
|
|
738
|
+
readonly summary: "Create a report schedule";
|
|
739
|
+
readonly description: "A report run at local midnight in `timezone` every day, week or month, each over the time since the previous occurrence. `next_run_at` is the first occurrence after now; nothing is backfilled.";
|
|
740
|
+
readonly auth: "service";
|
|
741
|
+
readonly scope: "payments:write";
|
|
742
|
+
readonly idempotent: true;
|
|
743
|
+
readonly body: z.ZodObject<{
|
|
744
|
+
report_type: z.ZodEnum<{
|
|
745
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
746
|
+
"balance.summary.1": "balance.summary.1";
|
|
747
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
748
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
749
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
750
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
751
|
+
}>;
|
|
752
|
+
parameters: z.ZodOptional<z.ZodObject<{
|
|
753
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
754
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
755
|
+
FAIR: "FAIR";
|
|
756
|
+
EUR: "EUR";
|
|
757
|
+
USD: "USD";
|
|
758
|
+
GBP: "GBP";
|
|
759
|
+
CHF: "CHF";
|
|
760
|
+
SEK: "SEK";
|
|
761
|
+
NOK: "NOK";
|
|
762
|
+
DKK: "DKK";
|
|
763
|
+
PLN: "PLN";
|
|
764
|
+
CZK: "CZK";
|
|
765
|
+
CAD: "CAD";
|
|
766
|
+
AUD: "AUD";
|
|
767
|
+
JPY: "JPY";
|
|
768
|
+
}>>;
|
|
769
|
+
}, z.core.$strict>>;
|
|
770
|
+
schedule: z.ZodObject<{
|
|
771
|
+
interval: z.ZodEnum<{
|
|
772
|
+
monthly: "monthly";
|
|
773
|
+
daily: "daily";
|
|
774
|
+
weekly: "weekly";
|
|
775
|
+
}>;
|
|
776
|
+
weekly_anchor: z.ZodOptional<z.ZodEnum<{
|
|
777
|
+
monday: "monday";
|
|
778
|
+
tuesday: "tuesday";
|
|
779
|
+
wednesday: "wednesday";
|
|
780
|
+
thursday: "thursday";
|
|
781
|
+
friday: "friday";
|
|
782
|
+
saturday: "saturday";
|
|
783
|
+
sunday: "sunday";
|
|
784
|
+
}>>;
|
|
785
|
+
monthly_anchor: z.ZodOptional<z.ZodNumber>;
|
|
786
|
+
}, z.core.$strict>;
|
|
787
|
+
timezone: z.ZodOptional<z.ZodString>;
|
|
788
|
+
recipients: z.ZodOptional<z.ZodArray<z.ZodEmail>>;
|
|
789
|
+
locale: z.ZodOptional<z.ZodEnum<{
|
|
790
|
+
en: "en";
|
|
791
|
+
es: "es";
|
|
792
|
+
}>>;
|
|
793
|
+
}, z.core.$strict>;
|
|
794
|
+
readonly response: z.ZodObject<{
|
|
795
|
+
id: z.ZodString;
|
|
796
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
797
|
+
livemode: z.ZodBoolean;
|
|
798
|
+
created: z.ZodNumber;
|
|
799
|
+
report_type: z.ZodEnum<{
|
|
800
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
801
|
+
"balance.summary.1": "balance.summary.1";
|
|
802
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
803
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
804
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
805
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
806
|
+
}>;
|
|
807
|
+
parameters: z.ZodObject<{
|
|
808
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
809
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
810
|
+
FAIR: "FAIR";
|
|
811
|
+
EUR: "EUR";
|
|
812
|
+
USD: "USD";
|
|
813
|
+
GBP: "GBP";
|
|
814
|
+
CHF: "CHF";
|
|
815
|
+
SEK: "SEK";
|
|
816
|
+
NOK: "NOK";
|
|
817
|
+
DKK: "DKK";
|
|
818
|
+
PLN: "PLN";
|
|
819
|
+
CZK: "CZK";
|
|
820
|
+
CAD: "CAD";
|
|
821
|
+
AUD: "AUD";
|
|
822
|
+
JPY: "JPY";
|
|
823
|
+
}>>;
|
|
824
|
+
}, z.core.$strict>;
|
|
825
|
+
schedule: z.ZodObject<{
|
|
826
|
+
interval: z.ZodEnum<{
|
|
827
|
+
monthly: "monthly";
|
|
828
|
+
daily: "daily";
|
|
829
|
+
weekly: "weekly";
|
|
830
|
+
}>;
|
|
831
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
832
|
+
monday: "monday";
|
|
833
|
+
tuesday: "tuesday";
|
|
834
|
+
wednesday: "wednesday";
|
|
835
|
+
thursday: "thursday";
|
|
836
|
+
friday: "friday";
|
|
837
|
+
saturday: "saturday";
|
|
838
|
+
sunday: "sunday";
|
|
839
|
+
}>>;
|
|
840
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
841
|
+
}, z.core.$strict>;
|
|
842
|
+
timezone: z.ZodString;
|
|
843
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
844
|
+
locale: z.ZodEnum<{
|
|
845
|
+
en: "en";
|
|
846
|
+
es: "es";
|
|
847
|
+
}>;
|
|
848
|
+
status: z.ZodEnum<{
|
|
849
|
+
active: "active";
|
|
850
|
+
canceled: "canceled";
|
|
851
|
+
paused: "paused";
|
|
852
|
+
}>;
|
|
853
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
854
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
855
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
856
|
+
}, z.core.$strict>;
|
|
857
|
+
readonly sdk: "reporting.reportSchedules.create";
|
|
858
|
+
}, {
|
|
859
|
+
readonly operationId: "listReportSchedules";
|
|
860
|
+
readonly method: "get";
|
|
861
|
+
readonly path: "/v1/reporting/report_schedules";
|
|
862
|
+
readonly tag: "Reporting";
|
|
863
|
+
readonly summary: "List report schedules";
|
|
864
|
+
readonly description: "Newest first; a canceled schedule is listed too.";
|
|
865
|
+
readonly auth: "service";
|
|
866
|
+
readonly scope: "payments:read";
|
|
867
|
+
readonly query: z.ZodObject<{
|
|
868
|
+
limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
|
|
869
|
+
starting_after: z.ZodOptional<z.ZodString>;
|
|
870
|
+
ending_before: z.ZodOptional<z.ZodString>;
|
|
871
|
+
created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
|
|
872
|
+
gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
873
|
+
gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
874
|
+
lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
875
|
+
lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
876
|
+
}, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
|
|
877
|
+
gt?: number | undefined;
|
|
878
|
+
gte?: number | undefined;
|
|
879
|
+
lt?: number | undefined;
|
|
880
|
+
lte?: number | undefined;
|
|
881
|
+
}>>]>>;
|
|
882
|
+
expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
|
|
883
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
884
|
+
active: "active";
|
|
885
|
+
canceled: "canceled";
|
|
886
|
+
paused: "paused";
|
|
887
|
+
}>>;
|
|
888
|
+
}, z.core.$strict>;
|
|
889
|
+
readonly response: z.ZodObject<{
|
|
890
|
+
object: z.ZodLiteral<"list">;
|
|
891
|
+
data: z.ZodArray<z.ZodObject<{
|
|
892
|
+
id: z.ZodString;
|
|
893
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
894
|
+
livemode: z.ZodBoolean;
|
|
895
|
+
created: z.ZodNumber;
|
|
896
|
+
report_type: z.ZodEnum<{
|
|
897
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
898
|
+
"balance.summary.1": "balance.summary.1";
|
|
899
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
900
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
901
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
902
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
903
|
+
}>;
|
|
904
|
+
parameters: z.ZodObject<{
|
|
905
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
906
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
907
|
+
FAIR: "FAIR";
|
|
908
|
+
EUR: "EUR";
|
|
909
|
+
USD: "USD";
|
|
910
|
+
GBP: "GBP";
|
|
911
|
+
CHF: "CHF";
|
|
912
|
+
SEK: "SEK";
|
|
913
|
+
NOK: "NOK";
|
|
914
|
+
DKK: "DKK";
|
|
915
|
+
PLN: "PLN";
|
|
916
|
+
CZK: "CZK";
|
|
917
|
+
CAD: "CAD";
|
|
918
|
+
AUD: "AUD";
|
|
919
|
+
JPY: "JPY";
|
|
920
|
+
}>>;
|
|
921
|
+
}, z.core.$strict>;
|
|
922
|
+
schedule: z.ZodObject<{
|
|
923
|
+
interval: z.ZodEnum<{
|
|
924
|
+
monthly: "monthly";
|
|
925
|
+
daily: "daily";
|
|
926
|
+
weekly: "weekly";
|
|
927
|
+
}>;
|
|
928
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
929
|
+
monday: "monday";
|
|
930
|
+
tuesday: "tuesday";
|
|
931
|
+
wednesday: "wednesday";
|
|
932
|
+
thursday: "thursday";
|
|
933
|
+
friday: "friday";
|
|
934
|
+
saturday: "saturday";
|
|
935
|
+
sunday: "sunday";
|
|
936
|
+
}>>;
|
|
937
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
938
|
+
}, z.core.$strict>;
|
|
939
|
+
timezone: z.ZodString;
|
|
940
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
941
|
+
locale: z.ZodEnum<{
|
|
942
|
+
en: "en";
|
|
943
|
+
es: "es";
|
|
944
|
+
}>;
|
|
945
|
+
status: z.ZodEnum<{
|
|
946
|
+
active: "active";
|
|
947
|
+
canceled: "canceled";
|
|
948
|
+
paused: "paused";
|
|
949
|
+
}>;
|
|
950
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
951
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
952
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
953
|
+
}, z.core.$strict>>;
|
|
954
|
+
has_more: z.ZodBoolean;
|
|
955
|
+
url: z.ZodString;
|
|
956
|
+
}, z.core.$strict>;
|
|
957
|
+
readonly sdk: "reporting.reportSchedules.list";
|
|
958
|
+
readonly expandable: "reporting.report_schedule";
|
|
959
|
+
}, {
|
|
960
|
+
readonly operationId: "retrieveReportSchedule";
|
|
961
|
+
readonly method: "get";
|
|
962
|
+
readonly path: "/v1/reporting/report_schedules/{id}";
|
|
963
|
+
readonly tag: "Reporting";
|
|
964
|
+
readonly summary: "Retrieve a report schedule";
|
|
965
|
+
readonly auth: "service";
|
|
966
|
+
readonly scope: "payments:read";
|
|
967
|
+
readonly params: {
|
|
968
|
+
readonly id: "The report schedule (`frs_…`).";
|
|
969
|
+
};
|
|
970
|
+
readonly query: z.ZodObject<{
|
|
971
|
+
expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
|
|
972
|
+
}, z.core.$strict>;
|
|
973
|
+
readonly response: z.ZodObject<{
|
|
974
|
+
id: z.ZodString;
|
|
975
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
976
|
+
livemode: z.ZodBoolean;
|
|
977
|
+
created: z.ZodNumber;
|
|
978
|
+
report_type: z.ZodEnum<{
|
|
979
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
980
|
+
"balance.summary.1": "balance.summary.1";
|
|
981
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
982
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
983
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
984
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
985
|
+
}>;
|
|
986
|
+
parameters: z.ZodObject<{
|
|
987
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
988
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
989
|
+
FAIR: "FAIR";
|
|
990
|
+
EUR: "EUR";
|
|
991
|
+
USD: "USD";
|
|
992
|
+
GBP: "GBP";
|
|
993
|
+
CHF: "CHF";
|
|
994
|
+
SEK: "SEK";
|
|
995
|
+
NOK: "NOK";
|
|
996
|
+
DKK: "DKK";
|
|
997
|
+
PLN: "PLN";
|
|
998
|
+
CZK: "CZK";
|
|
999
|
+
CAD: "CAD";
|
|
1000
|
+
AUD: "AUD";
|
|
1001
|
+
JPY: "JPY";
|
|
1002
|
+
}>>;
|
|
1003
|
+
}, z.core.$strict>;
|
|
1004
|
+
schedule: z.ZodObject<{
|
|
1005
|
+
interval: z.ZodEnum<{
|
|
1006
|
+
monthly: "monthly";
|
|
1007
|
+
daily: "daily";
|
|
1008
|
+
weekly: "weekly";
|
|
1009
|
+
}>;
|
|
1010
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
1011
|
+
monday: "monday";
|
|
1012
|
+
tuesday: "tuesday";
|
|
1013
|
+
wednesday: "wednesday";
|
|
1014
|
+
thursday: "thursday";
|
|
1015
|
+
friday: "friday";
|
|
1016
|
+
saturday: "saturday";
|
|
1017
|
+
sunday: "sunday";
|
|
1018
|
+
}>>;
|
|
1019
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
1020
|
+
}, z.core.$strict>;
|
|
1021
|
+
timezone: z.ZodString;
|
|
1022
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
1023
|
+
locale: z.ZodEnum<{
|
|
1024
|
+
en: "en";
|
|
1025
|
+
es: "es";
|
|
1026
|
+
}>;
|
|
1027
|
+
status: z.ZodEnum<{
|
|
1028
|
+
active: "active";
|
|
1029
|
+
canceled: "canceled";
|
|
1030
|
+
paused: "paused";
|
|
1031
|
+
}>;
|
|
1032
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
1033
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
1034
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
1035
|
+
}, z.core.$strict>;
|
|
1036
|
+
readonly sdk: "reporting.reportSchedules.retrieve";
|
|
1037
|
+
readonly expandable: "reporting.report_schedule";
|
|
1038
|
+
}, {
|
|
1039
|
+
readonly operationId: "updateReportSchedule";
|
|
1040
|
+
readonly method: "post";
|
|
1041
|
+
readonly path: "/v1/reporting/report_schedules/{id}";
|
|
1042
|
+
readonly tag: "Reporting";
|
|
1043
|
+
readonly summary: "Update a report schedule";
|
|
1044
|
+
readonly description: "A new `schedule` or `timezone` moves an active schedule to its first occurrence after now. A canceled schedule cannot change (409 `report_schedule_unexpected_state`).";
|
|
1045
|
+
readonly auth: "service";
|
|
1046
|
+
readonly scope: "payments:write";
|
|
1047
|
+
readonly idempotent: true;
|
|
1048
|
+
readonly params: {
|
|
1049
|
+
readonly id: "The report schedule (`frs_…`).";
|
|
1050
|
+
};
|
|
1051
|
+
readonly body: z.ZodObject<{
|
|
1052
|
+
report_type: z.ZodOptional<z.ZodEnum<{
|
|
1053
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
1054
|
+
"balance.summary.1": "balance.summary.1";
|
|
1055
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
1056
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
1057
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
1058
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
1059
|
+
}>>;
|
|
1060
|
+
parameters: z.ZodOptional<z.ZodObject<{
|
|
1061
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1062
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
1063
|
+
FAIR: "FAIR";
|
|
1064
|
+
EUR: "EUR";
|
|
1065
|
+
USD: "USD";
|
|
1066
|
+
GBP: "GBP";
|
|
1067
|
+
CHF: "CHF";
|
|
1068
|
+
SEK: "SEK";
|
|
1069
|
+
NOK: "NOK";
|
|
1070
|
+
DKK: "DKK";
|
|
1071
|
+
PLN: "PLN";
|
|
1072
|
+
CZK: "CZK";
|
|
1073
|
+
CAD: "CAD";
|
|
1074
|
+
AUD: "AUD";
|
|
1075
|
+
JPY: "JPY";
|
|
1076
|
+
}>>;
|
|
1077
|
+
}, z.core.$strict>>;
|
|
1078
|
+
schedule: z.ZodOptional<z.ZodObject<{
|
|
1079
|
+
interval: z.ZodEnum<{
|
|
1080
|
+
monthly: "monthly";
|
|
1081
|
+
daily: "daily";
|
|
1082
|
+
weekly: "weekly";
|
|
1083
|
+
}>;
|
|
1084
|
+
weekly_anchor: z.ZodOptional<z.ZodEnum<{
|
|
1085
|
+
monday: "monday";
|
|
1086
|
+
tuesday: "tuesday";
|
|
1087
|
+
wednesday: "wednesday";
|
|
1088
|
+
thursday: "thursday";
|
|
1089
|
+
friday: "friday";
|
|
1090
|
+
saturday: "saturday";
|
|
1091
|
+
sunday: "sunday";
|
|
1092
|
+
}>>;
|
|
1093
|
+
monthly_anchor: z.ZodOptional<z.ZodNumber>;
|
|
1094
|
+
}, z.core.$strict>>;
|
|
1095
|
+
timezone: z.ZodOptional<z.ZodString>;
|
|
1096
|
+
recipients: z.ZodOptional<z.ZodArray<z.ZodEmail>>;
|
|
1097
|
+
locale: z.ZodOptional<z.ZodEnum<{
|
|
1098
|
+
en: "en";
|
|
1099
|
+
es: "es";
|
|
1100
|
+
}>>;
|
|
1101
|
+
}, z.core.$strict>;
|
|
1102
|
+
readonly response: z.ZodObject<{
|
|
1103
|
+
id: z.ZodString;
|
|
1104
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
1105
|
+
livemode: z.ZodBoolean;
|
|
1106
|
+
created: z.ZodNumber;
|
|
1107
|
+
report_type: z.ZodEnum<{
|
|
1108
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
1109
|
+
"balance.summary.1": "balance.summary.1";
|
|
1110
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
1111
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
1112
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
1113
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
1114
|
+
}>;
|
|
1115
|
+
parameters: z.ZodObject<{
|
|
1116
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1117
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
1118
|
+
FAIR: "FAIR";
|
|
1119
|
+
EUR: "EUR";
|
|
1120
|
+
USD: "USD";
|
|
1121
|
+
GBP: "GBP";
|
|
1122
|
+
CHF: "CHF";
|
|
1123
|
+
SEK: "SEK";
|
|
1124
|
+
NOK: "NOK";
|
|
1125
|
+
DKK: "DKK";
|
|
1126
|
+
PLN: "PLN";
|
|
1127
|
+
CZK: "CZK";
|
|
1128
|
+
CAD: "CAD";
|
|
1129
|
+
AUD: "AUD";
|
|
1130
|
+
JPY: "JPY";
|
|
1131
|
+
}>>;
|
|
1132
|
+
}, z.core.$strict>;
|
|
1133
|
+
schedule: z.ZodObject<{
|
|
1134
|
+
interval: z.ZodEnum<{
|
|
1135
|
+
monthly: "monthly";
|
|
1136
|
+
daily: "daily";
|
|
1137
|
+
weekly: "weekly";
|
|
1138
|
+
}>;
|
|
1139
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
1140
|
+
monday: "monday";
|
|
1141
|
+
tuesday: "tuesday";
|
|
1142
|
+
wednesday: "wednesday";
|
|
1143
|
+
thursday: "thursday";
|
|
1144
|
+
friday: "friday";
|
|
1145
|
+
saturday: "saturday";
|
|
1146
|
+
sunday: "sunday";
|
|
1147
|
+
}>>;
|
|
1148
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
1149
|
+
}, z.core.$strict>;
|
|
1150
|
+
timezone: z.ZodString;
|
|
1151
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
1152
|
+
locale: z.ZodEnum<{
|
|
1153
|
+
en: "en";
|
|
1154
|
+
es: "es";
|
|
1155
|
+
}>;
|
|
1156
|
+
status: z.ZodEnum<{
|
|
1157
|
+
active: "active";
|
|
1158
|
+
canceled: "canceled";
|
|
1159
|
+
paused: "paused";
|
|
1160
|
+
}>;
|
|
1161
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
1162
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
1163
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
1164
|
+
}, z.core.$strict>;
|
|
1165
|
+
readonly sdk: "reporting.reportSchedules.update";
|
|
1166
|
+
}, {
|
|
1167
|
+
readonly operationId: "pauseReportSchedule";
|
|
1168
|
+
readonly method: "post";
|
|
1169
|
+
readonly path: "/v1/reporting/report_schedules/{id}/pause";
|
|
1170
|
+
readonly tag: "Reporting";
|
|
1171
|
+
readonly summary: "Pause a report schedule";
|
|
1172
|
+
readonly description: "Nothing fires until it is resumed. Pausing a paused schedule answers it as it is.";
|
|
1173
|
+
readonly auth: "service";
|
|
1174
|
+
readonly scope: "payments:write";
|
|
1175
|
+
readonly idempotent: true;
|
|
1176
|
+
readonly params: {
|
|
1177
|
+
readonly id: "The report schedule (`frs_…`).";
|
|
1178
|
+
};
|
|
1179
|
+
readonly body: z.ZodObject<{}, z.core.$strict>;
|
|
1180
|
+
readonly response: z.ZodObject<{
|
|
1181
|
+
id: z.ZodString;
|
|
1182
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
1183
|
+
livemode: z.ZodBoolean;
|
|
1184
|
+
created: z.ZodNumber;
|
|
1185
|
+
report_type: z.ZodEnum<{
|
|
1186
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
1187
|
+
"balance.summary.1": "balance.summary.1";
|
|
1188
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
1189
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
1190
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
1191
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
1192
|
+
}>;
|
|
1193
|
+
parameters: z.ZodObject<{
|
|
1194
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1195
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
1196
|
+
FAIR: "FAIR";
|
|
1197
|
+
EUR: "EUR";
|
|
1198
|
+
USD: "USD";
|
|
1199
|
+
GBP: "GBP";
|
|
1200
|
+
CHF: "CHF";
|
|
1201
|
+
SEK: "SEK";
|
|
1202
|
+
NOK: "NOK";
|
|
1203
|
+
DKK: "DKK";
|
|
1204
|
+
PLN: "PLN";
|
|
1205
|
+
CZK: "CZK";
|
|
1206
|
+
CAD: "CAD";
|
|
1207
|
+
AUD: "AUD";
|
|
1208
|
+
JPY: "JPY";
|
|
1209
|
+
}>>;
|
|
1210
|
+
}, z.core.$strict>;
|
|
1211
|
+
schedule: z.ZodObject<{
|
|
1212
|
+
interval: z.ZodEnum<{
|
|
1213
|
+
monthly: "monthly";
|
|
1214
|
+
daily: "daily";
|
|
1215
|
+
weekly: "weekly";
|
|
1216
|
+
}>;
|
|
1217
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
1218
|
+
monday: "monday";
|
|
1219
|
+
tuesday: "tuesday";
|
|
1220
|
+
wednesday: "wednesday";
|
|
1221
|
+
thursday: "thursday";
|
|
1222
|
+
friday: "friday";
|
|
1223
|
+
saturday: "saturday";
|
|
1224
|
+
sunday: "sunday";
|
|
1225
|
+
}>>;
|
|
1226
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
1227
|
+
}, z.core.$strict>;
|
|
1228
|
+
timezone: z.ZodString;
|
|
1229
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
1230
|
+
locale: z.ZodEnum<{
|
|
1231
|
+
en: "en";
|
|
1232
|
+
es: "es";
|
|
1233
|
+
}>;
|
|
1234
|
+
status: z.ZodEnum<{
|
|
1235
|
+
active: "active";
|
|
1236
|
+
canceled: "canceled";
|
|
1237
|
+
paused: "paused";
|
|
1238
|
+
}>;
|
|
1239
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
1240
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
1241
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
1242
|
+
}, z.core.$strict>;
|
|
1243
|
+
readonly sdk: "reporting.reportSchedules.pause";
|
|
1244
|
+
}, {
|
|
1245
|
+
readonly operationId: "resumeReportSchedule";
|
|
1246
|
+
readonly method: "post";
|
|
1247
|
+
readonly path: "/v1/reporting/report_schedules/{id}/resume";
|
|
1248
|
+
readonly tag: "Reporting";
|
|
1249
|
+
readonly summary: "Resume a paused report schedule";
|
|
1250
|
+
readonly description: "It fires again from its first occurrence after now; the occurrences it missed while paused are not run.";
|
|
1251
|
+
readonly auth: "service";
|
|
1252
|
+
readonly scope: "payments:write";
|
|
1253
|
+
readonly idempotent: true;
|
|
1254
|
+
readonly params: {
|
|
1255
|
+
readonly id: "The report schedule (`frs_…`).";
|
|
1256
|
+
};
|
|
1257
|
+
readonly body: z.ZodObject<{}, z.core.$strict>;
|
|
1258
|
+
readonly response: z.ZodObject<{
|
|
1259
|
+
id: z.ZodString;
|
|
1260
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
1261
|
+
livemode: z.ZodBoolean;
|
|
1262
|
+
created: z.ZodNumber;
|
|
1263
|
+
report_type: z.ZodEnum<{
|
|
1264
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
1265
|
+
"balance.summary.1": "balance.summary.1";
|
|
1266
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
1267
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
1268
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
1269
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
1270
|
+
}>;
|
|
1271
|
+
parameters: z.ZodObject<{
|
|
1272
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1273
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
1274
|
+
FAIR: "FAIR";
|
|
1275
|
+
EUR: "EUR";
|
|
1276
|
+
USD: "USD";
|
|
1277
|
+
GBP: "GBP";
|
|
1278
|
+
CHF: "CHF";
|
|
1279
|
+
SEK: "SEK";
|
|
1280
|
+
NOK: "NOK";
|
|
1281
|
+
DKK: "DKK";
|
|
1282
|
+
PLN: "PLN";
|
|
1283
|
+
CZK: "CZK";
|
|
1284
|
+
CAD: "CAD";
|
|
1285
|
+
AUD: "AUD";
|
|
1286
|
+
JPY: "JPY";
|
|
1287
|
+
}>>;
|
|
1288
|
+
}, z.core.$strict>;
|
|
1289
|
+
schedule: z.ZodObject<{
|
|
1290
|
+
interval: z.ZodEnum<{
|
|
1291
|
+
monthly: "monthly";
|
|
1292
|
+
daily: "daily";
|
|
1293
|
+
weekly: "weekly";
|
|
1294
|
+
}>;
|
|
1295
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
1296
|
+
monday: "monday";
|
|
1297
|
+
tuesday: "tuesday";
|
|
1298
|
+
wednesday: "wednesday";
|
|
1299
|
+
thursday: "thursday";
|
|
1300
|
+
friday: "friday";
|
|
1301
|
+
saturday: "saturday";
|
|
1302
|
+
sunday: "sunday";
|
|
1303
|
+
}>>;
|
|
1304
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
1305
|
+
}, z.core.$strict>;
|
|
1306
|
+
timezone: z.ZodString;
|
|
1307
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
1308
|
+
locale: z.ZodEnum<{
|
|
1309
|
+
en: "en";
|
|
1310
|
+
es: "es";
|
|
1311
|
+
}>;
|
|
1312
|
+
status: z.ZodEnum<{
|
|
1313
|
+
active: "active";
|
|
1314
|
+
canceled: "canceled";
|
|
1315
|
+
paused: "paused";
|
|
1316
|
+
}>;
|
|
1317
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
1318
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
1319
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
1320
|
+
}, z.core.$strict>;
|
|
1321
|
+
readonly sdk: "reporting.reportSchedules.resume";
|
|
1322
|
+
}, {
|
|
1323
|
+
readonly operationId: "cancelReportSchedule";
|
|
1324
|
+
readonly method: "post";
|
|
1325
|
+
readonly path: "/v1/reporting/report_schedules/{id}/cancel";
|
|
1326
|
+
readonly tag: "Reporting";
|
|
1327
|
+
readonly summary: "Cancel a report schedule";
|
|
1328
|
+
readonly description: "For good: it never fires again, and a run it fires no longer emails anyone. Its runs and their files stay.";
|
|
1329
|
+
readonly auth: "service";
|
|
1330
|
+
readonly scope: "payments:write";
|
|
1331
|
+
readonly idempotent: true;
|
|
1332
|
+
readonly params: {
|
|
1333
|
+
readonly id: "The report schedule (`frs_…`).";
|
|
1334
|
+
};
|
|
1335
|
+
readonly body: z.ZodObject<{}, z.core.$strict>;
|
|
1336
|
+
readonly response: z.ZodObject<{
|
|
1337
|
+
id: z.ZodString;
|
|
1338
|
+
object: z.ZodLiteral<"reporting.report_schedule">;
|
|
1339
|
+
livemode: z.ZodBoolean;
|
|
1340
|
+
created: z.ZodNumber;
|
|
1341
|
+
report_type: z.ZodEnum<{
|
|
1342
|
+
"payments.itemized.1": "payments.itemized.1";
|
|
1343
|
+
"balance.summary.1": "balance.summary.1";
|
|
1344
|
+
"balance_transactions.itemized.1": "balance_transactions.itemized.1";
|
|
1345
|
+
"payouts.itemized.1": "payouts.itemized.1";
|
|
1346
|
+
"refunds.itemized.1": "refunds.itemized.1";
|
|
1347
|
+
"disputes.itemized.1": "disputes.itemized.1";
|
|
1348
|
+
}>;
|
|
1349
|
+
parameters: z.ZodObject<{
|
|
1350
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1351
|
+
currency: z.ZodOptional<z.ZodEnum<{
|
|
1352
|
+
FAIR: "FAIR";
|
|
1353
|
+
EUR: "EUR";
|
|
1354
|
+
USD: "USD";
|
|
1355
|
+
GBP: "GBP";
|
|
1356
|
+
CHF: "CHF";
|
|
1357
|
+
SEK: "SEK";
|
|
1358
|
+
NOK: "NOK";
|
|
1359
|
+
DKK: "DKK";
|
|
1360
|
+
PLN: "PLN";
|
|
1361
|
+
CZK: "CZK";
|
|
1362
|
+
CAD: "CAD";
|
|
1363
|
+
AUD: "AUD";
|
|
1364
|
+
JPY: "JPY";
|
|
1365
|
+
}>>;
|
|
1366
|
+
}, z.core.$strict>;
|
|
1367
|
+
schedule: z.ZodObject<{
|
|
1368
|
+
interval: z.ZodEnum<{
|
|
1369
|
+
monthly: "monthly";
|
|
1370
|
+
daily: "daily";
|
|
1371
|
+
weekly: "weekly";
|
|
1372
|
+
}>;
|
|
1373
|
+
weekly_anchor: z.ZodNullable<z.ZodEnum<{
|
|
1374
|
+
monday: "monday";
|
|
1375
|
+
tuesday: "tuesday";
|
|
1376
|
+
wednesday: "wednesday";
|
|
1377
|
+
thursday: "thursday";
|
|
1378
|
+
friday: "friday";
|
|
1379
|
+
saturday: "saturday";
|
|
1380
|
+
sunday: "sunday";
|
|
1381
|
+
}>>;
|
|
1382
|
+
monthly_anchor: z.ZodNullable<z.ZodNumber>;
|
|
1383
|
+
}, z.core.$strict>;
|
|
1384
|
+
timezone: z.ZodString;
|
|
1385
|
+
recipients: z.ZodArray<z.ZodString>;
|
|
1386
|
+
locale: z.ZodEnum<{
|
|
1387
|
+
en: "en";
|
|
1388
|
+
es: "es";
|
|
1389
|
+
}>;
|
|
1390
|
+
status: z.ZodEnum<{
|
|
1391
|
+
active: "active";
|
|
1392
|
+
canceled: "canceled";
|
|
1393
|
+
paused: "paused";
|
|
1394
|
+
}>;
|
|
1395
|
+
next_run_at: z.ZodNullable<z.ZodNumber>;
|
|
1396
|
+
last_run: z.ZodNullable<z.ZodType<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">, z.core.$ZodTypeInternals<string | import("../..").Ref<"reporting.report_run">, string | import("../..").Ref<"reporting.report_run">>>>;
|
|
1397
|
+
canceled_at: z.ZodNullable<z.ZodNumber>;
|
|
1398
|
+
}, z.core.$strict>;
|
|
1399
|
+
readonly sdk: "reporting.reportSchedules.cancel";
|
|
506
1400
|
}];
|