@producerflow/producerflowapi 0.0.12 → 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,7 +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
- * Tenant ID of the principal
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.
214
209
  *
215
210
  * @generated from field: string tenant_id = 1;
216
211
  */
@@ -409,13 +404,6 @@ export type NewAgencyRequest = Message<"producerflow.producer.v1.NewAgencyReques
409
404
  * @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency agency = 1;
410
405
  */
411
406
  agency?: NewAgencyRequest_Agency;
412
- /**
413
- * Determines if the agency should be auto approved.
414
- *
415
- * @generated from field: bool auto_approve = 2 [deprecated = true];
416
- * @deprecated
417
- */
418
- autoApprove: boolean;
419
407
  /**
420
408
  * Optional. Overrides the tenant's default NIPR sync setting during onboarding.
421
409
  * Most tenants have this enabled by default, so it usually doesn't need to be set.
@@ -554,10 +542,13 @@ export type NewAgencyRequest_Agency = Message<"producerflow.producer.v1.NewAgenc
554
542
  locations: LocationInput[];
555
543
  /**
556
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.
557
546
  *
558
- * @generated from field: string metadata_questions = 21;
547
+ * @generated from field: map<string, string> metadata_questions = 21;
559
548
  */
560
- metadataQuestions: string;
549
+ metadataQuestions: {
550
+ [key: string]: string;
551
+ };
561
552
  };
562
553
  /**
563
554
  * Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.
@@ -609,9 +600,19 @@ export type NewAgencyRequest_Agency_Principal = Message<"producerflow.producer.v
609
600
  */
610
601
  npn: string;
611
602
  /**
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.
604
+ *
612
605
  * @generated from field: string tenant_id = 6;
613
606
  */
614
607
  tenantId: string;
608
+ /**
609
+ * Optional. Controls whether the principal should be validated and synced with NIPR.
610
+ * If set to false, the principal's NPN will not be validated against NIPR and the
611
+ * principal will not be synced with NIPR. Defaults to true if not specified.
612
+ *
613
+ * @generated from field: optional bool sync_with_nipr = 7;
614
+ */
615
+ syncWithNipr?: boolean;
615
616
  };
616
617
  /**
617
618
  * Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.Principal.
@@ -1215,7 +1216,7 @@ export type UpdateProducerRequest_Producer = Message<"producerflow.producer.v1.U
1215
1216
  city?: string;
1216
1217
  /**
1217
1218
  * State of the producer.
1218
- * If provided, must be non-empty.
1219
+ * If provided, must be a valid 2-letter US state code.
1219
1220
  *
1220
1221
  * @generated from field: optional string state = 8;
1221
1222
  */
@@ -1283,75 +1284,6 @@ export type ListNewProducersResponse = Message<"producerflow.producer.v1.ListNew
1283
1284
  * Use `create(ListNewProducersResponseSchema)` to create a new message.
1284
1285
  */
1285
1286
  export declare const ListNewProducersResponseSchema: GenMessage<ListNewProducersResponse>;
1286
- /**
1287
- * ApproveProducerRequest requests approval for a producer in the onboarding process.
1288
- *
1289
- * @generated from message producerflow.producer.v1.ApproveProducerRequest
1290
- * @deprecated
1291
- */
1292
- export type ApproveProducerRequest = Message<"producerflow.producer.v1.ApproveProducerRequest"> & {
1293
- /**
1294
- * The UUID of the producer to approve.
1295
- * Must be a valid UUID format.
1296
- *
1297
- * @generated from field: string producer_id = 1;
1298
- */
1299
- producerId: string;
1300
- };
1301
- /**
1302
- * Describes the message producerflow.producer.v1.ApproveProducerRequest.
1303
- * Use `create(ApproveProducerRequestSchema)` to create a new message.
1304
- * @deprecated
1305
- */
1306
- export declare const ApproveProducerRequestSchema: GenMessage<ApproveProducerRequest>;
1307
- /**
1308
- * ApproveProducerResponse is the empty response returned after successfully approving a producer.
1309
- *
1310
- * @generated from message producerflow.producer.v1.ApproveProducerResponse
1311
- */
1312
- export type ApproveProducerResponse = Message<"producerflow.producer.v1.ApproveProducerResponse"> & {};
1313
- /**
1314
- * Describes the message producerflow.producer.v1.ApproveProducerResponse.
1315
- * Use `create(ApproveProducerResponseSchema)` to create a new message.
1316
- */
1317
- export declare const ApproveProducerResponseSchema: GenMessage<ApproveProducerResponse>;
1318
- /**
1319
- * RejectProducerRequest requests rejection of a producer in the onboarding process.
1320
- *
1321
- * @generated from message producerflow.producer.v1.RejectProducerRequest
1322
- */
1323
- export type RejectProducerRequest = Message<"producerflow.producer.v1.RejectProducerRequest"> & {
1324
- /**
1325
- * The UUID of the producer to reject.
1326
- * Must be a valid UUID format.
1327
- *
1328
- * @generated from field: string producer_id = 1;
1329
- */
1330
- producerId: string;
1331
- /**
1332
- * The reason for rejecting the producer.
1333
- * Must be non-empty to provide context for the rejection.
1334
- *
1335
- * @generated from field: string reason = 2;
1336
- */
1337
- reason: string;
1338
- };
1339
- /**
1340
- * Describes the message producerflow.producer.v1.RejectProducerRequest.
1341
- * Use `create(RejectProducerRequestSchema)` to create a new message.
1342
- */
1343
- export declare const RejectProducerRequestSchema: GenMessage<RejectProducerRequest>;
1344
- /**
1345
- * RejectProducerResponse is the empty response returned after successfully rejecting a producer.
1346
- *
1347
- * @generated from message producerflow.producer.v1.RejectProducerResponse
1348
- */
1349
- export type RejectProducerResponse = Message<"producerflow.producer.v1.RejectProducerResponse"> & {};
1350
- /**
1351
- * Describes the message producerflow.producer.v1.RejectProducerResponse.
1352
- * Use `create(RejectProducerResponseSchema)` to create a new message.
1353
- */
1354
- export declare const RejectProducerResponseSchema: GenMessage<RejectProducerResponse>;
1355
1287
  /**
1356
1288
  * Agency represents a complete agency entity with all associated information.
1357
1289
  *
@@ -1521,6 +1453,16 @@ export type Agency_AgencyInfo = Message<"producerflow.producer.v1.Agency.AgencyI
1521
1453
  * @generated from field: bool pdb_alerts_sync_enabled = 10;
1522
1454
  */
1523
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
+ };
1524
1466
  };
1525
1467
  /**
1526
1468
  * Describes the message producerflow.producer.v1.Agency.AgencyInfo.
@@ -2322,14 +2264,6 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2322
2264
  * @generated from field: string id = 1;
2323
2265
  */
2324
2266
  id: string;
2325
- /**
2326
- * The full name of the producer.
2327
- * This field is deprecated. Use first_name and last_name instead.
2328
- *
2329
- * @generated from field: string name = 2 [deprecated = true];
2330
- * @deprecated
2331
- */
2332
- name: string;
2333
2267
  /**
2334
2268
  * First name of the producer.
2335
2269
  *
@@ -2391,14 +2325,6 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2391
2325
  * @generated from field: producerflow.producer.v1.Producer.NIPR nipr = 6;
2392
2326
  */
2393
2327
  nipr?: Producer_NIPR;
2394
- /**
2395
- * The status of the producer onboarding process.
2396
- * This field is deprecated and should not be used in new code.
2397
- *
2398
- * @generated from field: producerflow.producer.v1.ProducerOnboardingState onboarding_status = 11 [deprecated = true];
2399
- * @deprecated
2400
- */
2401
- onboardingStatus: ProducerOnboardingState;
2402
2328
  /**
2403
2329
  * Indicates whether this producer is the principal of an agency.
2404
2330
  * A principal producer has additional responsibilities and permissions.
@@ -2424,6 +2350,16 @@ export type Producer = Message<"producerflow.producer.v1.Producer"> & {
2424
2350
  * @generated from field: repeated producerflow.producer.v1.Location locations = 19;
2425
2351
  */
2426
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
+ };
2427
2363
  };
2428
2364
  /**
2429
2365
  * Describes the message producerflow.producer.v1.Producer.
@@ -2935,7 +2871,6 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
2935
2871
  email: string;
2936
2872
  /**
2937
2873
  * National Producer Number (NPN) of the producer.
2938
- * Optional, but recommended for license verification.
2939
2874
  *
2940
2875
  * @generated from field: string npn = 4;
2941
2876
  */
@@ -2955,20 +2890,11 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
2955
2890
  */
2956
2891
  mailingAddress?: NewProducer_Address;
2957
2892
  /**
2958
- * External tenant identifier for the producer.
2959
- * Used for integration with external systems.
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.
2960
2894
  *
2961
2895
  * @generated from field: string tenant_id = 8;
2962
2896
  */
2963
2897
  tenantId: string;
2964
- /**
2965
- * Indicates whether the producer should be automatically approved.
2966
- * This field is deprecated and should not be used in new code.
2967
- *
2968
- * @generated from field: bool auto_approve = 9 [deprecated = true];
2969
- * @deprecated
2970
- */
2971
- autoApprove: boolean;
2972
2898
  /**
2973
2899
  * Optional list of location IDs to assign to the producer during creation.
2974
2900
  * All locations must exist and belong to the specified agency.
@@ -2978,10 +2904,13 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
2978
2904
  locationIds: string[];
2979
2905
  /**
2980
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.
2981
2908
  *
2982
- * @generated from field: string metadata_questions = 11;
2909
+ * @generated from field: map<string, string> metadata_questions = 11;
2983
2910
  */
2984
- metadataQuestions: string;
2911
+ metadataQuestions: {
2912
+ [key: string]: string;
2913
+ };
2985
2914
  };
2986
2915
  /**
2987
2916
  * Describes the message producerflow.producer.v1.NewProducer.
@@ -3193,8 +3122,7 @@ export type NewContact = Message<"producerflow.producer.v1.NewContact"> & {
3193
3122
  */
3194
3123
  role: string;
3195
3124
  /**
3196
- * External tenant identifier for the contact.
3197
- * Used for integration with external systems.
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
3198
3126
  *
3199
3127
  * @generated from field: string tenant_id = 8;
3200
3128
  */
@@ -3341,6 +3269,152 @@ export type NewContactsResponse = Message<"producerflow.producer.v1.NewContactsR
3341
3269
  * Use `create(NewContactsResponseSchema)` to create a new message.
3342
3270
  */
3343
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>;
3344
3418
  /**
3345
3419
  * SetExternalIDRequest is used to associate an external identifier with a producer, agency, or contact.
3346
3420
  * This allows integration with external systems that use different ID schemes.
@@ -3390,8 +3464,7 @@ export type SetExternalIDRequest = Message<"producerflow.producer.v1.SetExternal
3390
3464
  value?: undefined;
3391
3465
  };
3392
3466
  /**
3393
- * The external tenant identifier to associate with the entity.
3394
- * Required and must be non-empty.
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
3395
3468
  *
3396
3469
  * @generated from field: string tenant_id = 4;
3397
3470
  */
@@ -4473,47 +4546,15 @@ export declare enum NIPRSyncState {
4473
4546
  * Describes the enum producerflow.producer.v1.NIPRSyncState.
4474
4547
  */
4475
4548
  export declare const NIPRSyncStateSchema: GenEnum<NIPRSyncState>;
4476
- /**
4477
- * ProducerOnboardingState defines the possible states in the producer onboarding workflow.
4478
- * This enum is deprecated and should not be used in new code.
4479
- *
4480
- * @generated from enum producerflow.producer.v1.ProducerOnboardingState
4481
- * @deprecated
4482
- */
4483
- export declare enum ProducerOnboardingState {
4484
- /**
4485
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_UNSPECIFIED = 0;
4486
- */
4487
- UNSPECIFIED = 0,
4488
- /**
4489
- * The producer has been added to the agency and is awaiting approval from the tenant.
4490
- *
4491
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_NEW = 1;
4492
- */
4493
- NEW = 1,
4494
- /**
4495
- * The producer has been approved by the tenant.
4496
- *
4497
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_APPROVED_BY_TENANT = 2;
4498
- */
4499
- APPROVED_BY_TENANT = 2,
4500
- /**
4501
- * The producer has been rejected by the tenant.
4502
- *
4503
- * @generated from enum value: PRODUCER_ONBOARDING_STATE_REJECTED_BY_TENANT = 3;
4504
- */
4505
- REJECTED_BY_TENANT = 3
4506
- }
4507
- /**
4508
- * Describes the enum producerflow.producer.v1.ProducerOnboardingState.
4509
- * @deprecated
4510
- */
4511
- export declare const ProducerOnboardingStateSchema: GenEnum<ProducerOnboardingState>;
4512
4549
  /**
4513
4550
  * ProducerService provides a comprehensive API for managing insurance producers
4514
4551
  * and agencies, including onboarding, data synchronization, and integration with
4515
4552
  * external systems like NIPR for license verification.
4516
4553
  *
4554
+ * Available endpoints:
4555
+ * UAT (User Acceptance Testing): https://api.uat.producerflow.com
4556
+ * Production: https://api.producerflow.com
4557
+ *
4517
4558
  * RPCs for starting the onboarding agency process.
4518
4559
  *
4519
4560
  * @generated from service producerflow.producer.v1.ProducerService
@@ -4548,18 +4589,7 @@ export declare const ProducerService: GenService<{
4548
4589
  output: typeof CreateProducerOnboardingURLResponseSchema;
4549
4590
  };
4550
4591
  /**
4551
- * NewAgency creates a new agency, optionally with associated producers.
4552
- * It performs the following validation checks:
4553
- * - Ensures all required fields are present and valid
4554
- * - Checks whether the NPN is already registered
4555
- * - Verifies agency and principal information with NIPR
4556
- *
4557
- * Business rules:
4558
- * - Sole proprietors can't have an agency NPN or additional producers
4559
- * - Regular agencies must provide either an NPN or a FEIN
4560
- *
4561
- * If validation passes, it creates the agency, principal, and any producers.
4562
- * 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.
4563
4593
  *
4564
4594
  * @generated from rpc producerflow.producer.v1.ProducerService.NewAgency
4565
4595
  */
@@ -4662,32 +4692,6 @@ export declare const ProducerService: GenService<{
4662
4692
  input: typeof UpdateProducerRequestSchema;
4663
4693
  output: typeof UpdateProducerResponseSchema;
4664
4694
  };
4665
- /**
4666
- * ApproveProducer changes a producer's onboarding state to APPROVED.
4667
- * This typically happens after all verification steps are complete.
4668
- * This method is deprecated. Use SyncProducerWithNIPR instead.
4669
- *
4670
- * @generated from rpc producerflow.producer.v1.ProducerService.ApproveProducer
4671
- * @deprecated
4672
- */
4673
- approveProducer: {
4674
- methodKind: "unary";
4675
- input: typeof ApproveProducerRequestSchema;
4676
- output: typeof ApproveProducerResponseSchema;
4677
- };
4678
- /**
4679
- * RejectProducer changes a producer's onboarding state to REJECTED.
4680
- * An optional reason for rejection can be provided.
4681
- * This method is deprecated. Use StopSyncAgencyWithNIPR instead.
4682
- *
4683
- * @generated from rpc producerflow.producer.v1.ProducerService.RejectProducer
4684
- * @deprecated
4685
- */
4686
- rejectProducer: {
4687
- methodKind: "unary";
4688
- input: typeof RejectProducerRequestSchema;
4689
- output: typeof RejectProducerResponseSchema;
4690
- };
4691
4695
  /**
4692
4696
  * NewContact creates a new contact associated with an agency.
4693
4697
  * Contacts represent non-producer individuals linked to the agency.
@@ -4712,6 +4716,17 @@ export declare const ProducerService: GenService<{
4712
4716
  input: typeof NewContactsRequestSchema;
4713
4717
  output: typeof NewContactsResponseSchema;
4714
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
+ };
4715
4730
  /**
4716
4731
  * SetExternalID sets an external identifier for a producer or contact.
4717
4732
  * Useful for integrating with external systems that use different ID schemes.
@@ -4760,12 +4775,7 @@ export declare const ProducerService: GenService<{
4760
4775
  output: typeof LookupNPNByFEINResponseSchema;
4761
4776
  };
4762
4777
  /**
4763
- * ResyncProducer triggers a manual resynchronization of a producers data.
4764
- * This can be used to refresh data after external changes.
4765
- *
4766
- * WARNING: This call counts as an additional NPN lookup for billing purposes.
4767
- * Most billing plans are based on unique NPNs per month, so using this
4768
- * 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.
4769
4779
  *
4770
4780
  * @generated from rpc producerflow.producer.v1.ProducerService.ResyncProducer
4771
4781
  */
@@ -4775,12 +4785,7 @@ export declare const ProducerService: GenService<{
4775
4785
  output: typeof ResyncProducerResponseSchema;
4776
4786
  };
4777
4787
  /**
4778
- * ResyncAgency triggers a manual resynchronization of an agencys data.
4779
- * Similar to ResyncProducer, this can be used to refresh data after external changes.
4780
- *
4781
- * WARNING: This call counts as an additional NPN lookup for billing purposes.
4782
- * Most billing plans are based on unique NPNs per month, so using this
4783
- * 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.
4784
4789
  *
4785
4790
  * @generated from rpc producerflow.producer.v1.ProducerService.ResyncAgency
4786
4791
  */
@@ -4790,12 +4795,7 @@ export declare const ProducerService: GenService<{
4790
4795
  output: typeof ResyncAgencyResponseSchema;
4791
4796
  };
4792
4797
  /**
4793
- * SyncAgencyWithNIPR synchronizes an producers data with the NIPR system.
4794
- * Fetches the latest producer information and appointments.
4795
- *
4796
- * WARNING: This call counts as an extra NPN lookup against your billing.
4797
- * Most billing plans are based on unique NPNs per month, so using this
4798
- * 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.
4799
4799
  *
4800
4800
  * @generated from rpc producerflow.producer.v1.ProducerService.SyncProducerWithNIPR
4801
4801
  */
@@ -4805,12 +4805,7 @@ export declare const ProducerService: GenService<{
4805
4805
  output: typeof SyncProducerWithNIPRResponseSchema;
4806
4806
  };
4807
4807
  /**
4808
- * SyncAgencyWithNIPR synchronizes an agencys data with the NIPR system.
4809
- * Fetches the latest agency information and appointments.
4810
- *
4811
- * WARNING: This call counts as an extra NPN lookup against your billing.
4812
- * Most billing plans are based on unique NPNs per month, so using this
4813
- * 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.
4814
4809
  *
4815
4810
  * @generated from rpc producerflow.producer.v1.ProducerService.SyncAgencyWithNIPR
4816
4811
  */
@@ -4842,21 +4837,7 @@ export declare const ProducerService: GenService<{
4842
4837
  output: typeof StopSyncAgencyWithNIPRResponseSchema;
4843
4838
  };
4844
4839
  /**
4845
- * CreateProducerUploadURL generates a URL that can be used to upload new producers for an existing agency.
4846
- * The agency is identified by its NPN, and the URL can be shared with the agency to allow them to
4847
- * upload producer information securely.
4848
- *
4849
- * The URL is time-limited and includes necessary security tokens. A default expiration of 7 days will be used.
4850
- *
4851
- * The agency must:
4852
- * - Exist and belong to the authenticated tenant
4853
- * - Have a valid NPN
4854
- *
4855
- * Returns a URL string that can be shared with the agency for producer uploads.
4856
- * Returns errors in the following cases:
4857
- * - INVALID_ARGUMENT: if agency NPN is empty or invalid format
4858
- * - NOT_FOUND: if agency NPN doesn't exist
4859
- * - 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.
4860
4841
  *
4861
4842
  * @generated from rpc producerflow.producer.v1.ProducerService.CreateProducerUploadURL
4862
4843
  */
@@ -4866,20 +4847,7 @@ export declare const ProducerService: GenService<{
4866
4847
  output: typeof CreateProducerUploadURLResponseSchema;
4867
4848
  };
4868
4849
  /**
4869
- * AddAgencyLocations adds one or more locations to an existing agency.
4870
- *
4871
- * Each location must have a unique name within the agency and valid address information.
4872
- * You can add up to 100 locations in a single request. This is a bulk operation with
4873
- * all-or-nothing behavior - if any location fails validation, the entire request will
4874
- * fail and no locations will be added.
4875
- *
4876
- * Returns the IDs of successfully added locations.
4877
- *
4878
- * Returns errors in the following cases:
4879
- * - UNAUTHENTICATED: if the API key is invalid or missing.
4880
- * - INVALID_ARGUMENT: if the request is nil, agency_id is empty, no locations provided,
4881
- * location names are duplicated within the request or already exist for the agency.
4882
- * - 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.
4883
4851
  *
4884
4852
  * @generated from rpc producerflow.producer.v1.ProducerService.AddAgencyLocations
4885
4853
  */
@@ -4889,14 +4857,7 @@ export declare const ProducerService: GenService<{
4889
4857
  output: typeof AddAgencyLocationsResponseSchema;
4890
4858
  };
4891
4859
  /**
4892
- * RemoveAgencyLocations removes one or more locations from an agency.
4893
- *
4894
- * Locations that don't exist will be silently ignored. Returns the IDs of successfully removed locations.
4895
- * When a location is removed, all the producers associated with that location will be unassigned from that location.
4896
- * Returns errors in the following cases:
4897
- * - UNAUTHENTICATED: if the API key is invalid or missing.
4898
- * - INVALID_ARGUMENT: if the request is nil, agency_id is empty, or no location_ids provided.
4899
- * - 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.
4900
4861
  *
4901
4862
  * @generated from rpc producerflow.producer.v1.ProducerService.RemoveAgencyLocations
4902
4863
  */
@@ -4906,12 +4867,7 @@ export declare const ProducerService: GenService<{
4906
4867
  output: typeof RemoveAgencyLocationsResponseSchema;
4907
4868
  };
4908
4869
  /**
4909
- * ListAgencyLocations retrieves all locations associated with an agency.
4910
- *
4911
- * Returns errors in the following cases:
4912
- * - UNAUTHENTICATED: if the API key is invalid or missing.
4913
- * - INVALID_ARGUMENT: if the agency_id is empty.
4914
- * - 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.
4915
4871
  *
4916
4872
  * @generated from rpc producerflow.producer.v1.ProducerService.ListAgencyLocations
4917
4873
  */
@@ -4921,14 +4877,7 @@ export declare const ProducerService: GenService<{
4921
4877
  output: typeof ListAgencyLocationsResponseSchema;
4922
4878
  };
4923
4879
  /**
4924
- * AssignProducerToLocations assigns one or more locations to a producer.
4925
- * The locations must belong to the same agency as the producer.
4926
- *
4927
- * Error cases:
4928
- * - UNAUTHENTICATED: Invalid or missing API key
4929
- * - INVALID_ARGUMENT: Empty producer_id or no location_ids
4930
- * - NOT_FOUND: Producer or locations don't exist
4931
- * - 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.
4932
4881
  *
4933
4882
  * @generated from rpc producerflow.producer.v1.ProducerService.AssignProducerToLocations
4934
4883
  */
@@ -4938,13 +4887,7 @@ export declare const ProducerService: GenService<{
4938
4887
  output: typeof AssignProducerToLocationsResponseSchema;
4939
4888
  };
4940
4889
  /**
4941
- * UnassignProducerFromLocations removes one or more location assignments from a producer.
4942
- * The locations must belong to the same agency as the producer.
4943
- *
4944
- * Error cases:
4945
- * - UNAUTHENTICATED: Invalid or missing API key
4946
- * - INVALID_ARGUMENT: Empty producer_id or no location_ids
4947
- * - 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.
4948
4891
  *
4949
4892
  * @generated from rpc producerflow.producer.v1.ProducerService.UnassignProducerFromLocations
4950
4893
  */
@@ -4954,17 +4897,7 @@ export declare const ProducerService: GenService<{
4954
4897
  output: typeof UnassignProducerFromLocationsResponseSchema;
4955
4898
  };
4956
4899
  /**
4957
- * UpdateAgencyLocation updates an existing agency location.
4958
- * You can update the name, address, contact information, and primary status of a location.
4959
- * All fields are optional - only provide the fields you want to update.
4960
- * Location name must be unique within the agency.
4961
- * Returns the updated location details.
4962
- *
4963
- * Error cases:
4964
- * - UNAUTHENTICATED: Invalid or missing API key
4965
- * - INVALID_ARGUMENT: Missing agency_id or location_id
4966
- * - NOT_FOUND: Agency or location doesn't exist
4967
- * - 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.
4968
4901
  *
4969
4902
  * @generated from rpc producerflow.producer.v1.ProducerService.UpdateAgencyLocation
4970
4903
  */