@flowio/types 11.19.22 → 11.19.24

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/src/api.ts CHANGED
@@ -1996,6 +1996,680 @@ declare namespace io.flow.shopify.external.v0.models {
1996
1996
  }
1997
1997
  }
1998
1998
 
1999
+ declare namespace io.flow.channel.internal.v0.models {
2000
+ interface Channel {
2001
+ readonly id: string;
2002
+ readonly name: string;
2003
+ readonly environment: io.flow.common.v0.enums.Environment;
2004
+ readonly organization_id_prefix?: string;
2005
+ }
2006
+
2007
+ interface ChannelForm {
2008
+ readonly name: string;
2009
+ readonly environment: io.flow.common.v0.enums.Environment;
2010
+ readonly organization_id_prefix?: string;
2011
+ }
2012
+ }
2013
+
2014
+ declare namespace io.flow.common.v0.enums {
2015
+ type AttributeDataType =
2016
+ | 'boolean'
2017
+ | 'integer'
2018
+ | 'decimal'
2019
+ | 'string'
2020
+ | 'json_array';
2021
+ type AvailabilityStatus = 'enabled' | 'disabled';
2022
+ type Calendar = 'weekdays' | 'everyday';
2023
+ type Capability = 'crossdock';
2024
+ type ChangeType = 'insert' | 'update' | 'delete';
2025
+ type CurrencyLabelFormatter =
2026
+ | 'strip_trailing_zeros'
2027
+ | 'symbol_prefix'
2028
+ | 'symbol_suffix';
2029
+ type CurrencySymbolFormat = 'narrow' | 'primary';
2030
+ type DayOfWeek =
2031
+ | 'sunday'
2032
+ | 'monday'
2033
+ | 'tuesday'
2034
+ | 'wednesday'
2035
+ | 'thursday'
2036
+ | 'friday'
2037
+ | 'saturday';
2038
+ type DeliveredDuty = 'paid' | 'unpaid';
2039
+ type DiscountTarget = 'item' | 'shipping';
2040
+ type EntityIdentifierType = 'ioss' | 'voec';
2041
+ type Environment = 'sandbox' | 'production';
2042
+ type ExceptionType = 'open' | 'closed';
2043
+ type GoodsSupply = 'export' | 'intra_community' | 'local';
2044
+ type HolidayCalendar = 'us_bank_holidays' | 'jewish_holidays';
2045
+ type IncludedLevyKey = 'duty' | 'vat' | 'vat_and_duty' | 'none';
2046
+ type Incoterm =
2047
+ | 'EXW'
2048
+ | 'FCA'
2049
+ | 'CPT'
2050
+ | 'CIP'
2051
+ | 'DAT'
2052
+ | 'DAP'
2053
+ | 'DDP'
2054
+ | 'FAS'
2055
+ | 'FOB'
2056
+ | 'CFR'
2057
+ | 'CIF'
2058
+ | 'DAF'
2059
+ | 'DES'
2060
+ | 'DEQ'
2061
+ | 'DDU';
2062
+ type InputSpecificationType = 'text' | 'number';
2063
+ type MarginType = 'fixed' | 'percent';
2064
+ type MeasurementSystem = 'imperial' | 'metric';
2065
+ type MerchantOfRecord = 'flow' | 'organization';
2066
+ type OrderMerchantOfRecord = 'flow' | 'organization' | 'mixed';
2067
+ type OrganizationStatus = 'active' | 'inactive' | 'deactivated';
2068
+ type PriceBookStatus = 'draft' | 'published' | 'archived';
2069
+ type Role = 'admin' | 'member';
2070
+ type RoundingMethod = 'up' | 'down' | 'nearest';
2071
+ type RoundingType = 'pattern' | 'multiple';
2072
+ type ScheduleExceptionStatus = 'Open' | 'Closed';
2073
+ type SortDirection = 'ascending' | 'descending';
2074
+ type UnitOfMeasurement =
2075
+ | 'millimeter'
2076
+ | 'centimeter'
2077
+ | 'inch'
2078
+ | 'foot'
2079
+ | 'cubic_inch'
2080
+ | 'cubic_meter'
2081
+ | 'gram'
2082
+ | 'kilogram'
2083
+ | 'meter'
2084
+ | 'ounce'
2085
+ | 'pound';
2086
+ type UnitOfTime = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
2087
+ type UserStatus = 'pending' | 'active' | 'inactive';
2088
+ type ValueAddedService = 'Hazardous Material';
2089
+ type Visibility = 'public' | 'private';
2090
+ }
2091
+
2092
+ declare namespace io.flow.common.v0.models {
2093
+ interface Address {
2094
+ readonly text?: string;
2095
+ readonly streets?: string[];
2096
+ readonly street_number?: string;
2097
+ readonly city?: string;
2098
+ readonly province?: string;
2099
+ readonly postal?: string;
2100
+ readonly country?: string;
2101
+ readonly latitude?: string;
2102
+ readonly longitude?: string;
2103
+ }
2104
+
2105
+ interface BillingAddress {
2106
+ readonly name?: io.flow.common.v0.models.Name;
2107
+ readonly streets?: string[];
2108
+ readonly city?: string;
2109
+ readonly province?: string;
2110
+ readonly postal?: string;
2111
+ readonly country?: string;
2112
+ readonly company?: string;
2113
+ }
2114
+
2115
+ interface CatalogItemReference {
2116
+ readonly id: string;
2117
+ readonly number: string;
2118
+ }
2119
+
2120
+ interface CatalogItemSummary {
2121
+ readonly number: string;
2122
+ readonly name: string;
2123
+ readonly attributes: Record<string, string>;
2124
+ }
2125
+
2126
+ interface ChannelReference {
2127
+ readonly id: string;
2128
+ }
2129
+
2130
+ interface CheckoutReference {
2131
+ readonly id: string;
2132
+ }
2133
+
2134
+ interface Contact {
2135
+ readonly name: io.flow.common.v0.models.Name;
2136
+ readonly company?: string;
2137
+ readonly email?: string;
2138
+ readonly phone?: string;
2139
+ }
2140
+
2141
+ interface CustomerInvoice {
2142
+ readonly address?: io.flow.common.v0.models.BillingAddress;
2143
+ }
2144
+
2145
+ interface CustomerReference {
2146
+ readonly number: string;
2147
+ }
2148
+
2149
+ interface DatetimeRange {
2150
+ readonly from: string;
2151
+ readonly to: string;
2152
+ }
2153
+
2154
+ interface Dimension {
2155
+ readonly depth?: io.flow.common.v0.models.Measurement;
2156
+ readonly diameter?: io.flow.common.v0.models.Measurement;
2157
+ readonly length?: io.flow.common.v0.models.Measurement;
2158
+ readonly weight?: io.flow.common.v0.models.Measurement;
2159
+ readonly width?: io.flow.common.v0.models.Measurement;
2160
+ }
2161
+
2162
+ interface Dimensions {
2163
+ readonly product?: io.flow.common.v0.models.Dimension;
2164
+ readonly packaging?: io.flow.common.v0.models.Dimension;
2165
+ }
2166
+
2167
+ interface DiscountForm {
2168
+ readonly offer: io.flow.common.v0.unions.DiscountOffer;
2169
+ readonly target?: io.flow.common.v0.enums.DiscountTarget;
2170
+ readonly label?: string;
2171
+ }
2172
+
2173
+ interface DiscountOfferFixed {
2174
+ readonly discriminator: 'discount_offer_fixed';
2175
+ readonly money: io.flow.common.v0.models.Money;
2176
+ }
2177
+
2178
+ interface DiscountOfferPercent {
2179
+ readonly discriminator: 'discount_offer_percent';
2180
+ readonly percent: number;
2181
+ }
2182
+
2183
+ interface DiscountsForm {
2184
+ readonly discounts: io.flow.common.v0.models.DiscountForm[];
2185
+ }
2186
+
2187
+ interface Duration {
2188
+ readonly unit: io.flow.common.v0.enums.UnitOfTime;
2189
+ readonly value: number;
2190
+ }
2191
+
2192
+ interface EntityIdentifier {
2193
+ readonly name: io.flow.common.v0.enums.EntityIdentifierType;
2194
+ readonly number: string;
2195
+ readonly issuing_country?: string;
2196
+ }
2197
+
2198
+ interface Exception {
2199
+ readonly type: io.flow.common.v0.enums.ExceptionType;
2200
+ readonly datetime_range: io.flow.common.v0.models.DatetimeRange;
2201
+ }
2202
+
2203
+ interface ExperienceSummary {
2204
+ readonly id: string;
2205
+ readonly key: string;
2206
+ readonly name: string;
2207
+ readonly country?: string;
2208
+ readonly currency?: string;
2209
+ readonly language?: string;
2210
+ }
2211
+
2212
+ interface IncludedLevies {
2213
+ readonly key: io.flow.common.v0.enums.IncludedLevyKey;
2214
+ readonly label: string;
2215
+ }
2216
+
2217
+ interface InputForm {
2218
+ readonly values?: Record<string, string>;
2219
+ }
2220
+
2221
+ interface InputFormSpecification {
2222
+ readonly inputs?: io.flow.common.v0.models.InputSpecification[];
2223
+ readonly limitations?: io.flow.common.v0.models.InputSpecificationLimitations;
2224
+ }
2225
+
2226
+ interface InputSpecification {
2227
+ readonly type: io.flow.common.v0.enums.InputSpecificationType;
2228
+ readonly name: string;
2229
+ readonly display_text?: string;
2230
+ }
2231
+
2232
+ interface InputSpecificationLimitationMax {
2233
+ readonly discriminator: 'input_specification_limitation_max';
2234
+ readonly max: number;
2235
+ }
2236
+
2237
+ interface InputSpecificationLimitations {
2238
+ readonly limitations?: io.flow.common.v0.unions.InputSpecificationLimitation[];
2239
+ }
2240
+
2241
+ interface ItemReference {
2242
+ readonly number: string;
2243
+ }
2244
+
2245
+ interface LineItem {
2246
+ readonly number: string;
2247
+ readonly quantity: number;
2248
+ readonly price: io.flow.common.v0.models.Money;
2249
+ readonly attributes: Record<string, string>;
2250
+ readonly center?: string;
2251
+ readonly discount?: io.flow.common.v0.models.Money;
2252
+ }
2253
+
2254
+ interface LineItemAttributesForm {
2255
+ readonly attributes: Record<string, string>;
2256
+ }
2257
+
2258
+ interface LineItemForm {
2259
+ readonly number: string;
2260
+ readonly quantity: number;
2261
+ readonly shipment_estimate?: io.flow.common.v0.models.DatetimeRange;
2262
+ readonly price?: io.flow.common.v0.models.Money;
2263
+ readonly attributes?: Record<string, string>;
2264
+ readonly center?: string;
2265
+ readonly discount?: io.flow.common.v0.models.Money;
2266
+ readonly discounts?: io.flow.common.v0.models.DiscountsForm;
2267
+ }
2268
+
2269
+ interface LineItemQuantityForm {
2270
+ readonly quantity: number;
2271
+ }
2272
+
2273
+ interface Margin {
2274
+ readonly type: io.flow.common.v0.enums.MarginType;
2275
+ readonly value: number;
2276
+ }
2277
+
2278
+ interface Measurement {
2279
+ readonly value: string;
2280
+ readonly units: io.flow.common.v0.enums.UnitOfMeasurement;
2281
+ }
2282
+
2283
+ interface MerchantOfRecordEntity {
2284
+ readonly organization: io.flow.common.v0.models.OrganizationReference;
2285
+ readonly name: string;
2286
+ readonly vat?: io.flow.common.v0.models.MerchantOfRecordEntityRegistration;
2287
+ readonly identifiers?: io.flow.common.v0.models.EntityIdentifier[];
2288
+ readonly streets: string[];
2289
+ readonly city: string;
2290
+ readonly province?: string;
2291
+ readonly postal?: string;
2292
+ readonly country: string;
2293
+ readonly phone?: string;
2294
+ readonly email?: string;
2295
+ }
2296
+
2297
+ interface MerchantOfRecordEntityRegistration {
2298
+ readonly number: string;
2299
+ readonly country: string;
2300
+ }
2301
+
2302
+ interface Money {
2303
+ readonly amount: number;
2304
+ readonly currency: string;
2305
+ }
2306
+
2307
+ interface MoneyWithBase {
2308
+ readonly currency: string;
2309
+ readonly amount: number;
2310
+ readonly base: io.flow.common.v0.models.Money;
2311
+ }
2312
+
2313
+ interface MoneyWithOptionalBase {
2314
+ readonly currency: string;
2315
+ readonly amount: number;
2316
+ readonly base?: io.flow.common.v0.models.Money;
2317
+ }
2318
+
2319
+ interface Name {
2320
+ readonly first?: string;
2321
+ readonly last?: string;
2322
+ }
2323
+
2324
+ interface OrderCustomer {
2325
+ readonly name: io.flow.common.v0.models.Name;
2326
+ readonly number?: string;
2327
+ readonly phone?: string;
2328
+ readonly email?: string;
2329
+ readonly address?: io.flow.common.v0.models.BillingAddress;
2330
+ readonly invoice?: io.flow.common.v0.models.CustomerInvoice;
2331
+ }
2332
+
2333
+ interface OrderCustomerForm {
2334
+ readonly name?: io.flow.common.v0.models.Name;
2335
+ readonly number?: string;
2336
+ readonly phone?: string;
2337
+ readonly email?: string;
2338
+ readonly address?: io.flow.common.v0.models.BillingAddress;
2339
+ readonly invoice?: io.flow.common.v0.models.CustomerInvoice;
2340
+ }
2341
+
2342
+ interface Organization {
2343
+ readonly discriminator: 'organization';
2344
+ readonly id: string;
2345
+ readonly name: string;
2346
+ readonly environment: io.flow.common.v0.enums.Environment;
2347
+ readonly parent?: io.flow.common.v0.models.OrganizationReference;
2348
+ readonly defaults?: io.flow.common.v0.models.OrganizationDefaults;
2349
+ readonly created_at?: string;
2350
+ readonly status?: io.flow.common.v0.enums.OrganizationStatus;
2351
+ }
2352
+
2353
+ interface OrganizationDefaults {
2354
+ readonly country: string;
2355
+ readonly base_currency: string;
2356
+ readonly language: string;
2357
+ readonly locale: string;
2358
+ readonly timezone: string;
2359
+ }
2360
+
2361
+ interface OrganizationReference {
2362
+ readonly discriminator: 'organization_reference';
2363
+ readonly id: string;
2364
+ }
2365
+
2366
+ interface OrganizationSummary {
2367
+ readonly id: string;
2368
+ readonly name: string;
2369
+ readonly environment: io.flow.common.v0.enums.Environment;
2370
+ }
2371
+
2372
+ interface PartnerReference {
2373
+ readonly id: string;
2374
+ }
2375
+
2376
+ interface Price {
2377
+ readonly amount: number;
2378
+ readonly currency: string;
2379
+ readonly label: string;
2380
+ }
2381
+
2382
+ interface PriceForm {
2383
+ readonly amount: number;
2384
+ readonly currency: string;
2385
+ }
2386
+
2387
+ interface PriceSourceCatalog {
2388
+ readonly discriminator: 'catalog';
2389
+ readonly price: io.flow.common.v0.models.Money;
2390
+ }
2391
+
2392
+ interface PriceSourcePriceBook {
2393
+ readonly discriminator: 'price_book';
2394
+ readonly price: io.flow.common.v0.models.Money;
2395
+ readonly includes: io.flow.common.v0.models.IncludedLevies;
2396
+ readonly price_book_reference: io.flow.common.v0.models.PriceSourcePriceBookReference;
2397
+ }
2398
+
2399
+ interface PriceSourcePriceBookReference {
2400
+ readonly id: string;
2401
+ readonly key: string;
2402
+ }
2403
+
2404
+ interface PriceSourceProvided {
2405
+ readonly discriminator: 'provided';
2406
+ readonly price: io.flow.common.v0.models.Money;
2407
+ }
2408
+
2409
+ interface PriceWithBase {
2410
+ readonly currency: string;
2411
+ readonly amount: number;
2412
+ readonly label: string;
2413
+ readonly base?: io.flow.common.v0.models.Price;
2414
+ }
2415
+
2416
+ interface RepeatDaily {
2417
+ readonly discriminator: 'repeat_daily';
2418
+ readonly interval: number;
2419
+ }
2420
+
2421
+ interface RepeatHourly {
2422
+ readonly discriminator: 'repeat_hourly';
2423
+ readonly interval: number;
2424
+ }
2425
+
2426
+ interface RepeatMonthly {
2427
+ readonly discriminator: 'repeat_monthly';
2428
+ readonly interval: number;
2429
+ readonly days: number[];
2430
+ }
2431
+
2432
+ interface RepeatWeekly {
2433
+ readonly discriminator: 'repeat_weekly';
2434
+ readonly interval: number;
2435
+ readonly days_of_week: io.flow.common.v0.enums.DayOfWeek[];
2436
+ }
2437
+
2438
+ interface Rounding {
2439
+ readonly type: io.flow.common.v0.enums.RoundingType;
2440
+ readonly method: io.flow.common.v0.enums.RoundingMethod;
2441
+ readonly value: number;
2442
+ }
2443
+
2444
+ interface Schedule {
2445
+ readonly calendar?: io.flow.common.v0.enums.Calendar;
2446
+ readonly holiday: io.flow.common.v0.enums.HolidayCalendar;
2447
+ readonly exception: io.flow.common.v0.models.Exception[];
2448
+ readonly cutoff?: string;
2449
+ readonly min_lead_time?: number;
2450
+ readonly max_lead_time?: number;
2451
+ }
2452
+
2453
+ interface SessionReference {
2454
+ readonly id: string;
2455
+ }
2456
+
2457
+ interface User {
2458
+ readonly discriminator: 'user';
2459
+ readonly id: string;
2460
+ readonly email?: string;
2461
+ readonly name: io.flow.common.v0.models.Name;
2462
+ readonly status: io.flow.common.v0.enums.UserStatus;
2463
+ }
2464
+
2465
+ interface UserReference {
2466
+ readonly discriminator: 'user_reference';
2467
+ readonly id: string;
2468
+ }
2469
+
2470
+ interface Zone {
2471
+ readonly postals?: string[];
2472
+ readonly provinces?: string[];
2473
+ readonly country: string;
2474
+ }
2475
+ }
2476
+
2477
+ declare namespace io.flow.common.v0.unions {
2478
+ type DiscountOffer =
2479
+ | io.flow.common.v0.models.DiscountOfferFixed
2480
+ | io.flow.common.v0.models.DiscountOfferPercent;
2481
+ type ExpandableOrganization =
2482
+ | io.flow.common.v0.models.Organization
2483
+ | io.flow.common.v0.models.OrganizationReference;
2484
+ type ExpandableUser =
2485
+ | io.flow.common.v0.models.User
2486
+ | io.flow.common.v0.models.UserReference;
2487
+ type InputSpecificationLimitation = io.flow.common.v0.models.InputSpecificationLimitationMax;
2488
+ type PriceSource =
2489
+ | io.flow.common.v0.models.PriceSourcePriceBook
2490
+ | io.flow.common.v0.models.PriceSourceCatalog
2491
+ | io.flow.common.v0.models.PriceSourceProvided;
2492
+ type RepeatSchedule =
2493
+ | io.flow.common.v0.models.RepeatHourly
2494
+ | io.flow.common.v0.models.RepeatDaily
2495
+ | io.flow.common.v0.models.RepeatWeekly
2496
+ | io.flow.common.v0.models.RepeatMonthly;
2497
+ }
2498
+
2499
+ declare namespace io.flow.token.v0.models {
2500
+ interface ChannelToken {
2501
+ readonly discriminator: 'channel_token';
2502
+ readonly id: string;
2503
+ readonly channel: io.flow.common.v0.models.ChannelReference;
2504
+ readonly user: io.flow.common.v0.models.UserReference;
2505
+ readonly partial: string;
2506
+ readonly created_at: string;
2507
+ readonly description?: string;
2508
+ }
2509
+
2510
+ interface ChannelTokenReference {
2511
+ readonly discriminator: 'channel_token_reference';
2512
+ readonly id: string;
2513
+ readonly channel: io.flow.common.v0.models.ChannelReference;
2514
+ readonly user: io.flow.common.v0.models.UserReference;
2515
+ }
2516
+
2517
+ interface Cleartext {
2518
+ readonly value: string;
2519
+ }
2520
+
2521
+ interface OrganizationToken {
2522
+ readonly discriminator: 'organization_token';
2523
+ readonly id: string;
2524
+ readonly organization: io.flow.common.v0.models.OrganizationReference;
2525
+ readonly user: io.flow.common.v0.models.UserReference;
2526
+ readonly environment: io.flow.common.v0.enums.Environment;
2527
+ readonly partial: string;
2528
+ readonly created_at: string;
2529
+ readonly description?: string;
2530
+ }
2531
+
2532
+ interface OrganizationTokenForm {
2533
+ readonly environment: io.flow.common.v0.enums.Environment;
2534
+ readonly description?: string;
2535
+ }
2536
+
2537
+ interface OrganizationTokenReference {
2538
+ readonly discriminator: 'organization_token_reference';
2539
+ readonly id: string;
2540
+ readonly organization: io.flow.common.v0.models.OrganizationReference;
2541
+ readonly environment: io.flow.common.v0.enums.Environment;
2542
+ readonly user: io.flow.common.v0.models.UserReference;
2543
+ }
2544
+
2545
+ interface PartnerToken {
2546
+ readonly discriminator: 'partner_token';
2547
+ readonly id: string;
2548
+ readonly partner: io.flow.token.v0.models.TokenPartnerReference;
2549
+ readonly user: io.flow.common.v0.models.UserReference;
2550
+ readonly environment: io.flow.common.v0.enums.Environment;
2551
+ readonly partial: string;
2552
+ readonly created_at: string;
2553
+ readonly description?: string;
2554
+ }
2555
+
2556
+ interface PartnerTokenForm {
2557
+ readonly environment: io.flow.common.v0.enums.Environment;
2558
+ readonly description?: string;
2559
+ }
2560
+
2561
+ interface PartnerTokenReference {
2562
+ readonly discriminator: 'partner_token_reference';
2563
+ readonly id: string;
2564
+ readonly partner: io.flow.token.v0.models.TokenPartnerReference;
2565
+ readonly environment: io.flow.common.v0.enums.Environment;
2566
+ readonly user: io.flow.common.v0.models.UserReference;
2567
+ }
2568
+
2569
+ interface TokenAuthenticationForm {
2570
+ readonly token: string;
2571
+ }
2572
+
2573
+ interface TokenPartnerReference {
2574
+ readonly id: string;
2575
+ }
2576
+
2577
+ interface TokenValidation {
2578
+ readonly status: string;
2579
+ }
2580
+
2581
+ interface TokenValidationForm {
2582
+ readonly token: string;
2583
+ }
2584
+ }
2585
+
2586
+ declare namespace io.flow.token.v0.unions {
2587
+ type Token =
2588
+ | io.flow.token.v0.models.ChannelToken
2589
+ | io.flow.token.v0.models.OrganizationToken
2590
+ | io.flow.token.v0.models.PartnerToken;
2591
+ type TokenReference =
2592
+ | io.flow.token.v0.models.ChannelTokenReference
2593
+ | io.flow.token.v0.models.OrganizationTokenReference
2594
+ | io.flow.token.v0.models.PartnerTokenReference;
2595
+ }
2596
+
2597
+ declare namespace io.flow.error.v0.enums {
2598
+ type GenericErrorCode = 'generic_error' | 'client_error' | 'server_error';
2599
+ }
2600
+
2601
+ declare namespace io.flow.error.v0.models {
2602
+ interface GenericError {
2603
+ readonly code: io.flow.error.v0.enums.GenericErrorCode;
2604
+ readonly messages: string[];
2605
+ }
2606
+ }
2607
+
2608
+ declare namespace io.flow.permission.v0.enums {
2609
+ type AuthenticationTechnique =
2610
+ | 'anonymous'
2611
+ | 'session'
2612
+ | 'token'
2613
+ | 'partner_token'
2614
+ | 'user';
2615
+ type FlowBehavior = 'view_consumer_data';
2616
+ type FlowRole =
2617
+ | 'organization_admin'
2618
+ | 'organization_merchant'
2619
+ | 'organization_customer_service'
2620
+ | 'organization_fulfillment'
2621
+ | 'organization_marketing'
2622
+ | 'organization_finance'
2623
+ | 'flow_operations'
2624
+ | 'channel_admin'
2625
+ | 'channel_organization_admin';
2626
+ type PermittedHttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
2627
+ }
2628
+
2629
+ declare namespace io.flow.permission.v0.models {
2630
+ interface BehaviorAudit {
2631
+ readonly behavior: io.flow.permission.v0.enums.FlowBehavior;
2632
+ readonly authentication_techniques: io.flow.permission.v0.enums.AuthenticationTechnique[];
2633
+ readonly roles: io.flow.permission.v0.enums.FlowRole[];
2634
+ }
2635
+
2636
+ interface PermissionAudit {
2637
+ readonly routes: io.flow.permission.v0.models.RouteAudit[];
2638
+ readonly behaviors: io.flow.permission.v0.models.BehaviorAudit[];
2639
+ }
2640
+
2641
+ interface PermissionCheck {
2642
+ readonly authentication_technique: io.flow.permission.v0.enums.AuthenticationTechnique;
2643
+ readonly user?: io.flow.common.v0.unions.ExpandableUser;
2644
+ readonly roles: io.flow.permission.v0.enums.FlowRole[];
2645
+ readonly behaviors: io.flow.permission.v0.enums.FlowBehavior[];
2646
+ readonly routes: io.flow.permission.v0.models.PermittedRoute[];
2647
+ }
2648
+
2649
+ interface PermissionError {
2650
+ readonly code: io.flow.error.v0.enums.GenericErrorCode;
2651
+ readonly messages: string[];
2652
+ readonly granting_roles?: io.flow.permission.v0.enums.FlowRole[];
2653
+ readonly admin_users?: io.flow.common.v0.models.User[];
2654
+ }
2655
+
2656
+ interface PermittedRoute {
2657
+ readonly method: io.flow.permission.v0.enums.PermittedHttpMethod;
2658
+ readonly path: string;
2659
+ }
2660
+
2661
+ interface RouteAudit {
2662
+ readonly method: io.flow.permission.v0.enums.PermittedHttpMethod;
2663
+ readonly path: string;
2664
+ readonly authentication_techniques: io.flow.permission.v0.enums.AuthenticationTechnique[];
2665
+ readonly roles: io.flow.permission.v0.enums.FlowRole[];
2666
+ }
2667
+
2668
+ interface SimplePermissionCheck {
2669
+ readonly behaviors: io.flow.permission.v0.enums.FlowBehavior[];
2670
+ }
2671
+ }
2672
+
1999
2673
  declare namespace io.flow.apple.pay.v0.enums {
2000
2674
  type ApplePayContactField =
2001
2675
  | 'email'
@@ -2385,8 +3059,6 @@ declare namespace io.flow.v0.enums {
2385
3059
  | 'label_upserted'
2386
3060
  | 'label_deleted_v2'
2387
3061
  | 'label_upserted_v2'
2388
- | 'notification_upserted'
2389
- | 'notification_deleted'
2390
3062
  | 'notification_upserted_v2'
2391
3063
  | 'notification_deleted_v2'
2392
3064
  | 'manifested_label_upserted'
@@ -4106,13 +4778,6 @@ declare namespace io.flow.v0.models {
4106
4778
  readonly center: io.flow.v0.models.Center;
4107
4779
  }
4108
4780
 
4109
- interface Channel {
4110
- readonly id: string;
4111
- readonly name: string;
4112
- readonly environment: io.flow.v0.enums.Environment;
4113
- readonly organization_id_prefix?: string;
4114
- }
4115
-
4116
4781
  interface ChannelAuthorization {
4117
4782
  readonly placeholder?: string;
4118
4783
  }
@@ -4153,12 +4818,6 @@ declare namespace io.flow.v0.models {
4153
4818
  readonly id: string;
4154
4819
  }
4155
4820
 
4156
- interface ChannelForm {
4157
- readonly name: string;
4158
- readonly environment: io.flow.v0.enums.Environment;
4159
- readonly organization_id_prefix?: string;
4160
- }
4161
-
4162
4821
  interface ChannelOrganization {
4163
4822
  readonly id: string;
4164
4823
  readonly organization: io.flow.v0.models.OrganizationReference;
@@ -4218,11 +4877,6 @@ declare namespace io.flow.v0.models {
4218
4877
  readonly description?: string;
4219
4878
  }
4220
4879
 
4221
- interface ChannelTokenForm {
4222
- readonly channel_id: string;
4223
- readonly description?: string;
4224
- }
4225
-
4226
4880
  interface ChannelTokenReference {
4227
4881
  readonly discriminator: 'channel_token_reference';
4228
4882
  readonly id: string;
@@ -4234,7 +4888,7 @@ declare namespace io.flow.v0.models {
4234
4888
  readonly discriminator: 'channel_upserted';
4235
4889
  readonly event_id: string;
4236
4890
  readonly timestamp: string;
4237
- readonly channel: io.flow.v0.models.Channel;
4891
+ readonly channel: io.flow.channel.internal.v0.models.Channel;
4238
4892
  }
4239
4893
 
4240
4894
  interface CheckoutAttribute {
@@ -5814,6 +6468,12 @@ declare namespace io.flow.v0.models {
5814
6468
  readonly status: io.flow.v0.enums.SubcatalogItemStatus;
5815
6469
  }
5816
6470
 
6471
+ interface FlowShippingLabelRatecardSummary {
6472
+ readonly discriminator: 'flow';
6473
+ readonly id: string;
6474
+ readonly cost: io.flow.v0.models.Money;
6475
+ }
6476
+
5817
6477
  interface FraudEmailRule {
5818
6478
  readonly id?: string;
5819
6479
  readonly email: string;
@@ -6119,6 +6779,9 @@ declare namespace io.flow.v0.models {
6119
6779
  readonly duty: io.flow.v0.models.Duty;
6120
6780
  readonly tax: io.flow.v0.models.Tax;
6121
6781
  readonly tax_applicability?: io.flow.v0.enums.TaxApplicability;
6782
+ readonly origin?: string;
6783
+ readonly hs_code?: string;
6784
+ readonly customs_description?: string;
6122
6785
  }
6123
6786
 
6124
6787
  interface HarmonizedLandedCostUpserted {
@@ -7223,22 +7886,6 @@ declare namespace io.flow.v0.models {
7223
7886
  readonly available_quantity: number;
7224
7887
  }
7225
7888
 
7226
- interface NotificationDeleted {
7227
- readonly discriminator: 'notification_deleted';
7228
- readonly event_id: string;
7229
- readonly timestamp: string;
7230
- readonly organization: string;
7231
- readonly notification_id: string;
7232
- readonly carrier_tracking_number: string;
7233
- readonly flow_tracking_number: string;
7234
- readonly destination: io.flow.v0.models.ShippingAddress;
7235
- readonly origin: io.flow.v0.models.ShippingAddress;
7236
- readonly carrier: string;
7237
- readonly service: string;
7238
- readonly order: string;
7239
- readonly package: io.flow.v0.models.ShippingLabelPackage;
7240
- }
7241
-
7242
7889
  interface NotificationDeletedV2 {
7243
7890
  readonly discriminator: 'notification_deleted_v2';
7244
7891
  readonly event_id: string;
@@ -7247,24 +7894,6 @@ declare namespace io.flow.v0.models {
7247
7894
  readonly notification: io.flow.v0.models.ShippingNotification;
7248
7895
  }
7249
7896
 
7250
- interface NotificationUpserted {
7251
- readonly discriminator: 'notification_upserted';
7252
- readonly event_id: string;
7253
- readonly timestamp: string;
7254
- readonly organization: string;
7255
- readonly notification_id: string;
7256
- readonly carrier_tracking_number: string;
7257
- readonly flow_tracking_number: string;
7258
- readonly destination: io.flow.v0.models.ShippingAddress;
7259
- readonly origin: io.flow.v0.models.ShippingAddress;
7260
- readonly carrier: string;
7261
- readonly service: string;
7262
- readonly order: string;
7263
- readonly order_identifier?: string;
7264
- readonly fulfillment_key?: string;
7265
- readonly package: io.flow.v0.models.ShippingLabelPackage;
7266
- }
7267
-
7268
7897
  interface NotificationUpsertedV2 {
7269
7898
  readonly discriminator: 'notification_upserted_v2';
7270
7899
  readonly event_id: string;
@@ -8078,6 +8707,12 @@ declare namespace io.flow.v0.models {
8078
8707
  readonly environment: io.flow.v0.enums.Environment;
8079
8708
  }
8080
8709
 
8710
+ interface OrganizationShippingLabelRatecardSummary {
8711
+ readonly discriminator: 'organization';
8712
+ readonly id: string;
8713
+ readonly cost?: io.flow.v0.models.Money;
8714
+ }
8715
+
8081
8716
  interface OrganizationShortId {
8082
8717
  readonly id: string;
8083
8718
  readonly organization: io.flow.v0.models.OrganizationReference;
@@ -8273,6 +8908,16 @@ declare namespace io.flow.v0.models {
8273
8908
  readonly currency?: string;
8274
8909
  }
8275
8910
 
8911
+ interface PaymentCaptureOptionAutomaticImmediate {
8912
+ readonly type: 'automatic_immediate';
8913
+ readonly placeholder?: string;
8914
+ }
8915
+
8916
+ interface PaymentCaptureOptionManual {
8917
+ readonly type: 'manual';
8918
+ readonly placeholder?: string;
8919
+ }
8920
+
8276
8921
  interface PaymentCaptureStatus {
8277
8922
  readonly status: io.flow.v0.enums.CaptureStatus;
8278
8923
  readonly reason?: io.flow.v0.enums.CaptureDeclineCode;
@@ -8607,7 +9252,7 @@ declare namespace io.flow.v0.models {
8607
9252
  readonly reference?: string;
8608
9253
  readonly payment_information: io.flow.v0.models.PaymentInformation;
8609
9254
  readonly supported_actions: io.flow.v0.enums.PaymentActionType[];
8610
- readonly capture_delay_hours?: number;
9255
+ readonly payment_capture_option?: io.flow.v0.unions.PaymentCaptureOption;
8611
9256
  }
8612
9257
 
8613
9258
  interface PaymentRequestForm {
@@ -8621,7 +9266,7 @@ declare namespace io.flow.v0.models {
8621
9266
  readonly reference?: string;
8622
9267
  readonly payment_method_data?: io.flow.v0.unions.PaymentMethodData;
8623
9268
  readonly supported_actions?: io.flow.v0.enums.PaymentActionType[];
8624
- readonly capture_delay_hours?: number;
9269
+ readonly payment_capture_option?: io.flow.v0.unions.PaymentCaptureOption;
8625
9270
  }
8626
9271
 
8627
9272
  interface PaymentRequestReference {
@@ -9290,6 +9935,16 @@ declare namespace io.flow.v0.models {
9290
9935
  readonly ratecard_owner?: io.flow.v0.enums.RatecardOwner;
9291
9936
  }
9292
9937
 
9938
+ interface RatecardEstimateV3 {
9939
+ readonly discriminator: 'ratecard_estimate_v3';
9940
+ readonly hops: io.flow.v0.models.Hop[];
9941
+ readonly delivered_duty: io.flow.v0.enums.DeliveredDuty;
9942
+ readonly dimensional_weight?: io.flow.v0.models.Measurement;
9943
+ readonly gravitational_weight?: io.flow.v0.models.Measurement;
9944
+ readonly line_items?: io.flow.v0.models.LineItemForm[];
9945
+ readonly ratecard: io.flow.v0.models.RatecardSummary;
9946
+ }
9947
+
9293
9948
  interface RatecardForm {
9294
9949
  readonly direction: io.flow.v0.enums.Direction;
9295
9950
  readonly effective_at: string;
@@ -10183,10 +10838,11 @@ declare namespace io.flow.v0.models {
10183
10838
 
10184
10839
  interface ShippingLabel {
10185
10840
  readonly id: string;
10841
+ readonly ratecard?: io.flow.v0.unions.ShippingLabelRatecardSummary;
10186
10842
  readonly attributes: Record<string, string>;
10187
10843
  readonly carrier_tracking_number: string;
10188
10844
  readonly carrier_tracking_number_url: string;
10189
- readonly cost: io.flow.v0.models.Price;
10845
+ readonly cost?: io.flow.v0.models.Price;
10190
10846
  readonly destination: io.flow.v0.models.ShippingAddress;
10191
10847
  readonly flow_tracking_number: string;
10192
10848
  readonly flow_tracking_number_url: string;
@@ -11591,8 +12247,6 @@ declare namespace io.flow.v0.unions {
11591
12247
  | io.flow.v0.models.LabelUpserted
11592
12248
  | io.flow.v0.models.LabelDeletedV2
11593
12249
  | io.flow.v0.models.LabelUpsertedV2
11594
- | io.flow.v0.models.NotificationUpserted
11595
- | io.flow.v0.models.NotificationDeleted
11596
12250
  | io.flow.v0.models.NotificationUpsertedV2
11597
12251
  | io.flow.v0.models.NotificationDeletedV2
11598
12252
  | io.flow.v0.models.ManifestedLabelUpserted
@@ -11752,6 +12406,9 @@ declare namespace io.flow.v0.unions {
11752
12406
  type Payment =
11753
12407
  | io.flow.v0.models.PaymentPaypal
11754
12408
  | io.flow.v0.models.PaymentCryptopay;
12409
+ type PaymentCaptureOption =
12410
+ | io.flow.v0.models.PaymentCaptureOptionAutomaticImmediate
12411
+ | io.flow.v0.models.PaymentCaptureOptionManual;
11755
12412
  type PaymentForm = io.flow.v0.models.MerchantOfRecordPaymentForm;
11756
12413
  type PaymentMethodCard =
11757
12414
  | io.flow.v0.models.PaymentMethodCardPciDetails
@@ -11809,7 +12466,8 @@ declare namespace io.flow.v0.unions {
11809
12466
  | io.flow.v0.models.QueryFilterUnstructuredForm;
11810
12467
  type RatecardEstimate =
11811
12468
  | io.flow.v0.models.RatecardEstimateV1
11812
- | io.flow.v0.models.RatecardEstimateV2;
12469
+ | io.flow.v0.models.RatecardEstimateV2
12470
+ | io.flow.v0.models.RatecardEstimateV3;
11813
12471
  type RatecardEstimateForm =
11814
12472
  | io.flow.v0.models.RatecardEstimateFormV1
11815
12473
  | io.flow.v0.models.RatecardEstimateFormV2;
@@ -11850,6 +12508,9 @@ declare namespace io.flow.v0.unions {
11850
12508
  type ShippingLabelForm =
11851
12509
  | io.flow.v0.models.DetailedShippingLabelForm
11852
12510
  | io.flow.v0.models.SummaryShippingLabelForm;
12511
+ type ShippingLabelRatecardSummary =
12512
+ | io.flow.v0.models.FlowShippingLabelRatecardSummary
12513
+ | io.flow.v0.models.OrganizationShippingLabelRatecardSummary;
11853
12514
  type ShippingNotificationForm =
11854
12515
  | io.flow.v0.models.DetailedShippingNotificationForm
11855
12516
  | io.flow.v0.models.SinglePackageShippingNotificationForm
@@ -12083,7 +12744,6 @@ export type CenterSummary = io.flow.v0.models.CenterSummary;
12083
12744
  export type CenterUpserted = io.flow.v0.models.CenterUpserted;
12084
12745
  export type CenterVersion = io.flow.v0.models.CenterVersion;
12085
12746
  export type ChangeType = io.flow.v0.enums.ChangeType;
12086
- export type Channel = io.flow.v0.models.Channel;
12087
12747
  export type ChannelAuthorization = io.flow.v0.models.ChannelAuthorization;
12088
12748
  export type ChannelAuthorizationForm = io.flow.v0.models.ChannelAuthorizationForm;
12089
12749
  export type ChannelCurrency = io.flow.v0.models.ChannelCurrency;
@@ -12092,7 +12752,6 @@ export type ChannelCurrencyDeleted = io.flow.v0.models.ChannelCurrencyDeleted;
12092
12752
  export type ChannelCurrencyForm = io.flow.v0.models.ChannelCurrencyForm;
12093
12753
  export type ChannelCurrencyUpserted = io.flow.v0.models.ChannelCurrencyUpserted;
12094
12754
  export type ChannelDeleted = io.flow.v0.models.ChannelDeleted;
12095
- export type ChannelForm = io.flow.v0.models.ChannelForm;
12096
12755
  export type ChannelOrganization = io.flow.v0.models.ChannelOrganization;
12097
12756
  export type ChannelOrganizationAuthorization = io.flow.v0.models.ChannelOrganizationAuthorization;
12098
12757
  export type ChannelOrganizationAuthorizationForm = io.flow.v0.models.ChannelOrganizationAuthorizationForm;
@@ -12102,7 +12761,6 @@ export type ChannelOrganizationUpserted = io.flow.v0.models.ChannelOrganizationU
12102
12761
  export type ChannelRate = io.flow.v0.models.ChannelRate;
12103
12762
  export type ChannelReference = io.flow.v0.models.ChannelReference;
12104
12763
  export type ChannelToken = io.flow.v0.models.ChannelToken;
12105
- export type ChannelTokenForm = io.flow.v0.models.ChannelTokenForm;
12106
12764
  export type ChannelTokenReference = io.flow.v0.models.ChannelTokenReference;
12107
12765
  export type ChannelUpserted = io.flow.v0.models.ChannelUpserted;
12108
12766
  export type CheckoutAttribute = io.flow.v0.models.CheckoutAttribute;
@@ -12396,6 +13054,7 @@ export type FlowCenterReference = io.flow.v0.models.FlowCenterReference;
12396
13054
  export type FlowEntity = io.flow.v0.enums.FlowEntity;
12397
13055
  export type FlowItemIndexMetadata = io.flow.v0.models.FlowItemIndexMetadata;
12398
13056
  export type FlowRole = io.flow.v0.enums.FlowRole;
13057
+ export type FlowShippingLabelRatecardSummary = io.flow.v0.models.FlowShippingLabelRatecardSummary;
12399
13058
  export type FraudEmailRule = io.flow.v0.models.FraudEmailRule;
12400
13059
  export type FraudEmailRuleDecision = io.flow.v0.enums.FraudEmailRuleDecision;
12401
13060
  export type FraudEmailRuleForm = io.flow.v0.models.FraudEmailRuleForm;
@@ -12633,9 +13292,7 @@ export type Name = io.flow.v0.models.Name;
12633
13292
  export type NameForm = io.flow.v0.models.NameForm;
12634
13293
  export type NoInventoryReservationError = io.flow.v0.models.NoInventoryReservationError;
12635
13294
  export type NoInventoryReservationErrorItem = io.flow.v0.models.NoInventoryReservationErrorItem;
12636
- export type NotificationDeleted = io.flow.v0.models.NotificationDeleted;
12637
13295
  export type NotificationDeletedV2 = io.flow.v0.models.NotificationDeletedV2;
12638
- export type NotificationUpserted = io.flow.v0.models.NotificationUpserted;
12639
13296
  export type NotificationUpsertedV2 = io.flow.v0.models.NotificationUpsertedV2;
12640
13297
  export type NumberRange = io.flow.v0.models.NumberRange;
12641
13298
  export type OnlineAuthorization = io.flow.v0.models.OnlineAuthorization;
@@ -12761,6 +13418,7 @@ export type OrganizationRatesPublished = io.flow.v0.models.OrganizationRatesPubl
12761
13418
  export type OrganizationReference = io.flow.v0.models.OrganizationReference;
12762
13419
  export type OrganizationSession = io.flow.v0.models.OrganizationSession;
12763
13420
  export type OrganizationSessionAuthorization = io.flow.v0.models.OrganizationSessionAuthorization;
13421
+ export type OrganizationShippingLabelRatecardSummary = io.flow.v0.models.OrganizationShippingLabelRatecardSummary;
12764
13422
  export type OrganizationShortId = io.flow.v0.models.OrganizationShortId;
12765
13423
  export type OrganizationShortIdDeleted = io.flow.v0.models.OrganizationShortIdDeleted;
12766
13424
  export type OrganizationShortIdUpserted = io.flow.v0.models.OrganizationShortIdUpserted;
@@ -12793,6 +13451,9 @@ export type PaymentAuthorization = io.flow.v0.models.PaymentAuthorization;
12793
13451
  export type PaymentAuthorizationStatus = io.flow.v0.models.PaymentAuthorizationStatus;
12794
13452
  export type PaymentCapture = io.flow.v0.models.PaymentCapture;
12795
13453
  export type PaymentCaptureForm = io.flow.v0.models.PaymentCaptureForm;
13454
+ export type PaymentCaptureOption = io.flow.v0.unions.PaymentCaptureOption;
13455
+ export type PaymentCaptureOptionAutomaticImmediate = io.flow.v0.models.PaymentCaptureOptionAutomaticImmediate;
13456
+ export type PaymentCaptureOptionManual = io.flow.v0.models.PaymentCaptureOptionManual;
12796
13457
  export type PaymentCaptureStatus = io.flow.v0.models.PaymentCaptureStatus;
12797
13458
  export type PaymentCryptopay = io.flow.v0.models.PaymentCryptopay;
12798
13459
  export type PaymentDeleted = io.flow.v0.models.PaymentDeleted;
@@ -12971,6 +13632,7 @@ export type RatecardEstimateFormV2 = io.flow.v0.models.RatecardEstimateFormV2;
12971
13632
  export type RatecardEstimateSummaryForm = io.flow.v0.models.RatecardEstimateSummaryForm;
12972
13633
  export type RatecardEstimateV1 = io.flow.v0.models.RatecardEstimateV1;
12973
13634
  export type RatecardEstimateV2 = io.flow.v0.models.RatecardEstimateV2;
13635
+ export type RatecardEstimateV3 = io.flow.v0.models.RatecardEstimateV3;
12974
13636
  export type RatecardFee = io.flow.v0.unions.RatecardFee;
12975
13637
  export type RatecardForm = io.flow.v0.models.RatecardForm;
12976
13638
  export type RatecardLane = io.flow.v0.models.RatecardLane;
@@ -13125,6 +13787,7 @@ export type ShippingLabel = io.flow.v0.models.ShippingLabel;
13125
13787
  export type ShippingLabelDocument = io.flow.v0.models.ShippingLabelDocument;
13126
13788
  export type ShippingLabelForm = io.flow.v0.unions.ShippingLabelForm;
13127
13789
  export type ShippingLabelPackage = io.flow.v0.models.ShippingLabelPackage;
13790
+ export type ShippingLabelRatecardSummary = io.flow.v0.unions.ShippingLabelRatecardSummary;
13128
13791
  export type ShippingLabelSummary = io.flow.v0.models.ShippingLabelSummary;
13129
13792
  export type ShippingLabelVersion = io.flow.v0.models.ShippingLabelVersion;
13130
13793
  export type ShippingLane = io.flow.v0.models.ShippingLane;