@producerflow/producerflowapi 0.0.13 → 1.0.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.
@@ -79,12 +79,7 @@ export type Address = Message<"producerflow.producer.v1.Address"> & {
79
79
  */
80
80
  export declare const AddressSchema: GenMessage<Address>;
81
81
  /**
82
- * CreateAgencyOnboardingURLRequest contains information needed to generate
83
- * an agency onboarding URL. This includes basic agency information and defaults.
84
- *
85
- * All fields in this request are optional. You can provide as much or as little
86
- * information as you have available. Any missing information will be collected
87
- * from the user during the onboarding process through the generated URL.
82
+ * CreateAgencyOnboardingURLRequest contains information needed to generate an agency onboarding URL. This includes basic agency information and defaults. All fields in this request are optional. You can provide as much or as little information as you have available. Any missing information will be collected from the user during the onboarding process through the generated URL.
88
83
  *
89
84
  * @generated from message producerflow.producer.v1.CreateAgencyOnboardingURLRequest
90
85
  */
@@ -210,18 +205,7 @@ export declare const CreateAgencyOnboardingURLRequest_AgencySchema: GenMessage<C
210
205
  */
211
206
  export type CreateAgencyOnboardingURLRequest_Agency_Principal = Message<"producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency.Principal"> & {
212
207
  /**
213
- * Optional. External identifier for the principal in the tenant's system.
214
- * This field allows tenants to maintain a reference to their own internal ID
215
- * for this principal, enabling bi-directional synchronization between ProducerFlow
216
- * and the tenant's system.
217
- *
218
- * Usage:
219
- * - Provide this when you have an existing identifier for the principal in your system
220
- * - Omit if you don't need to track a reference to your internal system
221
- * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
222
- *
223
- * Format: Any string identifier that is meaningful in your system (e.g., "USR-12345", "uuid")
224
- * Validation: Maximum length of 255 characters
208
+ * Optional. External identifier for the principal in the tenant's system. This field allows tenants to maintain a reference to their own internal ID for this principal, enabling bi-directional synchronization between ProducerFlow and the tenant's system. Usage: Provide this when you have an existing identifier for the principal in your system. Omit if you don't need to track a reference to your internal system. This is independent of ProducerFlow's internal IDs and the authentication tenant context. Format: Any string identifier that is meaningful in your system (e.g., "USR-12345", "uuid"). Validation: Maximum length of 255 characters.
225
209
  *
226
210
  * @generated from field: string tenant_id = 1;
227
211
  */
@@ -420,13 +404,6 @@ export type NewAgencyRequest = Message<"producerflow.producer.v1.NewAgencyReques
420
404
  * @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency agency = 1;
421
405
  */
422
406
  agency?: NewAgencyRequest_Agency;
423
- /**
424
- * Determines if the agency should be auto approved.
425
- *
426
- * @generated from field: bool auto_approve = 2 [deprecated = true];
427
- * @deprecated
428
- */
429
- autoApprove: boolean;
430
407
  /**
431
408
  * Optional. Overrides the tenant's default NIPR sync setting during onboarding.
432
409
  * Most tenants have this enabled by default, so it usually doesn't need to be set.
@@ -565,10 +542,13 @@ export type NewAgencyRequest_Agency = Message<"producerflow.producer.v1.NewAgenc
565
542
  locations: LocationInput[];
566
543
  /**
567
544
  * MetadataQuestions contains custom metadata questions and answers for the agency.
545
+ * The map key is the question identifier/text, and the value is the answer provided.
568
546
  *
569
- * @generated from field: string metadata_questions = 21;
547
+ * @generated from field: map<string, string> metadata_questions = 21;
570
548
  */
571
- metadataQuestions: string;
549
+ metadataQuestions: {
550
+ [key: string]: string;
551
+ };
572
552
  };
573
553
  /**
574
554
  * Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.
@@ -620,18 +600,7 @@ export type NewAgencyRequest_Agency_Principal = Message<"producerflow.producer.v
620
600
  */
621
601
  npn: string;
622
602
  /**
623
- * Optional. External identifier for the principal in the tenant's system.
624
- * This field allows tenants to maintain a reference to their own internal ID
625
- * for this principal, enabling bi-directional synchronization between ProducerFlow
626
- * and the tenant's system.
627
- *
628
- * Usage:
629
- * - Provide this when you have an existing identifier for the principal in your system
630
- * - Omit if you don't need to track a reference to your internal system
631
- * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
632
- *
633
- * Format: Any string identifier that is meaningful in your system (e.g., "USR-12345", "uuid")
634
- * Validation: Maximum length of 255 characters
603
+ * Optional. External identifier for the principal in the tenant's system. This field allows tenants to maintain a reference to their own internal ID for this principal, enabling bi-directional synchronization between ProducerFlow and the tenant's system. Usage: Provide this when you have an existing identifier for the principal in your system. Omit if you don't need to track a reference to your internal system. This is independent of ProducerFlow's internal IDs and the authentication tenant context. Format: Any string identifier that is meaningful in your system (e.g., "USR-12345", "uuid"). Validation: Maximum length of 255 characters.
635
604
  *
636
605
  * @generated from field: string tenant_id = 6;
637
606
  */
@@ -1220,8 +1189,10 @@ export type UpdateProducerRequest_Producer = Message<"producerflow.producer.v1.U
1220
1189
  /**
1221
1190
  * National Producer Number (NPN) of the producer.
1222
1191
  * If provided, must be non-empty.
1192
+ * Deprecated: NPN cannot be updated. This field is ignored and will be removed in a future version.
1223
1193
  *
1224
- * @generated from field: optional string npn = 4;
1194
+ * @generated from field: optional string npn = 4 [deprecated = true];
1195
+ * @deprecated
1225
1196
  */
1226
1197
  npn?: string;
1227
1198
  /**
@@ -1247,7 +1218,7 @@ export type UpdateProducerRequest_Producer = Message<"producerflow.producer.v1.U
1247
1218
  city?: string;
1248
1219
  /**
1249
1220
  * State of the producer.
1250
- * If provided, must be non-empty.
1221
+ * If provided, must be a valid 2-letter US state code.
1251
1222
  *
1252
1223
  * @generated from field: optional string state = 8;
1253
1224
  */
@@ -1277,113 +1248,180 @@ export type UpdateProducerResponse = Message<"producerflow.producer.v1.UpdatePro
1277
1248
  */
1278
1249
  export declare const UpdateProducerResponseSchema: GenMessage<UpdateProducerResponse>;
1279
1250
  /**
1280
- * ListNewProducersRequest requests a list of new producers, optionally filtered by agency.
1251
+ * UpdateAgencyRequest contains the fields that can be updated in an agency record.
1252
+ * Only information collected during the onboarding process can be updated.
1253
+ * Information from NIPR and other third-party sources cannot be updated directly.
1254
+ * All fields are optional, allowing partial updates.
1281
1255
  *
1282
- * @generated from message producerflow.producer.v1.ListNewProducersRequest
1256
+ * @generated from message producerflow.producer.v1.UpdateAgencyRequest
1283
1257
  */
1284
- export type ListNewProducersRequest = Message<"producerflow.producer.v1.ListNewProducersRequest"> & {
1258
+ export type UpdateAgencyRequest = Message<"producerflow.producer.v1.UpdateAgencyRequest"> & {
1285
1259
  /**
1286
- * Optional agency ID to filter producers by.
1287
- * If provided, only producers belonging to this agency will be returned.
1288
- * If not provided, producers from all agencies will be returned.
1260
+ * The ID of the agency to update.
1261
+ * Must be a valid UUID format.
1289
1262
  *
1290
- * @generated from field: optional string agency_id = 1;
1263
+ * @generated from field: string agency_id = 1;
1291
1264
  */
1292
- agencyId?: string;
1265
+ agencyId: string;
1266
+ /**
1267
+ * The agency information to update.
1268
+ *
1269
+ * @generated from field: producerflow.producer.v1.UpdateAgencyRequest.Agency agency = 2;
1270
+ */
1271
+ agency?: UpdateAgencyRequest_Agency;
1293
1272
  };
1294
1273
  /**
1295
- * Describes the message producerflow.producer.v1.ListNewProducersRequest.
1296
- * Use `create(ListNewProducersRequestSchema)` to create a new message.
1274
+ * Describes the message producerflow.producer.v1.UpdateAgencyRequest.
1275
+ * Use `create(UpdateAgencyRequestSchema)` to create a new message.
1297
1276
  */
1298
- export declare const ListNewProducersRequestSchema: GenMessage<ListNewProducersRequest>;
1277
+ export declare const UpdateAgencyRequestSchema: GenMessage<UpdateAgencyRequest>;
1299
1278
  /**
1300
- * ListNewProducersResponse contains a list of new producers that match the filter criteria.
1279
+ * Agency contains the fields that can be updated for an agency.
1280
+ * All fields are optional, allowing partial updates.
1301
1281
  *
1302
- * @generated from message producerflow.producer.v1.ListNewProducersResponse
1282
+ * @generated from message producerflow.producer.v1.UpdateAgencyRequest.Agency
1303
1283
  */
1304
- export type ListNewProducersResponse = Message<"producerflow.producer.v1.ListNewProducersResponse"> & {
1284
+ export type UpdateAgencyRequest_Agency = Message<"producerflow.producer.v1.UpdateAgencyRequest.Agency"> & {
1305
1285
  /**
1306
- * List of new producers matching the filter criteria.
1307
- * These are producers typically in the NEW or pending onboarding state.
1286
+ * Email address of the agency.
1308
1287
  *
1309
- * @generated from field: repeated producerflow.producer.v1.Producer new_producers = 1;
1288
+ * @generated from field: optional string email = 1;
1310
1289
  */
1311
- newProducers: Producer[];
1290
+ email?: string;
1291
+ /**
1292
+ * Phone number of the agency.
1293
+ *
1294
+ * @generated from field: optional string phone = 2;
1295
+ */
1296
+ phone?: string;
1297
+ /**
1298
+ * Fax number of the agency.
1299
+ *
1300
+ * @generated from field: optional string fax = 3;
1301
+ */
1302
+ fax?: string;
1303
+ /**
1304
+ * Website URL of the agency.
1305
+ *
1306
+ * @generated from field: optional string website = 4;
1307
+ */
1308
+ website?: string;
1309
+ /**
1310
+ * List of requested appointments for the agency (state codes).
1311
+ * The list contains a list of two-lettercd country codes where the appointments are requested.
1312
+ * The only valid values are the U.S country codes.
1313
+ *
1314
+ * @generated from field: repeated string requested_appointments = 5;
1315
+ */
1316
+ requestedAppointments: string[];
1317
+ /**
1318
+ * @generated from field: optional string notes = 6;
1319
+ */
1320
+ notes?: string;
1321
+ /**
1322
+ * Physical address of the agency.
1323
+ *
1324
+ * @generated from field: optional producerflow.producer.v1.UpdateAgencyRequest.Agency.Address physical_address = 7;
1325
+ */
1326
+ physicalAddress?: UpdateAgencyRequest_Agency_Address;
1312
1327
  };
1313
1328
  /**
1314
- * Describes the message producerflow.producer.v1.ListNewProducersResponse.
1315
- * Use `create(ListNewProducersResponseSchema)` to create a new message.
1329
+ * Describes the message producerflow.producer.v1.UpdateAgencyRequest.Agency.
1330
+ * Use `create(UpdateAgencyRequest_AgencySchema)` to create a new message.
1316
1331
  */
1317
- export declare const ListNewProducersResponseSchema: GenMessage<ListNewProducersResponse>;
1332
+ export declare const UpdateAgencyRequest_AgencySchema: GenMessage<UpdateAgencyRequest_Agency>;
1318
1333
  /**
1319
- * ApproveProducerRequest requests approval for a producer in the onboarding process.
1334
+ * Address represents a physical location with standard address components.
1335
+ * All fields are optional, allowing partial updates of address fields.
1336
+ * Address fields cannot be cleared - if provided, they must have valid values.
1320
1337
  *
1321
- * @generated from message producerflow.producer.v1.ApproveProducerRequest
1322
- * @deprecated
1338
+ * @generated from message producerflow.producer.v1.UpdateAgencyRequest.Agency.Address
1323
1339
  */
1324
- export type ApproveProducerRequest = Message<"producerflow.producer.v1.ApproveProducerRequest"> & {
1340
+ export type UpdateAgencyRequest_Agency_Address = Message<"producerflow.producer.v1.UpdateAgencyRequest.Agency.Address"> & {
1325
1341
  /**
1326
- * The UUID of the producer to approve.
1327
- * Must be a valid UUID format.
1342
+ * Street address including house/building number and street name.
1343
+ * If provided, must be non-empty.
1328
1344
  *
1329
- * @generated from field: string producer_id = 1;
1345
+ * @generated from field: optional string street = 1;
1330
1346
  */
1331
- producerId: string;
1347
+ street?: string;
1348
+ /**
1349
+ * City of the address.
1350
+ * If provided, must be non-empty.
1351
+ *
1352
+ * @generated from field: optional string city = 2;
1353
+ */
1354
+ city?: string;
1355
+ /**
1356
+ * State of the address.
1357
+ * If provided, must be exactly 2 characters (state code).
1358
+ *
1359
+ * @generated from field: optional string state = 3;
1360
+ */
1361
+ state?: string;
1362
+ /**
1363
+ * Zip code of the address.
1364
+ * If provided, must be between 1 and 10 characters.
1365
+ *
1366
+ * @generated from field: optional string zip = 4;
1367
+ */
1368
+ zip?: string;
1332
1369
  };
1333
1370
  /**
1334
- * Describes the message producerflow.producer.v1.ApproveProducerRequest.
1335
- * Use `create(ApproveProducerRequestSchema)` to create a new message.
1336
- * @deprecated
1371
+ * Describes the message producerflow.producer.v1.UpdateAgencyRequest.Agency.Address.
1372
+ * Use `create(UpdateAgencyRequest_Agency_AddressSchema)` to create a new message.
1337
1373
  */
1338
- export declare const ApproveProducerRequestSchema: GenMessage<ApproveProducerRequest>;
1374
+ export declare const UpdateAgencyRequest_Agency_AddressSchema: GenMessage<UpdateAgencyRequest_Agency_Address>;
1339
1375
  /**
1340
- * ApproveProducerResponse is the empty response returned after successfully approving a producer.
1376
+ * UpdateAgencyResponse is the empty response returned after successfully updating an agency.
1341
1377
  *
1342
- * @generated from message producerflow.producer.v1.ApproveProducerResponse
1378
+ * @generated from message producerflow.producer.v1.UpdateAgencyResponse
1343
1379
  */
1344
- export type ApproveProducerResponse = Message<"producerflow.producer.v1.ApproveProducerResponse"> & {};
1380
+ export type UpdateAgencyResponse = Message<"producerflow.producer.v1.UpdateAgencyResponse"> & {};
1345
1381
  /**
1346
- * Describes the message producerflow.producer.v1.ApproveProducerResponse.
1347
- * Use `create(ApproveProducerResponseSchema)` to create a new message.
1382
+ * Describes the message producerflow.producer.v1.UpdateAgencyResponse.
1383
+ * Use `create(UpdateAgencyResponseSchema)` to create a new message.
1348
1384
  */
1349
- export declare const ApproveProducerResponseSchema: GenMessage<ApproveProducerResponse>;
1385
+ export declare const UpdateAgencyResponseSchema: GenMessage<UpdateAgencyResponse>;
1350
1386
  /**
1351
- * RejectProducerRequest requests rejection of a producer in the onboarding process.
1387
+ * ListNewProducersRequest requests a list of new producers, optionally filtered by agency.
1352
1388
  *
1353
- * @generated from message producerflow.producer.v1.RejectProducerRequest
1389
+ * @generated from message producerflow.producer.v1.ListNewProducersRequest
1354
1390
  */
1355
- export type RejectProducerRequest = Message<"producerflow.producer.v1.RejectProducerRequest"> & {
1356
- /**
1357
- * The UUID of the producer to reject.
1358
- * Must be a valid UUID format.
1359
- *
1360
- * @generated from field: string producer_id = 1;
1361
- */
1362
- producerId: string;
1391
+ export type ListNewProducersRequest = Message<"producerflow.producer.v1.ListNewProducersRequest"> & {
1363
1392
  /**
1364
- * The reason for rejecting the producer.
1365
- * Must be non-empty to provide context for the rejection.
1393
+ * Optional agency ID to filter producers by.
1394
+ * If provided, only producers belonging to this agency will be returned.
1395
+ * If not provided, producers from all agencies will be returned.
1366
1396
  *
1367
- * @generated from field: string reason = 2;
1397
+ * @generated from field: optional string agency_id = 1;
1368
1398
  */
1369
- reason: string;
1399
+ agencyId?: string;
1370
1400
  };
1371
1401
  /**
1372
- * Describes the message producerflow.producer.v1.RejectProducerRequest.
1373
- * Use `create(RejectProducerRequestSchema)` to create a new message.
1402
+ * Describes the message producerflow.producer.v1.ListNewProducersRequest.
1403
+ * Use `create(ListNewProducersRequestSchema)` to create a new message.
1374
1404
  */
1375
- export declare const RejectProducerRequestSchema: GenMessage<RejectProducerRequest>;
1405
+ export declare const ListNewProducersRequestSchema: GenMessage<ListNewProducersRequest>;
1376
1406
  /**
1377
- * RejectProducerResponse is the empty response returned after successfully rejecting a producer.
1407
+ * ListNewProducersResponse contains a list of new producers that match the filter criteria.
1378
1408
  *
1379
- * @generated from message producerflow.producer.v1.RejectProducerResponse
1409
+ * @generated from message producerflow.producer.v1.ListNewProducersResponse
1380
1410
  */
1381
- export type RejectProducerResponse = Message<"producerflow.producer.v1.RejectProducerResponse"> & {};
1411
+ export type ListNewProducersResponse = Message<"producerflow.producer.v1.ListNewProducersResponse"> & {
1412
+ /**
1413
+ * List of new producers matching the filter criteria.
1414
+ * These are producers typically in the NEW or pending onboarding state.
1415
+ *
1416
+ * @generated from field: repeated producerflow.producer.v1.Producer new_producers = 1;
1417
+ */
1418
+ newProducers: Producer[];
1419
+ };
1382
1420
  /**
1383
- * Describes the message producerflow.producer.v1.RejectProducerResponse.
1384
- * Use `create(RejectProducerResponseSchema)` to create a new message.
1421
+ * Describes the message producerflow.producer.v1.ListNewProducersResponse.
1422
+ * Use `create(ListNewProducersResponseSchema)` to create a new message.
1385
1423
  */
1386
- export declare const RejectProducerResponseSchema: GenMessage<RejectProducerResponse>;
1424
+ export declare const ListNewProducersResponseSchema: GenMessage<ListNewProducersResponse>;
1387
1425
  /**
1388
1426
  * Agency represents a complete agency entity with all associated information.
1389
1427
  *
@@ -1553,6 +1591,16 @@ export type Agency_AgencyInfo = Message<"producerflow.producer.v1.Agency.AgencyI
1553
1591
  * @generated from field: bool pdb_alerts_sync_enabled = 10;
1554
1592
  */
1555
1593
  pdbAlertsSyncEnabled: boolean;
1594
+ /**
1595
+ * MetadataQuestions contains custom metadata questions and answers for the agency.
1596
+ * This field stores tenant-specific questions that were collected during agency onboarding.
1597
+ * The map key is the question identifier/text, and the value is the answer provided.
1598
+ *
1599
+ * @generated from field: map<string, string> metadata_questions = 11;
1600
+ */
1601
+ metadataQuestions: {
1602
+ [key: string]: string;
1603
+ };
1556
1604
  };
1557
1605
  /**
1558
1606
  * Describes the message producerflow.producer.v1.Agency.AgencyInfo.
@@ -2354,14 +2402,6 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2354
2402
  * @generated from field: string id = 1;
2355
2403
  */
2356
2404
  id: string;
2357
- /**
2358
- * The full name of the producer.
2359
- * This field is deprecated. Use first_name and last_name instead.
2360
- *
2361
- * @generated from field: string name = 2 [deprecated = true];
2362
- * @deprecated
2363
- */
2364
- name: string;
2365
2405
  /**
2366
2406
  * First name of the producer.
2367
2407
  *
@@ -2423,14 +2463,6 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2423
2463
  * @generated from field: producerflow.producer.v1.Producer.NIPR nipr = 6;
2424
2464
  */
2425
2465
  nipr?: Producer_NIPR;
2426
- /**
2427
- * The status of the producer onboarding process.
2428
- * This field is deprecated and should not be used in new code.
2429
- *
2430
- * @generated from field: producerflow.producer.v1.ProducerOnboardingState onboarding_status = 11 [deprecated = true];
2431
- * @deprecated
2432
- */
2433
- onboardingStatus: ProducerOnboardingState;
2434
2466
  /**
2435
2467
  * Indicates whether this producer is the principal of an agency.
2436
2468
  * A principal producer has additional responsibilities and permissions.
@@ -2456,6 +2488,16 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2456
2488
  * @generated from field: repeated producerflow.producer.v1.Location locations = 19;
2457
2489
  */
2458
2490
  locations: Location[];
2491
+ /**
2492
+ * MetadataQuestions contains custom metadata questions and answers for the producer.
2493
+ * This field stores tenant-specific questions that need to be asked during producer onboarding.
2494
+ * The map key is the question identifier/text, and the value is the answer provided.
2495
+ *
2496
+ * @generated from field: map<string, string> metadata_questions = 40;
2497
+ */
2498
+ metadataQuestions: {
2499
+ [key: string]: string;
2500
+ };
2459
2501
  };
2460
2502
  /**
2461
2503
  * Describes the message producerflow.producer.v1.Producer.
@@ -2986,36 +3028,11 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
2986
3028
  */
2987
3029
  mailingAddress?: NewProducer_Address;
2988
3030
  /**
2989
- * Optional. External identifier for the producer in the tenant's system.
2990
- * This field allows tenants to maintain a reference to their own internal ID
2991
- * for this producer, enabling bi-directional synchronization between ProducerFlow
2992
- * and the tenant's system.
2993
- *
2994
- * Usage:
2995
- * - Provide this when you have an existing identifier for the producer in your system
2996
- * - Omit if you don't need to track a reference to your internal system
2997
- * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
2998
- * - Can be used with SetExternalID RPC to update this value after creation
2999
- *
3000
- * Common use cases:
3001
- * - Linking to an existing CRM or AMS system producer ID
3002
- * - Maintaining synchronization with legacy systems
3003
- * - Enabling lookups from external systems back to ProducerFlow
3004
- *
3005
- * Format: Any string identifier that is meaningful in your system (e.g., "PROD-12345", "uuid")
3006
- * Validation: Maximum length of 255 characters
3031
+ * Optional. External identifier for the producer in the tenant's system. This field allows tenants to maintain a reference to their own internal ID for this producer, enabling bi-directional synchronization between ProducerFlow and the tenant's system. Usage: Provide this when you have an existing identifier for the producer in your system. Omit if you don't need to track a reference to your internal system. This is independent of ProducerFlow's internal IDs and the authentication tenant context. Can be used with SetExternalID RPC to update this value after creation. Common use cases: Linking to an existing CRM or AMS system producer ID. Maintaining synchronization with legacy systems. Enabling lookups from external systems back to ProducerFlow. Format: Any string identifier that is meaningful in your system (e.g., "PROD-12345", "uuid"). Validation: Maximum length of 255 characters.
3007
3032
  *
3008
3033
  * @generated from field: string tenant_id = 8;
3009
3034
  */
3010
3035
  tenantId: string;
3011
- /**
3012
- * Indicates whether the producer should be automatically approved.
3013
- * This field is deprecated and should not be used in new code.
3014
- *
3015
- * @generated from field: bool auto_approve = 9 [deprecated = true];
3016
- * @deprecated
3017
- */
3018
- autoApprove: boolean;
3019
3036
  /**
3020
3037
  * Optional list of location IDs to assign to the producer during creation.
3021
3038
  * All locations must exist and belong to the specified agency.
@@ -3025,10 +3042,13 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
3025
3042
  locationIds: string[];
3026
3043
  /**
3027
3044
  * MetadataQuestions contains custom metadata questions and answers for the producer.
3045
+ * The map key is the question identifier/text, and the value is the answer provided.
3028
3046
  *
3029
- * @generated from field: string metadata_questions = 11;
3047
+ * @generated from field: map<string, string> metadata_questions = 11;
3030
3048
  */
3031
- metadataQuestions: string;
3049
+ metadataQuestions: {
3050
+ [key: string]: string;
3051
+ };
3032
3052
  };
3033
3053
  /**
3034
3054
  * Describes the message producerflow.producer.v1.NewProducer.
@@ -3240,24 +3260,7 @@ export type NewContact = Message<"producerflow.producer.v1.NewContact"> & {
3240
3260
  */
3241
3261
  role: string;
3242
3262
  /**
3243
- * Optional. External identifier for the contact in the tenant's system.
3244
- * This field allows tenants to maintain a reference to their own internal ID
3245
- * for this contact, enabling bi-directional synchronization between ProducerFlow
3246
- * and the tenant's system.
3247
- *
3248
- * Usage:
3249
- * - Provide this when you have an existing identifier for the contact in your system
3250
- * - Omit if you don't need to track a reference to your internal system
3251
- * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
3252
- * - Can be used with SetExternalID RPC to update this value after creation
3253
- *
3254
- * Common use cases:
3255
- * - Linking to an existing CRM or AMS system contact ID
3256
- * - Maintaining synchronization with legacy systems
3257
- * - Enabling lookups from external systems back to ProducerFlow
3258
- *
3259
- * Format: Any string identifier that is meaningful in your system (e.g., "CONT-12345", "uuid")
3260
- * Validation: Maximum length of 255 characters
3263
+ * Optional. External identifier for the contact in the tenant's system. This field allows tenants to maintain a reference to their own internal ID for this contact, enabling bi-directional synchronization between ProducerFlow and the tenant's system. Usage: Provide this when you have an existing identifier for the contact in your system. Omit if you don't need to track a reference to your internal system. This is independent of ProducerFlow's internal IDs and the authentication tenant context. Can be used with SetExternalID RPC to update this value after creation. Common use cases: Linking to an existing CRM or AMS system contact ID. Maintaining synchronization with legacy systems. Enabling lookups from external systems back to ProducerFlow. Format: Any string identifier that is meaningful in your system (e.g., "CONT-12345", "uuid"). Validation: Maximum length of 255 characters
3261
3264
  *
3262
3265
  * @generated from field: string tenant_id = 8;
3263
3266
  */
@@ -3404,6 +3407,152 @@ export type NewContactsResponse = Message<"producerflow.producer.v1.NewContactsR
3404
3407
  * Use `create(NewContactsResponseSchema)` to create a new message.
3405
3408
  */
3406
3409
  export declare const NewContactsResponseSchema: GenMessage<NewContactsResponse>;
3410
+ /**
3411
+ * Contact represents a contact associated with an agency.
3412
+ * Contacts are non-producer individuals linked to the agency.
3413
+ *
3414
+ * @generated from message producerflow.producer.v1.Contact
3415
+ */
3416
+ export type Contact = Message<"producerflow.producer.v1.Contact"> & {
3417
+ /**
3418
+ * Unique identifier for the contact.
3419
+ *
3420
+ * @generated from field: string id = 1;
3421
+ */
3422
+ id: string;
3423
+ /**
3424
+ * First name of the contact.
3425
+ *
3426
+ * @generated from field: string first_name = 2;
3427
+ */
3428
+ firstName: string;
3429
+ /**
3430
+ * Middle name of the contact.
3431
+ *
3432
+ * @generated from field: string middle_name = 3;
3433
+ */
3434
+ middleName: string;
3435
+ /**
3436
+ * Last name of the contact.
3437
+ *
3438
+ * @generated from field: string last_name = 4;
3439
+ */
3440
+ lastName: string;
3441
+ /**
3442
+ * Email address of the contact.
3443
+ * Must be unique within the tenant.
3444
+ *
3445
+ * @generated from field: string email = 5;
3446
+ */
3447
+ email: string;
3448
+ /**
3449
+ * Phone number of the contact.
3450
+ *
3451
+ * @generated from field: string phone = 6;
3452
+ */
3453
+ phone: string;
3454
+ /**
3455
+ * Role or position of the contact within the agency.
3456
+ *
3457
+ * @generated from field: string role = 7;
3458
+ */
3459
+ role: string;
3460
+ /**
3461
+ * @generated from field: producerflow.producer.v1.Contact.Address address = 8;
3462
+ */
3463
+ address?: Contact_Address;
3464
+ /**
3465
+ * National Producer Number (NPN) of the contact, if applicable.
3466
+ *
3467
+ * @generated from field: string npn = 9;
3468
+ */
3469
+ npn: string;
3470
+ /**
3471
+ * When the contact was created.
3472
+ *
3473
+ * @generated from field: google.protobuf.Timestamp created_at = 10;
3474
+ */
3475
+ createdAt?: Timestamp;
3476
+ };
3477
+ /**
3478
+ * Describes the message producerflow.producer.v1.Contact.
3479
+ * Use `create(ContactSchema)` to create a new message.
3480
+ */
3481
+ export declare const ContactSchema: GenMessage<Contact>;
3482
+ /**
3483
+ * Mailing address of the contact.
3484
+ * Address represents a mailing address for the contact.
3485
+ *
3486
+ * @generated from message producerflow.producer.v1.Contact.Address
3487
+ */
3488
+ export type Contact_Address = Message<"producerflow.producer.v1.Contact.Address"> & {
3489
+ /**
3490
+ * Street address of the contact.
3491
+ *
3492
+ * @generated from field: string street = 1;
3493
+ */
3494
+ street: string;
3495
+ /**
3496
+ * City of the contact.
3497
+ *
3498
+ * @generated from field: string city = 2;
3499
+ */
3500
+ city: string;
3501
+ /**
3502
+ * State of the contact.
3503
+ *
3504
+ * @generated from field: string state = 3;
3505
+ */
3506
+ state: string;
3507
+ /**
3508
+ * Zip code of the contact.
3509
+ *
3510
+ * @generated from field: string zip = 4;
3511
+ */
3512
+ zip: string;
3513
+ };
3514
+ /**
3515
+ * Describes the message producerflow.producer.v1.Contact.Address.
3516
+ * Use `create(Contact_AddressSchema)` to create a new message.
3517
+ */
3518
+ export declare const Contact_AddressSchema: GenMessage<Contact_Address>;
3519
+ /**
3520
+ * ListAgencyContactsRequest requests all contacts associated with an agency.
3521
+ *
3522
+ * @generated from message producerflow.producer.v1.ListAgencyContactsRequest
3523
+ */
3524
+ export type ListAgencyContactsRequest = Message<"producerflow.producer.v1.ListAgencyContactsRequest"> & {
3525
+ /**
3526
+ * The UUID of the agency to retrieve contacts for.
3527
+ * Must be a valid UUID format.
3528
+ *
3529
+ * @generated from field: string agency_id = 1;
3530
+ */
3531
+ agencyId: string;
3532
+ };
3533
+ /**
3534
+ * Describes the message producerflow.producer.v1.ListAgencyContactsRequest.
3535
+ * Use `create(ListAgencyContactsRequestSchema)` to create a new message.
3536
+ */
3537
+ export declare const ListAgencyContactsRequestSchema: GenMessage<ListAgencyContactsRequest>;
3538
+ /**
3539
+ * ListAgencyContactsResponse contains all contacts associated with an agency.
3540
+ *
3541
+ * @generated from message producerflow.producer.v1.ListAgencyContactsResponse
3542
+ */
3543
+ export type ListAgencyContactsResponse = Message<"producerflow.producer.v1.ListAgencyContactsResponse"> & {
3544
+ /**
3545
+ * List of all contacts associated with the specified agency.
3546
+ *
3547
+ * @generated from field: repeated producerflow.producer.v1.Contact contacts = 1;
3548
+ */
3549
+ contacts: Contact[];
3550
+ };
3551
+ /**
3552
+ * Describes the message producerflow.producer.v1.ListAgencyContactsResponse.
3553
+ * Use `create(ListAgencyContactsResponseSchema)` to create a new message.
3554
+ */
3555
+ export declare const ListAgencyContactsResponseSchema: GenMessage<ListAgencyContactsResponse>;
3407
3556
  /**
3408
3557
  * SetExternalIDRequest is used to associate an external identifier with a producer, agency, or contact.
3409
3558
  * This allows integration with external systems that use different ID schemes.
@@ -3453,33 +3602,7 @@ export type SetExternalIDRequest = Message<"producerflow.producer.v1.SetExternal
3453
3602
  value?: undefined;
3454
3603
  };
3455
3604
  /**
3456
- * External identifier to associate with the entity in the tenant's system.
3457
- * This field allows tenants to maintain a reference to their own internal ID
3458
- * for the specified entity (producer, agency, contact, or organization), enabling
3459
- * bi-directional synchronization between ProducerFlow and the tenant's system.
3460
- *
3461
- * Purpose:
3462
- * - Links ProducerFlow entities to corresponding entities in external systems
3463
- * - Enables lookups and synchronization across systems
3464
- * - Maintains referential integrity with tenant's internal databases
3465
- *
3466
- * Usage:
3467
- * - Call this RPC after creating an entity if you need to add or update the external reference
3468
- * - This can also be provided during entity creation for producers and contacts
3469
- * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
3470
- *
3471
- * Relationship to authentication:
3472
- * - The tenant context is determined by the API key used for authentication
3473
- * - This tenant_id field is purely for storing the tenant's own external identifier
3474
- * - Multiple tenants cannot share the same entity; each tenant has their own isolated data
3475
- *
3476
- * Common use cases:
3477
- * - Syncing with CRM systems (e.g., Salesforce IDs, HubSpot IDs)
3478
- * - Integrating with AMS platforms (e.g., Applied Epic, Vertafore)
3479
- * - Maintaining references to legacy system identifiers
3480
- *
3481
- * Format: Any string identifier that is meaningful in your system (e.g., "SF-001234", "LEGACY-9876")
3482
- * Validation: Must be non-empty, maximum length of 255 characters
3605
+ * External identifier to associate with the entity in the tenant's system. This field allows tenants to maintain a reference to their own internal ID for the specified entity (producer, agency, contact, or organization), enabling bi-directional synchronization between ProducerFlow and the tenant's system. Purpose: Links ProducerFlow entities to corresponding entities in external systems. Enables lookups and synchronization across systems. Maintains referential integrity with tenant's internal databases. Usage: Call this RPC after creating an entity if you need to add or update the external reference. This can also be provided during entity creation for producers and contacts. This is independent of ProducerFlow's internal IDs and the authentication tenant context. Relationship to authentication: The tenant context is determined by the API key used for authentication. This tenant_id field is purely for storing the tenant's own external identifier. Multiple tenants cannot share the same entity; each tenant has their own isolated data. Common use cases: Syncing with CRM systems (e.g., Salesforce IDs, HubSpot IDs). Integrating with AMS platforms (e.g., Applied Epic, Vertafore). Maintaining references to legacy system identifiers. Format: Any string identifier that is meaningful in your system (e.g., "SF-001234", "LEGACY-9876"). Validation: Must be non-empty, maximum length of 255 characters
3483
3606
  *
3484
3607
  * @generated from field: string tenant_id = 4;
3485
3608
  */
@@ -3983,7 +4106,15 @@ export declare const ListAgenciesResponseSchema: GenMessage<ListAgenciesResponse
3983
4106
  *
3984
4107
  * @generated from message producerflow.producer.v1.ListOrganizationsRequest
3985
4108
  */
3986
- export type ListOrganizationsRequest = Message<"producerflow.producer.v1.ListOrganizationsRequest"> & {};
4109
+ export type ListOrganizationsRequest = Message<"producerflow.producer.v1.ListOrganizationsRequest"> & {
4110
+ /**
4111
+ * Optional. Pagination parameters.
4112
+ * If not provided, defaults to page_size=50.
4113
+ *
4114
+ * @generated from field: producerflow.producer.v1.Pagination pagination = 1;
4115
+ */
4116
+ pagination?: Pagination;
4117
+ };
3987
4118
  /**
3988
4119
  * Describes the message producerflow.producer.v1.ListOrganizationsRequest.
3989
4120
  * Use `create(ListOrganizationsRequestSchema)` to create a new message.
@@ -4018,6 +4149,12 @@ export type Organization = Message<"producerflow.producer.v1.Organization"> & {
4018
4149
  * @generated from field: string external_id = 3;
4019
4150
  */
4020
4151
  externalId: string;
4152
+ /**
4153
+ * Contact email address for the organization.
4154
+ *
4155
+ * @generated from field: string email = 4;
4156
+ */
4157
+ email: string;
4021
4158
  };
4022
4159
  /**
4023
4160
  * Describes the message producerflow.producer.v1.Organization.
@@ -4026,7 +4163,7 @@ export type Organization = Message<"producerflow.producer.v1.Organization"> & {
4026
4163
  export declare const OrganizationSchema: GenMessage<Organization>;
4027
4164
  /**
4028
4165
  * ListOrganizationsResponse contains the list of organizations associated with the tenant.
4029
- * The organizations are returned in no particular order. If the tenant has no organizations,
4166
+ * The organizations are returned ordered by name. If the tenant has no organizations,
4030
4167
  * the organizations list will be empty.
4031
4168
  *
4032
4169
  * @generated from message producerflow.producer.v1.ListOrganizationsResponse
@@ -4036,16 +4173,67 @@ export type ListOrganizationsResponse = Message<"producerflow.producer.v1.ListOr
4036
4173
  * List of organizations associated with the tenant.
4037
4174
  * Each organization includes its unique identifier and display name.
4038
4175
  * The list may be empty if no organizations are associated with the tenant.
4176
+ * Organizations are ordered alphabetically by name.
4039
4177
  *
4040
4178
  * @generated from field: repeated producerflow.producer.v1.Organization organizations = 1;
4041
4179
  */
4042
4180
  organizations: Organization[];
4181
+ /**
4182
+ * A token that can be sent as `page_token` to retrieve the next page.
4183
+ * If this field is omitted, there are no subsequent pages.
4184
+ *
4185
+ * @generated from field: string next_page_token = 2;
4186
+ */
4187
+ nextPageToken: string;
4188
+ /**
4189
+ * Total number of organizations matching the filter criteria.
4190
+ *
4191
+ * @generated from field: int32 total_count = 3;
4192
+ */
4193
+ totalCount: number;
4043
4194
  };
4044
4195
  /**
4045
4196
  * Describes the message producerflow.producer.v1.ListOrganizationsResponse.
4046
4197
  * Use `create(ListOrganizationsResponseSchema)` to create a new message.
4047
4198
  */
4048
4199
  export declare const ListOrganizationsResponseSchema: GenMessage<ListOrganizationsResponse>;
4200
+ /**
4201
+ * GetOrganizationRequest specifies which organization to retrieve.
4202
+ *
4203
+ * @generated from message producerflow.producer.v1.GetOrganizationRequest
4204
+ */
4205
+ export type GetOrganizationRequest = Message<"producerflow.producer.v1.GetOrganizationRequest"> & {
4206
+ /**
4207
+ * Unique identifier of the organization to retrieve.
4208
+ * Must be a valid UUID.
4209
+ *
4210
+ * @generated from field: string organization_id = 1;
4211
+ */
4212
+ organizationId: string;
4213
+ };
4214
+ /**
4215
+ * Describes the message producerflow.producer.v1.GetOrganizationRequest.
4216
+ * Use `create(GetOrganizationRequestSchema)` to create a new message.
4217
+ */
4218
+ export declare const GetOrganizationRequestSchema: GenMessage<GetOrganizationRequest>;
4219
+ /**
4220
+ * GetOrganizationResponse contains the details of the requested organization.
4221
+ *
4222
+ * @generated from message producerflow.producer.v1.GetOrganizationResponse
4223
+ */
4224
+ export type GetOrganizationResponse = Message<"producerflow.producer.v1.GetOrganizationResponse"> & {
4225
+ /**
4226
+ * The requested organization.
4227
+ *
4228
+ * @generated from field: producerflow.producer.v1.Organization organization = 1;
4229
+ */
4230
+ organization?: Organization;
4231
+ };
4232
+ /**
4233
+ * Describes the message producerflow.producer.v1.GetOrganizationResponse.
4234
+ * Use `create(GetOrganizationResponseSchema)` to create a new message.
4235
+ */
4236
+ export declare const GetOrganizationResponseSchema: GenMessage<GetOrganizationResponse>;
4049
4237
  /**
4050
4238
  * CreateProducerUploadURLRequest contains information needed to generate
4051
4239
  * a producer upload URL. This includes the agency NPN.
@@ -4561,47 +4749,15 @@ export declare enum NIPRSyncState {
4561
4749
  * Describes the enum producerflow.producer.v1.NIPRSyncState.
4562
4750
  */
4563
4751
  export declare const NIPRSyncStateSchema: GenEnum<NIPRSyncState>;
4564
- /**
4565
- * ProducerOnboardingState defines the possible states in the producer onboarding workflow.
4566
- * This enum is deprecated and should not be used in new code.
4567
- *
4568
- * @generated from enum producerflow.producer.v1.ProducerOnboardingState
4569
- * @deprecated
4570
- */
4571
- export declare enum ProducerOnboardingState {
4572
- /**
4573
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_UNSPECIFIED = 0;
4574
- */
4575
- UNSPECIFIED = 0,
4576
- /**
4577
- * The producer has been added to the agency and is awaiting approval from the tenant.
4578
- *
4579
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_NEW = 1;
4580
- */
4581
- NEW = 1,
4582
- /**
4583
- * The producer has been approved by the tenant.
4584
- *
4585
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_APPROVED_BY_TENANT = 2;
4586
- */
4587
- APPROVED_BY_TENANT = 2,
4588
- /**
4589
- * The producer has been rejected by the tenant.
4590
- *
4591
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_REJECTED_BY_TENANT = 3;
4592
- */
4593
- REJECTED_BY_TENANT = 3
4594
- }
4595
- /**
4596
- * Describes the enum producerflow.producer.v1.ProducerOnboardingState.
4597
- * @deprecated
4598
- */
4599
- export declare const ProducerOnboardingStateSchema: GenEnum<ProducerOnboardingState>;
4600
4752
  /**
4601
4753
  * ProducerService provides a comprehensive API for managing insurance producers
4602
4754
  * and agencies, including onboarding, data synchronization, and integration with
4603
4755
  * external systems like NIPR for license verification.
4604
4756
  *
4757
+ * Available endpoints:
4758
+ * UAT (User Acceptance Testing): https://api.uat.producerflow.com
4759
+ * Production: https://api.producerflow.com
4760
+ *
4605
4761
  * RPCs for starting the onboarding agency process.
4606
4762
  *
4607
4763
  * @generated from service producerflow.producer.v1.ProducerService
@@ -4636,18 +4792,7 @@ export declare const ProducerService: GenService<{
4636
4792
  output: typeof CreateProducerOnboardingURLResponseSchema;
4637
4793
  };
4638
4794
  /**
4639
- * NewAgency creates a new agency, optionally with associated producers.
4640
- * It performs the following validation checks:
4641
- * - Ensures all required fields are present and valid
4642
- * - Checks whether the NPN is already registered
4643
- * - Verifies agency and principal information with NIPR
4644
- *
4645
- * Business rules:
4646
- * - Sole proprietors can't have an agency NPN or additional producers
4647
- * - Regular agencies must provide either an NPN or a FEIN
4648
- *
4649
- * If validation passes, it creates the agency, principal, and any producers.
4650
- * Returns the IDs of the created agency, principal, and producers.
4795
+ * NewAgency creates a new agency, optionally with associated producers. It performs the following validation checks: Ensures all required fields are present and valid. Checks whether the NPN is already registered. Verifies agency and principal information with NIPR. Business rules: Sole proprietors can't have an agency NPN or additional producers. Regular agencies must provide either an NPN or a FEIN. If validation passes, it creates the agency, principal, and any producers. Returns the IDs of the created agency, principal, and producers.
4651
4796
  *
4652
4797
  * @generated from rpc producerflow.producer.v1.ProducerService.NewAgency
4653
4798
  */
@@ -4679,6 +4824,17 @@ export declare const ProducerService: GenService<{
4679
4824
  input: typeof ListOrganizationsRequestSchema;
4680
4825
  output: typeof ListOrganizationsResponseSchema;
4681
4826
  };
4827
+ /**
4828
+ * GetOrganization retrieves details of a specific organization by ID.
4829
+ * Returns the organization's information including name and external ID.
4830
+ *
4831
+ * @generated from rpc producerflow.producer.v1.ProducerService.GetOrganization
4832
+ */
4833
+ getOrganization: {
4834
+ methodKind: "unary";
4835
+ input: typeof GetOrganizationRequestSchema;
4836
+ output: typeof GetOrganizationResponseSchema;
4837
+ };
4682
4838
  /**
4683
4839
  * NewProducer creates a new producer and associates them with an existing agency.
4684
4840
  * It validates the producer's information and checks that the email is unique.
@@ -4751,30 +4907,19 @@ export declare const ProducerService: GenService<{
4751
4907
  output: typeof UpdateProducerResponseSchema;
4752
4908
  };
4753
4909
  /**
4754
- * ApproveProducer changes a producer's onboarding state to APPROVED.
4755
- * This typically happens after all verification steps are complete.
4756
- * This method is deprecated. Use SyncProducerWithNIPR instead.
4757
- *
4758
- * @generated from rpc producerflow.producer.v1.ProducerService.ApproveProducer
4759
- * @deprecated
4760
- */
4761
- approveProducer: {
4762
- methodKind: "unary";
4763
- input: typeof ApproveProducerRequestSchema;
4764
- output: typeof ApproveProducerResponseSchema;
4765
- };
4766
- /**
4767
- * RejectProducer changes a producer's onboarding state to REJECTED.
4768
- * An optional reason for rejection can be provided.
4769
- * This method is deprecated. Use StopSyncAgencyWithNIPR instead.
4910
+ * UpdateAgency updates information for an existing agency.
4911
+ * Supports updating contact details (email, phone, fax), website, physical address,
4912
+ * requested appointments, and notes.
4913
+ * Information from NIPR and other third-party sources cannot be updated.
4914
+ * All fields are optional - only provide the fields you want to update.
4915
+ * Validates email uniqueness if the email is changed.
4770
4916
  *
4771
- * @generated from rpc producerflow.producer.v1.ProducerService.RejectProducer
4772
- * @deprecated
4917
+ * @generated from rpc producerflow.producer.v1.ProducerService.UpdateAgency
4773
4918
  */
4774
- rejectProducer: {
4919
+ updateAgency: {
4775
4920
  methodKind: "unary";
4776
- input: typeof RejectProducerRequestSchema;
4777
- output: typeof RejectProducerResponseSchema;
4921
+ input: typeof UpdateAgencyRequestSchema;
4922
+ output: typeof UpdateAgencyResponseSchema;
4778
4923
  };
4779
4924
  /**
4780
4925
  * NewContact creates a new contact associated with an agency.
@@ -4800,6 +4945,17 @@ export declare const ProducerService: GenService<{
4800
4945
  input: typeof NewContactsRequestSchema;
4801
4946
  output: typeof NewContactsResponseSchema;
4802
4947
  };
4948
+ /**
4949
+ * ListAgencyContacts retrieves all contacts associated with an agency.
4950
+ * Returns a list of contacts with their full details.
4951
+ *
4952
+ * @generated from rpc producerflow.producer.v1.ProducerService.ListAgencyContacts
4953
+ */
4954
+ listAgencyContacts: {
4955
+ methodKind: "unary";
4956
+ input: typeof ListAgencyContactsRequestSchema;
4957
+ output: typeof ListAgencyContactsResponseSchema;
4958
+ };
4803
4959
  /**
4804
4960
  * SetExternalID sets an external identifier for a producer or contact.
4805
4961
  * Useful for integrating with external systems that use different ID schemes.
@@ -4848,12 +5004,7 @@ export declare const ProducerService: GenService<{
4848
5004
  output: typeof LookupNPNByFEINResponseSchema;
4849
5005
  };
4850
5006
  /**
4851
- * ResyncProducer triggers a manual resynchronization of a producers data.
4852
- * This can be used to refresh data after external changes.
4853
- *
4854
- * WARNING: This call counts as an additional NPN lookup for billing purposes.
4855
- * Most billing plans are based on unique NPNs per month, so using this
4856
- * method may result in extra charges.
5007
+ * ResyncProducer triggers a manual resynchronization of a producer's data. This can be used to refresh data after external changes. WARNING: This call counts as an additional NPN lookup for billing purposes. Most billing plans are based on unique NPNs per month, so using this method may result in extra charges.
4857
5008
  *
4858
5009
  * @generated from rpc producerflow.producer.v1.ProducerService.ResyncProducer
4859
5010
  */
@@ -4863,12 +5014,7 @@ export declare const ProducerService: GenService<{
4863
5014
  output: typeof ResyncProducerResponseSchema;
4864
5015
  };
4865
5016
  /**
4866
- * ResyncAgency triggers a manual resynchronization of an agencys data.
4867
- * Similar to ResyncProducer, this can be used to refresh data after external changes.
4868
- *
4869
- * WARNING: This call counts as an additional NPN lookup for billing purposes.
4870
- * Most billing plans are based on unique NPNs per month, so using this
4871
- * method may result in extra charges.
5017
+ * ResyncAgency triggers a manual resynchronization of an agency's data. Similar to ResyncProducer, this can be used to refresh data after external changes. WARNING: This call counts as an additional NPN lookup for billing purposes. Most billing plans are based on unique NPNs per month, so using this method may result in extra charges.
4872
5018
  *
4873
5019
  * @generated from rpc producerflow.producer.v1.ProducerService.ResyncAgency
4874
5020
  */
@@ -4878,12 +5024,7 @@ export declare const ProducerService: GenService<{
4878
5024
  output: typeof ResyncAgencyResponseSchema;
4879
5025
  };
4880
5026
  /**
4881
- * SyncAgencyWithNIPR synchronizes an producers data with the NIPR system.
4882
- * Fetches the latest producer information and appointments.
4883
- *
4884
- * WARNING: This call counts as an extra NPN lookup against your billing.
4885
- * Most billing plans are based on unique NPNs per month, so using this
4886
- * method may result in additional charges.
5027
+ * SyncProducerWithNIPR synchronizes a producer's data with the NIPR system. Fetches the latest producer information and appointments. WARNING: This call counts as an extra NPN lookup against your billing. Most billing plans are based on unique NPNs per month, so using this method may result in additional charges.
4887
5028
  *
4888
5029
  * @generated from rpc producerflow.producer.v1.ProducerService.SyncProducerWithNIPR
4889
5030
  */
@@ -4893,12 +5034,7 @@ export declare const ProducerService: GenService<{
4893
5034
  output: typeof SyncProducerWithNIPRResponseSchema;
4894
5035
  };
4895
5036
  /**
4896
- * SyncAgencyWithNIPR synchronizes an agencys data with the NIPR system.
4897
- * Fetches the latest agency information and appointments.
4898
- *
4899
- * WARNING: This call counts as an extra NPN lookup against your billing.
4900
- * Most billing plans are based on unique NPNs per month, so using this
4901
- * method may result in additional charges.
5037
+ * SyncAgencyWithNIPR synchronizes an agency's data with the NIPR system. Fetches the latest agency information and appointments. WARNING: This call counts as an extra NPN lookup against your billing. Most billing plans are based on unique NPNs per month, so using this method may result in additional charges.
4902
5038
  *
4903
5039
  * @generated from rpc producerflow.producer.v1.ProducerService.SyncAgencyWithNIPR
4904
5040
  */
@@ -4930,21 +5066,7 @@ export declare const ProducerService: GenService<{
4930
5066
  output: typeof StopSyncAgencyWithNIPRResponseSchema;
4931
5067
  };
4932
5068
  /**
4933
- * CreateProducerUploadURL generates a URL that can be used to upload new producers for an existing agency.
4934
- * The agency is identified by its NPN, and the URL can be shared with the agency to allow them to
4935
- * upload producer information securely.
4936
- *
4937
- * The URL is time-limited and includes necessary security tokens. A default expiration of 7 days will be used.
4938
- *
4939
- * The agency must:
4940
- * - Exist and belong to the authenticated tenant
4941
- * - Have a valid NPN
4942
- *
4943
- * Returns a URL string that can be shared with the agency for producer uploads.
4944
- * Returns errors in the following cases:
4945
- * - INVALID_ARGUMENT: if agency NPN is empty or invalid format
4946
- * - NOT_FOUND: if agency NPN doesn't exist
4947
- * - INTERNAL: for other unexpected errors
5069
+ * CreateProducerUploadURL generates a URL that can be used to upload new producers for an existing agency. The agency is identified by its NPN, and the URL can be shared with the agency to allow them to upload producer information securely. The URL is time-limited and includes necessary security tokens. A default expiration of 7 days will be used. The agency must: Exist and belong to the authenticated tenant. Have a valid NPN. Returns a URL string that can be shared with the agency for producer uploads. Returns errors in the following cases: INVALID_ARGUMENT: if agency NPN is empty or invalid format. NOT_FOUND: if agency NPN doesn't exist. INTERNAL: for other unexpected errors.
4948
5070
  *
4949
5071
  * @generated from rpc producerflow.producer.v1.ProducerService.CreateProducerUploadURL
4950
5072
  */
@@ -4954,20 +5076,7 @@ export declare const ProducerService: GenService<{
4954
5076
  output: typeof CreateProducerUploadURLResponseSchema;
4955
5077
  };
4956
5078
  /**
4957
- * AddAgencyLocations adds one or more locations to an existing agency.
4958
- *
4959
- * Each location must have a unique name within the agency and valid address information.
4960
- * You can add up to 100 locations in a single request. This is a bulk operation with
4961
- * all-or-nothing behavior - if any location fails validation, the entire request will
4962
- * fail and no locations will be added.
4963
- *
4964
- * Returns the IDs of successfully added locations.
4965
- *
4966
- * Returns errors in the following cases:
4967
- * - UNAUTHENTICATED: if the API key is invalid or missing.
4968
- * - INVALID_ARGUMENT: if the request is nil, agency_id is empty, no locations provided,
4969
- * location names are duplicated within the request or already exist for the agency.
4970
- * - NOT_FOUND: if the agency doesn't exist or doesn't belong to the authenticated tenant.
5079
+ * AddAgencyLocations adds one or more locations to an existing agency. Each location must have a unique name within the agency and valid address information. You can add up to 100 locations in a single request. This is a bulk operation with all-or-nothing behavior - if any location fails validation, the entire request will fail and no locations will be added. Returns the IDs of successfully added locations. Returns errors in the following cases: UNAUTHENTICATED: if the API key is invalid or missing. INVALID_ARGUMENT: if the request is nil, agency_id is empty, no locations provided, location names are duplicated within the request or already exist for the agency. NOT_FOUND: if the agency doesn't exist or doesn't belong to the authenticated tenant.
4971
5080
  *
4972
5081
  * @generated from rpc producerflow.producer.v1.ProducerService.AddAgencyLocations
4973
5082
  */
@@ -4977,14 +5086,7 @@ export declare const ProducerService: GenService<{
4977
5086
  output: typeof AddAgencyLocationsResponseSchema;
4978
5087
  };
4979
5088
  /**
4980
- * RemoveAgencyLocations removes one or more locations from an agency.
4981
- *
4982
- * Locations that don't exist will be silently ignored. Returns the IDs of successfully removed locations.
4983
- * When a location is removed, all the producers associated with that location will be unassigned from that location.
4984
- * Returns errors in the following cases:
4985
- * - UNAUTHENTICATED: if the API key is invalid or missing.
4986
- * - INVALID_ARGUMENT: if the request is nil, agency_id is empty, or no location_ids provided.
4987
- * - NOT_FOUND: if the agency doesn't exist or doesn't belong to the authenticated tenant.
5089
+ * RemoveAgencyLocations removes one or more locations from an agency. Locations that don't exist will be silently ignored. Returns the IDs of successfully removed locations. When a location is removed, all the producers associated with that location will be unassigned from that location. Returns errors in the following cases: UNAUTHENTICATED: if the API key is invalid or missing. INVALID_ARGUMENT: if the request is nil, agency_id is empty, or no location_ids provided. NOT_FOUND: if the agency doesn't exist or doesn't belong to the authenticated tenant.
4988
5090
  *
4989
5091
  * @generated from rpc producerflow.producer.v1.ProducerService.RemoveAgencyLocations
4990
5092
  */
@@ -4994,12 +5096,7 @@ export declare const ProducerService: GenService<{
4994
5096
  output: typeof RemoveAgencyLocationsResponseSchema;
4995
5097
  };
4996
5098
  /**
4997
- * ListAgencyLocations retrieves all locations associated with an agency.
4998
- *
4999
- * Returns errors in the following cases:
5000
- * - UNAUTHENTICATED: if the API key is invalid or missing.
5001
- * - INVALID_ARGUMENT: if the agency_id is empty.
5002
- * - NOT_FOUND: if the agency doesn't exist.
5099
+ * ListAgencyLocations retrieves all locations associated with an agency. Returns errors in the following cases: UNAUTHENTICATED: if the API key is invalid or missing. INVALID_ARGUMENT: if the agency_id is empty. NOT_FOUND: if the agency doesn't exist.
5003
5100
  *
5004
5101
  * @generated from rpc producerflow.producer.v1.ProducerService.ListAgencyLocations
5005
5102
  */
@@ -5009,14 +5106,7 @@ export declare const ProducerService: GenService<{
5009
5106
  output: typeof ListAgencyLocationsResponseSchema;
5010
5107
  };
5011
5108
  /**
5012
- * AssignProducerToLocations assigns one or more locations to a producer.
5013
- * The locations must belong to the same agency as the producer.
5014
- *
5015
- * Error cases:
5016
- * - UNAUTHENTICATED: Invalid or missing API key
5017
- * - INVALID_ARGUMENT: Empty producer_id or no location_ids
5018
- * - NOT_FOUND: Producer or locations don't exist
5019
- * - PERMISSION_DENIED: Locations don't belong to the producer's agency
5109
+ * AssignProducerToLocations assigns one or more locations to a producer. The locations must belong to the same agency as the producer. Error cases: UNAUTHENTICATED: Invalid or missing API key. INVALID_ARGUMENT: Empty producer_id or no location_ids. NOT_FOUND: Producer or locations don't exist. PERMISSION_DENIED: Locations don't belong to the producer's agency.
5020
5110
  *
5021
5111
  * @generated from rpc producerflow.producer.v1.ProducerService.AssignProducerToLocations
5022
5112
  */
@@ -5026,13 +5116,7 @@ export declare const ProducerService: GenService<{
5026
5116
  output: typeof AssignProducerToLocationsResponseSchema;
5027
5117
  };
5028
5118
  /**
5029
- * UnassignProducerFromLocations removes one or more location assignments from a producer.
5030
- * The locations must belong to the same agency as the producer.
5031
- *
5032
- * Error cases:
5033
- * - UNAUTHENTICATED: Invalid or missing API key
5034
- * - INVALID_ARGUMENT: Empty producer_id or no location_ids
5035
- * - NOT_FOUND: Producer doesn't exist
5119
+ * UnassignProducerFromLocations removes one or more location assignments from a producer. The locations must belong to the same agency as the producer. Error cases: UNAUTHENTICATED: Invalid or missing API key. INVALID_ARGUMENT: Empty producer_id or no location_ids. NOT_FOUND: Producer doesn't exist.
5036
5120
  *
5037
5121
  * @generated from rpc producerflow.producer.v1.ProducerService.UnassignProducerFromLocations
5038
5122
  */
@@ -5042,17 +5126,7 @@ export declare const ProducerService: GenService<{
5042
5126
  output: typeof UnassignProducerFromLocationsResponseSchema;
5043
5127
  };
5044
5128
  /**
5045
- * UpdateAgencyLocation updates an existing agency location.
5046
- * You can update the name, address, contact information, and primary status of a location.
5047
- * All fields are optional - only provide the fields you want to update.
5048
- * Location name must be unique within the agency.
5049
- * Returns the updated location details.
5050
- *
5051
- * Error cases:
5052
- * - UNAUTHENTICATED: Invalid or missing API key
5053
- * - INVALID_ARGUMENT: Missing agency_id or location_id
5054
- * - NOT_FOUND: Agency or location doesn't exist
5055
- * - ALREADY_EXISTS: Location name already exists within the agency
5129
+ * UpdateAgencyLocation updates an existing agency location. You can update the name, address, contact information, and primary status of a location. All fields are optional - only provide the fields you want to update. Location name must be unique within the agency. Returns the updated location details. Error cases: UNAUTHENTICATED: Invalid or missing API key. INVALID_ARGUMENT: Missing agency_id or location_id. NOT_FOUND: Agency or location doesn't exist. ALREADY_EXISTS: Location name already exists within the agency.
5056
5130
  *
5057
5131
  * @generated from rpc producerflow.producer.v1.ProducerService.UpdateAgencyLocation
5058
5132
  */