@producerflow/producerflowapi 0.0.13 → 0.0.14

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
  */
@@ -1247,7 +1216,7 @@ export type UpdateProducerRequest_Producer = Message<"producerflow.producer.v1.U
1247
1216
  city?: string;
1248
1217
  /**
1249
1218
  * State of the producer.
1250
- * If provided, must be non-empty.
1219
+ * If provided, must be a valid 2-letter US state code.
1251
1220
  *
1252
1221
  * @generated from field: optional string state = 8;
1253
1222
  */
@@ -1315,75 +1284,6 @@ export type ListNewProducersResponse = Message<"producerflow.producer.v1.ListNew
1315
1284
  * Use `create(ListNewProducersResponseSchema)` to create a new message.
1316
1285
  */
1317
1286
  export declare const ListNewProducersResponseSchema: GenMessage<ListNewProducersResponse>;
1318
- /**
1319
- * ApproveProducerRequest requests approval for a producer in the onboarding process.
1320
- *
1321
- * @generated from message producerflow.producer.v1.ApproveProducerRequest
1322
- * @deprecated
1323
- */
1324
- export type ApproveProducerRequest = Message<"producerflow.producer.v1.ApproveProducerRequest"> & {
1325
- /**
1326
- * The UUID of the producer to approve.
1327
- * Must be a valid UUID format.
1328
- *
1329
- * @generated from field: string producer_id = 1;
1330
- */
1331
- producerId: string;
1332
- };
1333
- /**
1334
- * Describes the message producerflow.producer.v1.ApproveProducerRequest.
1335
- * Use `create(ApproveProducerRequestSchema)` to create a new message.
1336
- * @deprecated
1337
- */
1338
- export declare const ApproveProducerRequestSchema: GenMessage<ApproveProducerRequest>;
1339
- /**
1340
- * ApproveProducerResponse is the empty response returned after successfully approving a producer.
1341
- *
1342
- * @generated from message producerflow.producer.v1.ApproveProducerResponse
1343
- */
1344
- export type ApproveProducerResponse = Message<"producerflow.producer.v1.ApproveProducerResponse"> & {};
1345
- /**
1346
- * Describes the message producerflow.producer.v1.ApproveProducerResponse.
1347
- * Use `create(ApproveProducerResponseSchema)` to create a new message.
1348
- */
1349
- export declare const ApproveProducerResponseSchema: GenMessage<ApproveProducerResponse>;
1350
- /**
1351
- * RejectProducerRequest requests rejection of a producer in the onboarding process.
1352
- *
1353
- * @generated from message producerflow.producer.v1.RejectProducerRequest
1354
- */
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;
1363
- /**
1364
- * The reason for rejecting the producer.
1365
- * Must be non-empty to provide context for the rejection.
1366
- *
1367
- * @generated from field: string reason = 2;
1368
- */
1369
- reason: string;
1370
- };
1371
- /**
1372
- * Describes the message producerflow.producer.v1.RejectProducerRequest.
1373
- * Use `create(RejectProducerRequestSchema)` to create a new message.
1374
- */
1375
- export declare const RejectProducerRequestSchema: GenMessage<RejectProducerRequest>;
1376
- /**
1377
- * RejectProducerResponse is the empty response returned after successfully rejecting a producer.
1378
- *
1379
- * @generated from message producerflow.producer.v1.RejectProducerResponse
1380
- */
1381
- export type RejectProducerResponse = Message<"producerflow.producer.v1.RejectProducerResponse"> & {};
1382
- /**
1383
- * Describes the message producerflow.producer.v1.RejectProducerResponse.
1384
- * Use `create(RejectProducerResponseSchema)` to create a new message.
1385
- */
1386
- export declare const RejectProducerResponseSchema: GenMessage<RejectProducerResponse>;
1387
1287
  /**
1388
1288
  * Agency represents a complete agency entity with all associated information.
1389
1289
  *
@@ -1553,6 +1453,16 @@ export type Agency_AgencyInfo = Message<"producerflow.producer.v1.Agency.AgencyI
1553
1453
  * @generated from field: bool pdb_alerts_sync_enabled = 10;
1554
1454
  */
1555
1455
  pdbAlertsSyncEnabled: boolean;
1456
+ /**
1457
+ * MetadataQuestions contains custom metadata questions and answers for the agency.
1458
+ * This field stores tenant-specific questions that were collected during agency onboarding.
1459
+ * The map key is the question identifier/text, and the value is the answer provided.
1460
+ *
1461
+ * @generated from field: map<string, string> metadata_questions = 11;
1462
+ */
1463
+ metadataQuestions: {
1464
+ [key: string]: string;
1465
+ };
1556
1466
  };
1557
1467
  /**
1558
1468
  * Describes the message producerflow.producer.v1.Agency.AgencyInfo.
@@ -2354,14 +2264,6 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2354
2264
  * @generated from field: string id = 1;
2355
2265
  */
2356
2266
  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
2267
  /**
2366
2268
  * First name of the producer.
2367
2269
  *
@@ -2423,14 +2325,6 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2423
2325
  * @generated from field: producerflow.producer.v1.Producer.NIPR nipr = 6;
2424
2326
  */
2425
2327
  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
2328
  /**
2435
2329
  * Indicates whether this producer is the principal of an agency.
2436
2330
  * A principal producer has additional responsibilities and permissions.
@@ -2456,6 +2350,16 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2456
2350
  * @generated from field: repeated producerflow.producer.v1.Location locations = 19;
2457
2351
  */
2458
2352
  locations: Location[];
2353
+ /**
2354
+ * MetadataQuestions contains custom metadata questions and answers for the producer.
2355
+ * This field stores tenant-specific questions that need to be asked during producer onboarding.
2356
+ * The map key is the question identifier/text, and the value is the answer provided.
2357
+ *
2358
+ * @generated from field: map<string, string> metadata_questions = 40;
2359
+ */
2360
+ metadataQuestions: {
2361
+ [key: string]: string;
2362
+ };
2459
2363
  };
2460
2364
  /**
2461
2365
  * Describes the message producerflow.producer.v1.Producer.
@@ -2986,36 +2890,11 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
2986
2890
  */
2987
2891
  mailingAddress?: NewProducer_Address;
2988
2892
  /**
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
2893
+ * 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
2894
  *
3008
2895
  * @generated from field: string tenant_id = 8;
3009
2896
  */
3010
2897
  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
2898
  /**
3020
2899
  * Optional list of location IDs to assign to the producer during creation.
3021
2900
  * All locations must exist and belong to the specified agency.
@@ -3025,10 +2904,13 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
3025
2904
  locationIds: string[];
3026
2905
  /**
3027
2906
  * MetadataQuestions contains custom metadata questions and answers for the producer.
2907
+ * The map key is the question identifier/text, and the value is the answer provided.
3028
2908
  *
3029
- * @generated from field: string metadata_questions = 11;
2909
+ * @generated from field: map<string, string> metadata_questions = 11;
3030
2910
  */
3031
- metadataQuestions: string;
2911
+ metadataQuestions: {
2912
+ [key: string]: string;
2913
+ };
3032
2914
  };
3033
2915
  /**
3034
2916
  * Describes the message producerflow.producer.v1.NewProducer.
@@ -3240,24 +3122,7 @@ export type NewContact = Message<"producerflow.producer.v1.NewContact"> & {
3240
3122
  */
3241
3123
  role: string;
3242
3124
  /**
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
3125
+ * 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
3126
  *
3262
3127
  * @generated from field: string tenant_id = 8;
3263
3128
  */
@@ -3404,6 +3269,152 @@ export type NewContactsResponse = Message<"producerflow.producer.v1.NewContactsR
3404
3269
  * Use `create(NewContactsResponseSchema)` to create a new message.
3405
3270
  */
3406
3271
  export declare const NewContactsResponseSchema: GenMessage<NewContactsResponse>;
3272
+ /**
3273
+ * Contact represents a contact associated with an agency.
3274
+ * Contacts are non-producer individuals linked to the agency.
3275
+ *
3276
+ * @generated from message producerflow.producer.v1.Contact
3277
+ */
3278
+ export type Contact = Message<"producerflow.producer.v1.Contact"> & {
3279
+ /**
3280
+ * Unique identifier for the contact.
3281
+ *
3282
+ * @generated from field: string id = 1;
3283
+ */
3284
+ id: string;
3285
+ /**
3286
+ * First name of the contact.
3287
+ *
3288
+ * @generated from field: string first_name = 2;
3289
+ */
3290
+ firstName: string;
3291
+ /**
3292
+ * Middle name of the contact.
3293
+ *
3294
+ * @generated from field: string middle_name = 3;
3295
+ */
3296
+ middleName: string;
3297
+ /**
3298
+ * Last name of the contact.
3299
+ *
3300
+ * @generated from field: string last_name = 4;
3301
+ */
3302
+ lastName: string;
3303
+ /**
3304
+ * Email address of the contact.
3305
+ * Must be unique within the tenant.
3306
+ *
3307
+ * @generated from field: string email = 5;
3308
+ */
3309
+ email: string;
3310
+ /**
3311
+ * Phone number of the contact.
3312
+ *
3313
+ * @generated from field: string phone = 6;
3314
+ */
3315
+ phone: string;
3316
+ /**
3317
+ * Role or position of the contact within the agency.
3318
+ *
3319
+ * @generated from field: string role = 7;
3320
+ */
3321
+ role: string;
3322
+ /**
3323
+ * @generated from field: producerflow.producer.v1.Contact.Address address = 8;
3324
+ */
3325
+ address?: Contact_Address;
3326
+ /**
3327
+ * National Producer Number (NPN) of the contact, if applicable.
3328
+ *
3329
+ * @generated from field: string npn = 9;
3330
+ */
3331
+ npn: string;
3332
+ /**
3333
+ * When the contact was created.
3334
+ *
3335
+ * @generated from field: google.protobuf.Timestamp created_at = 10;
3336
+ */
3337
+ createdAt?: Timestamp;
3338
+ };
3339
+ /**
3340
+ * Describes the message producerflow.producer.v1.Contact.
3341
+ * Use `create(ContactSchema)` to create a new message.
3342
+ */
3343
+ export declare const ContactSchema: GenMessage<Contact>;
3344
+ /**
3345
+ * Mailing address of the contact.
3346
+ * Address represents a mailing address for the contact.
3347
+ *
3348
+ * @generated from message producerflow.producer.v1.Contact.Address
3349
+ */
3350
+ export type Contact_Address = Message<"producerflow.producer.v1.Contact.Address"> & {
3351
+ /**
3352
+ * Street address of the contact.
3353
+ *
3354
+ * @generated from field: string street = 1;
3355
+ */
3356
+ street: string;
3357
+ /**
3358
+ * City of the contact.
3359
+ *
3360
+ * @generated from field: string city = 2;
3361
+ */
3362
+ city: string;
3363
+ /**
3364
+ * State of the contact.
3365
+ *
3366
+ * @generated from field: string state = 3;
3367
+ */
3368
+ state: string;
3369
+ /**
3370
+ * Zip code of the contact.
3371
+ *
3372
+ * @generated from field: string zip = 4;
3373
+ */
3374
+ zip: string;
3375
+ };
3376
+ /**
3377
+ * Describes the message producerflow.producer.v1.Contact.Address.
3378
+ * Use `create(Contact_AddressSchema)` to create a new message.
3379
+ */
3380
+ export declare const Contact_AddressSchema: GenMessage<Contact_Address>;
3381
+ /**
3382
+ * ListAgencyContactsRequest requests all contacts associated with an agency.
3383
+ *
3384
+ * @generated from message producerflow.producer.v1.ListAgencyContactsRequest
3385
+ */
3386
+ export type ListAgencyContactsRequest = Message<"producerflow.producer.v1.ListAgencyContactsRequest"> & {
3387
+ /**
3388
+ * The UUID of the agency to retrieve contacts for.
3389
+ * Must be a valid UUID format.
3390
+ *
3391
+ * @generated from field: string agency_id = 1;
3392
+ */
3393
+ agencyId: string;
3394
+ };
3395
+ /**
3396
+ * Describes the message producerflow.producer.v1.ListAgencyContactsRequest.
3397
+ * Use `create(ListAgencyContactsRequestSchema)` to create a new message.
3398
+ */
3399
+ export declare const ListAgencyContactsRequestSchema: GenMessage<ListAgencyContactsRequest>;
3400
+ /**
3401
+ * ListAgencyContactsResponse contains all contacts associated with an agency.
3402
+ *
3403
+ * @generated from message producerflow.producer.v1.ListAgencyContactsResponse
3404
+ */
3405
+ export type ListAgencyContactsResponse = Message<"producerflow.producer.v1.ListAgencyContactsResponse"> & {
3406
+ /**
3407
+ * List of all contacts associated with the specified agency.
3408
+ *
3409
+ * @generated from field: repeated producerflow.producer.v1.Contact contacts = 1;
3410
+ */
3411
+ contacts: Contact[];
3412
+ };
3413
+ /**
3414
+ * Describes the message producerflow.producer.v1.ListAgencyContactsResponse.
3415
+ * Use `create(ListAgencyContactsResponseSchema)` to create a new message.
3416
+ */
3417
+ export declare const ListAgencyContactsResponseSchema: GenMessage<ListAgencyContactsResponse>;
3407
3418
  /**
3408
3419
  * SetExternalIDRequest is used to associate an external identifier with a producer, agency, or contact.
3409
3420
  * This allows integration with external systems that use different ID schemes.
@@ -3453,33 +3464,7 @@ export type SetExternalIDRequest = Message<"producerflow.producer.v1.SetExternal
3453
3464
  value?: undefined;
3454
3465
  };
3455
3466
  /**
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
3467
+ * 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
3468
  *
3484
3469
  * @generated from field: string tenant_id = 4;
3485
3470
  */
@@ -4561,47 +4546,15 @@ export declare enum NIPRSyncState {
4561
4546
  * Describes the enum producerflow.producer.v1.NIPRSyncState.
4562
4547
  */
4563
4548
  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
4549
  /**
4601
4550
  * ProducerService provides a comprehensive API for managing insurance producers
4602
4551
  * and agencies, including onboarding, data synchronization, and integration with
4603
4552
  * external systems like NIPR for license verification.
4604
4553
  *
4554
+ * Available endpoints:
4555
+ * UAT (User Acceptance Testing): https://api.uat.producerflow.com
4556
+ * Production: https://api.producerflow.com
4557
+ *
4605
4558
  * RPCs for starting the onboarding agency process.
4606
4559
  *
4607
4560
  * @generated from service producerflow.producer.v1.ProducerService
@@ -4636,18 +4589,7 @@ export declare const ProducerService: GenService<{
4636
4589
  output: typeof CreateProducerOnboardingURLResponseSchema;
4637
4590
  };
4638
4591
  /**
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.
4592
+ * 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
4593
  *
4652
4594
  * @generated from rpc producerflow.producer.v1.ProducerService.NewAgency
4653
4595
  */
@@ -4750,32 +4692,6 @@ export declare const ProducerService: GenService<{
4750
4692
  input: typeof UpdateProducerRequestSchema;
4751
4693
  output: typeof UpdateProducerResponseSchema;
4752
4694
  };
4753
- /**
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.
4770
- *
4771
- * @generated from rpc producerflow.producer.v1.ProducerService.RejectProducer
4772
- * @deprecated
4773
- */
4774
- rejectProducer: {
4775
- methodKind: "unary";
4776
- input: typeof RejectProducerRequestSchema;
4777
- output: typeof RejectProducerResponseSchema;
4778
- };
4779
4695
  /**
4780
4696
  * NewContact creates a new contact associated with an agency.
4781
4697
  * Contacts represent non-producer individuals linked to the agency.
@@ -4800,6 +4716,17 @@ export declare const ProducerService: GenService<{
4800
4716
  input: typeof NewContactsRequestSchema;
4801
4717
  output: typeof NewContactsResponseSchema;
4802
4718
  };
4719
+ /**
4720
+ * ListAgencyContacts retrieves all contacts associated with an agency.
4721
+ * Returns a list of contacts with their full details.
4722
+ *
4723
+ * @generated from rpc producerflow.producer.v1.ProducerService.ListAgencyContacts
4724
+ */
4725
+ listAgencyContacts: {
4726
+ methodKind: "unary";
4727
+ input: typeof ListAgencyContactsRequestSchema;
4728
+ output: typeof ListAgencyContactsResponseSchema;
4729
+ };
4803
4730
  /**
4804
4731
  * SetExternalID sets an external identifier for a producer or contact.
4805
4732
  * Useful for integrating with external systems that use different ID schemes.
@@ -4848,12 +4775,7 @@ export declare const ProducerService: GenService<{
4848
4775
  output: typeof LookupNPNByFEINResponseSchema;
4849
4776
  };
4850
4777
  /**
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.
4778
+ * 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
4779
  *
4858
4780
  * @generated from rpc producerflow.producer.v1.ProducerService.ResyncProducer
4859
4781
  */
@@ -4863,12 +4785,7 @@ export declare const ProducerService: GenService<{
4863
4785
  output: typeof ResyncProducerResponseSchema;
4864
4786
  };
4865
4787
  /**
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.
4788
+ * 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
4789
  *
4873
4790
  * @generated from rpc producerflow.producer.v1.ProducerService.ResyncAgency
4874
4791
  */
@@ -4878,12 +4795,7 @@ export declare const ProducerService: GenService<{
4878
4795
  output: typeof ResyncAgencyResponseSchema;
4879
4796
  };
4880
4797
  /**
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.
4798
+ * 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
4799
  *
4888
4800
  * @generated from rpc producerflow.producer.v1.ProducerService.SyncProducerWithNIPR
4889
4801
  */
@@ -4893,12 +4805,7 @@ export declare const ProducerService: GenService<{
4893
4805
  output: typeof SyncProducerWithNIPRResponseSchema;
4894
4806
  };
4895
4807
  /**
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.
4808
+ * 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
4809
  *
4903
4810
  * @generated from rpc producerflow.producer.v1.ProducerService.SyncAgencyWithNIPR
4904
4811
  */
@@ -4930,21 +4837,7 @@ export declare const ProducerService: GenService<{
4930
4837
  output: typeof StopSyncAgencyWithNIPRResponseSchema;
4931
4838
  };
4932
4839
  /**
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
4840
+ * 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
4841
  *
4949
4842
  * @generated from rpc producerflow.producer.v1.ProducerService.CreateProducerUploadURL
4950
4843
  */
@@ -4954,20 +4847,7 @@ export declare const ProducerService: GenService<{
4954
4847
  output: typeof CreateProducerUploadURLResponseSchema;
4955
4848
  };
4956
4849
  /**
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.
4850
+ * 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
4851
  *
4972
4852
  * @generated from rpc producerflow.producer.v1.ProducerService.AddAgencyLocations
4973
4853
  */
@@ -4977,14 +4857,7 @@ export declare const ProducerService: GenService<{
4977
4857
  output: typeof AddAgencyLocationsResponseSchema;
4978
4858
  };
4979
4859
  /**
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.
4860
+ * 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
4861
  *
4989
4862
  * @generated from rpc producerflow.producer.v1.ProducerService.RemoveAgencyLocations
4990
4863
  */
@@ -4994,12 +4867,7 @@ export declare const ProducerService: GenService<{
4994
4867
  output: typeof RemoveAgencyLocationsResponseSchema;
4995
4868
  };
4996
4869
  /**
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.
4870
+ * 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
4871
  *
5004
4872
  * @generated from rpc producerflow.producer.v1.ProducerService.ListAgencyLocations
5005
4873
  */
@@ -5009,14 +4877,7 @@ export declare const ProducerService: GenService<{
5009
4877
  output: typeof ListAgencyLocationsResponseSchema;
5010
4878
  };
5011
4879
  /**
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
4880
+ * 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
4881
  *
5021
4882
  * @generated from rpc producerflow.producer.v1.ProducerService.AssignProducerToLocations
5022
4883
  */
@@ -5026,13 +4887,7 @@ export declare const ProducerService: GenService<{
5026
4887
  output: typeof AssignProducerToLocationsResponseSchema;
5027
4888
  };
5028
4889
  /**
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
4890
+ * 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
4891
  *
5037
4892
  * @generated from rpc producerflow.producer.v1.ProducerService.UnassignProducerFromLocations
5038
4893
  */
@@ -5042,17 +4897,7 @@ export declare const ProducerService: GenService<{
5042
4897
  output: typeof UnassignProducerFromLocationsResponseSchema;
5043
4898
  };
5044
4899
  /**
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
4900
+ * 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
4901
  *
5057
4902
  * @generated from rpc producerflow.producer.v1.ProducerService.UpdateAgencyLocation
5058
4903
  */