@producerflow/producerflowapi 1.0.15 → 1.0.19

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.
@@ -376,19 +376,31 @@ export type Carrier = Message<"producerflow.appointment.v1.Carrier"> & {
376
376
  */
377
377
  name: string;
378
378
  /**
379
- * The NPN of the carrier.
379
+ * National Producer Number (NPN) of the carrier.
380
+ * A unique NAIC identifier assigned to business entities during the licensing
381
+ * application process and stored in the NIPR Producer Database (PDB).
382
+ * Format: 1-10 digit numeric string.
383
+ * Example: "1234567890"
384
+ * Reference: https://nipr.com
380
385
  *
381
386
  * @generated from field: string npn = 3;
382
387
  */
383
388
  npn: string;
384
389
  /**
385
- * The FEIN of the carrier.
390
+ * Federal Employer Identification Number (FEIN) of the carrier.
391
+ * Format: 9-digit number assigned by the IRS for tax identification.
392
+ * Example: "123456789"
386
393
  *
387
394
  * @generated from field: string fein = 4;
388
395
  */
389
396
  fein: string;
390
397
  /**
391
- * The NAIC cocode of the carrier.
398
+ * NAIC Company Code (CoCode) of the carrier.
399
+ * A unique identifier assigned by the National Association of Insurance
400
+ * Commissioners (NAIC) to each insurance company for regulatory reporting.
401
+ * Format: Typically a 5-digit numeric string.
402
+ * Example: "12345"
403
+ * Reference: https://naic.org
392
404
  *
393
405
  * @generated from field: string cocode = 5;
394
406
  */
@@ -442,13 +454,16 @@ export type AppointmentOperationalStatus = Message<"producerflow.appointment.v1.
442
454
  */
443
455
  export declare const AppointmentOperationalStatusSchema: GenMessage<AppointmentOperationalStatus>;
444
456
  /**
445
- * Represents an appointment for a license.
457
+ * Represents a managed appointment for a license, tracked through the
458
+ * ProducerFlow appointment lifecycle. Unlike NIPR-sourced appointment data
459
+ * on the Producer/Agency messages, this represents appointments that are
460
+ * actively managed (requested, terminated) through the AppointmentService.
446
461
  *
447
462
  * @generated from message producerflow.appointment.v1.Appointment
448
463
  */
449
464
  export type Appointment = Message<"producerflow.appointment.v1.Appointment"> & {
450
465
  /**
451
- * Unique identifier for the appointment.
466
+ * Unique identifier for the appointment (UUID format).
452
467
  *
453
468
  * @generated from field: string appointment_id = 1;
454
469
  */
@@ -461,81 +476,94 @@ export type Appointment = Message<"producerflow.appointment.v1.Appointment"> & {
461
476
  license?: License;
462
477
  /**
463
478
  * The license number of the license being appointed.
479
+ * This is a denormalized copy of license.license_number for convenience.
464
480
  *
465
481
  * @generated from field: string name = 3;
466
482
  */
467
483
  name: string;
468
484
  /**
469
- * The id of the agency that is appointed.
485
+ * The UUID of the agency that holds this appointment.
470
486
  *
471
487
  * @generated from field: string agency_id = 4;
472
488
  */
473
489
  agencyId: string;
474
490
  /**
475
- * Optional. The id of the producer that is appointed, if any.
491
+ * Optional. The UUID of the producer that holds this appointment, if any.
492
+ * When empty, this is an agency-level appointment.
476
493
  *
477
494
  * @generated from field: optional string producer_id = 5;
478
495
  */
479
496
  producerId?: string;
480
497
  /**
481
498
  * The name of the carrier to which the license is appointed.
499
+ * Examples: "State Farm", "Allstate", "Progressive"
482
500
  *
483
501
  * @generated from field: string carrier = 6;
484
502
  */
485
503
  carrier: string;
486
504
  /**
487
- * Type of appointment (e.g., up-front, registry).
505
+ * Type of appointment (registry, up-front, just-in-time, or synthetic).
506
+ * Determines how the appointment was established and processed.
488
507
  *
489
508
  * @generated from field: producerflow.appointment.v1.AppointmentType appointment_type = 7;
490
509
  */
491
510
  appointmentType: AppointmentType;
492
511
  /**
493
- * Processing status of the appointment (e.g., in progress, appointed).
512
+ * Current processing status of the appointment in the NIPR pipeline.
513
+ * See ProcessingStatus for the complete lifecycle documentation.
494
514
  *
495
515
  * @generated from field: producerflow.appointment.v1.ProcessingStatus processing_status = 8;
496
516
  */
497
517
  processingStatus: ProcessingStatus;
498
518
  /**
499
519
  * Optional. Comments or notes related to the appointment.
520
+ * May include NIPR processing notes or rejection details.
500
521
  *
501
522
  * @generated from field: string comments = 9;
502
523
  */
503
524
  comments: string;
504
525
  /**
505
- * Timestamp of when the appointment becomes effective.
526
+ * Timestamp of when the appointment became or becomes effective.
506
527
  *
507
528
  * @generated from field: google.protobuf.Timestamp effective_date = 10;
508
529
  */
509
530
  effectiveDate?: Timestamp;
510
531
  /**
511
- * Optional. Timestamp of the termination of the appointment.
532
+ * Optional. Timestamp of when the appointment was terminated.
533
+ * Only populated when processing_status is TERMINATED.
512
534
  *
513
535
  * @generated from field: optional google.protobuf.Timestamp termination_date = 11;
514
536
  */
515
537
  terminationDate?: Timestamp;
516
538
  /**
517
- * Timestamp of the last update to the appointment.
539
+ * Timestamp of the last update to this appointment record.
518
540
  *
519
541
  * @generated from field: google.protobuf.Timestamp updated_at = 12;
520
542
  */
521
543
  updatedAt?: Timestamp;
522
544
  /**
523
- * Operational status information for the appointment. This field provides
524
- * insight into the current operational health and any risk factors that may
525
- * affect the appointment.
545
+ * Operational status information for the appointment. Provides insight into
546
+ * the current operational health and any risk factors (e.g., expired license,
547
+ * inactive E&O) that may affect the appointment's continued validity.
526
548
  *
527
549
  * @generated from field: producerflow.appointment.v1.AppointmentOperationalStatus operational_status = 13;
528
550
  */
529
551
  operationalStatus?: AppointmentOperationalStatus;
530
552
  /**
531
- * The NAIC cocode of the carrier.
553
+ * NAIC Company Code (CoCode) of the carrier.
554
+ * A unique identifier assigned by the National Association of Insurance
555
+ * Commissioners (NAIC) for regulatory reporting.
556
+ * Format: Typically a 5-digit numeric string.
557
+ * Reference: https://naic.org
532
558
  *
533
559
  * @generated from field: string cocode = 14;
534
560
  */
535
561
  cocode: string;
536
562
  /**
537
- * Optional. The id of the parent appointment, if this is a synthetic
538
- * appointment. It should be empty for non-synthetic appointments.
563
+ * Optional. The UUID of the parent appointment, if this is a synthetic
564
+ * appointment (APPOINTMENT_TYPE_SYNTHETIC). Empty for non-synthetic
565
+ * appointments. Synthetic appointments inherit properties from and are
566
+ * terminated with their parent appointment.
539
567
  *
540
568
  * @generated from field: string parent_appointment_id = 15;
541
569
  */
@@ -557,7 +585,10 @@ export type License = Message<"producerflow.appointment.v1.License"> & {
557
585
  */
558
586
  licenseId: string;
559
587
  /**
560
- * The license number.
588
+ * The license number assigned by the state Department of Insurance (DOI).
589
+ * Format varies by state (e.g., numeric, alphanumeric, or with prefixes).
590
+ * Examples: "0A12345" (CA), "BR-1234567" (TX), "100012345" (FL)
591
+ * This is a state-specific identifier, not globally unique across states.
561
592
  *
562
593
  * @generated from field: string license_number = 2;
563
594
  */
@@ -584,13 +615,20 @@ export type License = Message<"producerflow.appointment.v1.License"> & {
584
615
  value?: undefined;
585
616
  };
586
617
  /**
587
- * The two-letter state code of the license.
618
+ * The two-letter US state or territory code that issued the license.
619
+ * Format: ISO 3166-2 subdivision code (e.g., "CA", "TX", "NY").
588
620
  *
589
621
  * @generated from field: string state = 5;
590
622
  */
591
623
  state: string;
592
624
  /**
593
- * The license class.
625
+ * License class description as defined by the state DOI.
626
+ * Describes the broad category of insurance the license covers.
627
+ * Common classes include:
628
+ * - "Insurance Producer": General license to sell insurance
629
+ * - "Limited Lines Producer": Restricted to specific product types
630
+ * - "Surplus Lines Broker": Authorized for non-admitted carriers
631
+ * Values vary by state as each DOI defines its own license classes.
594
632
  *
595
633
  * @generated from field: string license_class = 6;
596
634
  */
@@ -727,7 +765,24 @@ export declare enum RiskReason {
727
765
  */
728
766
  export declare const RiskReasonSchema: GenEnum<RiskReason>;
729
767
  /**
730
- * Processing status of the appointment.
768
+ * ProcessingStatus represents the lifecycle state of an appointment as it
769
+ * moves through the NIPR processing pipeline.
770
+ *
771
+ * Appointment Lifecycle:
772
+ *
773
+ * RequestAppointment
774
+ * |
775
+ * v
776
+ * IN_PROGRESS -----> APPOINTED (active appointment)
777
+ * | |
778
+ * v v (TerminateAppointment)
779
+ * REJECTED TERMINATION_REQUESTED --> TERMINATED
780
+ *
781
+ * For registry states or capacity carriers (no NIPR integration):
782
+ * RequestAppointment --> APPOINTED (immediate)
783
+ * TerminateAppointment --> TERMINATED (immediate)
784
+ *
785
+ * Reference: https://pdb.nipr.com/Gateway
731
786
  *
732
787
  * @generated from enum producerflow.appointment.v1.ProcessingStatus
733
788
  */
@@ -737,26 +792,47 @@ export declare enum ProcessingStatus {
737
792
  */
738
793
  UNSPECIFIED = 0,
739
794
  /**
795
+ * Appointment request has been submitted to NIPR and is awaiting processing.
796
+ * This is a transient state; the final result will be delivered via webhook.
797
+ *
740
798
  * @generated from enum value: PROCESSING_STATUS_IN_PROGRESS = 1;
741
799
  */
742
800
  IN_PROGRESS = 1,
743
801
  /**
802
+ * Appointment has been approved and is active. The producer/agency can sell
803
+ * this carrier's products for the specified Line of Authority.
804
+ *
744
805
  * @generated from enum value: PROCESSING_STATUS_APPOINTED = 2;
745
806
  */
746
807
  APPOINTED = 2,
747
808
  /**
809
+ * Appointment has been terminated. The producer/agency can no longer sell
810
+ * this carrier's products. This is a terminal state.
811
+ *
748
812
  * @generated from enum value: PROCESSING_STATUS_TERMINATED = 3;
749
813
  */
750
814
  TERMINATED = 3,
751
815
  /**
816
+ * Appointment request was rejected by NIPR. Check not_eligible_reasons for
817
+ * details. Common reasons include: missing resident license, unmet
818
+ * continuing education requirements, or outstanding regulatory actions.
819
+ *
752
820
  * @generated from enum value: PROCESSING_STATUS_REJECTED = 4;
753
821
  */
754
822
  REJECTED = 4,
755
823
  /**
824
+ * The license required for this appointment is missing or could not be found.
825
+ * The producer/agency needs to obtain the appropriate license before the
826
+ * appointment can be processed.
827
+ *
756
828
  * @generated from enum value: PROCESSING_STATUS_MISSING_LICENSE = 5;
757
829
  */
758
830
  MISSING_LICENSE = 5,
759
831
  /**
832
+ * A termination request has been submitted to NIPR and is awaiting
833
+ * processing. This is a transient state; the final result (TERMINATED)
834
+ * will be delivered via webhook.
835
+ *
760
836
  * @generated from enum value: PROCESSING_STATUS_TERMINATION_REQUESTED = 6;
761
837
  */
762
838
  TERMINATION_REQUESTED = 6
@@ -766,7 +842,13 @@ export declare enum ProcessingStatus {
766
842
  */
767
843
  export declare const ProcessingStatusSchema: GenEnum<ProcessingStatus>;
768
844
  /**
769
- * Type of appointment.
845
+ * AppointmentType categorizes how the appointment was established and
846
+ * processed.
847
+ *
848
+ * The appointment type determines the processing behavior:
849
+ * - Registry and Synthetic appointments are processed automatically
850
+ * - Up-front appointments go through NIPR's standard processing pipeline
851
+ * - Just-in-time appointments are created on demand when needed
770
852
  *
771
853
  * @generated from enum producerflow.appointment.v1.AppointmentType
772
854
  */
@@ -776,20 +858,31 @@ export declare enum AppointmentType {
776
858
  */
777
859
  UNSPECIFIED = 0,
778
860
  /**
861
+ * Registry appointment: Processed automatically for licenses in registry
862
+ * states. Registry states allow appointments without going through NIPR's
863
+ * standard appointment process.
864
+ *
779
865
  * @generated from enum value: APPOINTMENT_TYPE_REGISTRY = 1;
780
866
  */
781
867
  REGISTRY = 1,
782
868
  /**
869
+ * Up-front appointment: Standard appointment processed through NIPR.
870
+ * These require NIPR approval and may take time to process. The carrier
871
+ * pays appointment fees to NIPR/state.
872
+ *
783
873
  * @generated from enum value: APPOINTMENT_TYPE_UP_FRONT = 2;
784
874
  */
785
875
  UP_FRONT = 2,
786
876
  /**
877
+ * Just-in-time appointment: Created on demand when a producer needs to
878
+ * sell a product but doesn't have a pre-existing appointment.
879
+ *
787
880
  * @generated from enum value: APPOINTMENT_TYPE_JUST_IN_TIME = 3;
788
881
  */
789
882
  JUST_IN_TIME = 3,
790
883
  /**
791
- * Synthetic appointments are programmatically created for individual
792
- * producers in states where only agency-level appointments are permitted
884
+ * Synthetic appointment: Programmatically created for individual producers
885
+ * in states where only agency-level appointments are permitted
793
886
  * (CA, DC, HI, KY, LA, MA, MT, UT, WA). They are automatically created when
794
887
  * an agency appointment is approved and inherit properties from the parent
795
888
  * agency appointment. The parent_appointment_id field links to the parent
@@ -809,8 +902,9 @@ export declare const AppointmentTypeSchema: GenEnum<AppointmentType>;
809
902
  * TerminationReason represents the reason for the termination of an appointment.
810
903
  *
811
904
  * These reasons correspond to NIPR's valid termination codes and vary by
812
- * state. Use ListTerminationReasons to get the valid reasons for a specific
813
- * state before terminating an appointment.
905
+ * state. Not all reasons are valid in every state - use ListTerminationReasons
906
+ * to get the valid reasons for a specific state before calling
907
+ * TerminateAppointment.
814
908
  *
815
909
  * Reference: https://pdb.nipr.com/Gateway/ValidTerms
816
910
  *
@@ -822,62 +916,92 @@ export declare enum TerminationReason {
822
916
  */
823
917
  UNSPECIFIED = 0,
824
918
  /**
919
+ * Producer or agency voluntarily chose to end the appointment.
920
+ *
825
921
  * @generated from enum value: TERMINATION_REASON_VOLUNTARY_TERMINATION = 1;
826
922
  */
827
923
  VOLUNTARY_TERMINATION = 1,
828
924
  /**
925
+ * Carrier terminated due to insufficient premium production or sales volume.
926
+ *
829
927
  * @generated from enum value: TERMINATION_REASON_INADEQUATE_PRODUCTION = 2;
830
928
  */
831
929
  INADEQUATE_PRODUCTION = 2,
832
930
  /**
931
+ * Appointment was cancelled by the managing general agent (MGA).
932
+ *
833
933
  * @generated from enum value: TERMINATION_REASON_CANCELLED_BY_GENERAL_AGENT = 3;
834
934
  */
835
935
  CANCELLED_BY_GENERAL_AGENT = 3,
836
936
  /**
937
+ * Producer has passed away.
938
+ *
837
939
  * @generated from enum value: TERMINATION_REASON_DEATH = 4;
838
940
  */
839
941
  DEATH = 4,
840
942
  /**
943
+ * Insurance company has ceased operations or entered liquidation.
944
+ *
841
945
  * @generated from enum value: TERMINATION_REASON_COMPANY_DEFUNCT_OR_LIQUIDATION = 5;
842
946
  */
843
947
  COMPANY_DEFUNCT_OR_LIQUIDATION = 5,
844
948
  /**
949
+ * Producer owes money to the insurance company (e.g., unremitted premiums).
950
+ *
845
951
  * @generated from enum value: TERMINATION_REASON_COMPANY_INDEBTEDNESS = 6;
846
952
  */
847
953
  COMPANY_INDEBTEDNESS = 6,
848
954
  /**
955
+ * Carrier terminated due to poor service to policyholders.
956
+ *
849
957
  * @generated from enum value: TERMINATION_REASON_POOR_POLICYHOLDER_SERVICE = 7;
850
958
  */
851
959
  POOR_POLICYHOLDER_SERVICE = 7,
852
960
  /**
961
+ * Producer relocated to a different jurisdiction.
962
+ *
853
963
  * @generated from enum value: TERMINATION_REASON_AGENT_MOVED = 8;
854
964
  */
855
965
  AGENT_MOVED = 8,
856
966
  /**
967
+ * Appointment was created in error and is being corrected.
968
+ *
857
969
  * @generated from enum value: TERMINATION_REASON_APPOINTED_IN_ERROR = 9;
858
970
  */
859
971
  APPOINTED_IN_ERROR = 9,
860
972
  /**
973
+ * General cancellation without a more specific reason.
974
+ *
861
975
  * @generated from enum value: TERMINATION_REASON_CANCELLED = 10;
862
976
  */
863
977
  CANCELLED = 10,
864
978
  /**
979
+ * Carrier terminated for cause (e.g., misconduct, policy violations).
980
+ *
865
981
  * @generated from enum value: TERMINATION_REASON_CANCELLED_FOR_CAUSE = 11;
866
982
  */
867
983
  CANCELLED_FOR_CAUSE = 11,
868
984
  /**
985
+ * Insurance company merged with another company.
986
+ *
869
987
  * @generated from enum value: TERMINATION_REASON_COMPANY_MERGER = 12;
870
988
  */
871
989
  COMPANY_MERGER = 12,
872
990
  /**
991
+ * Producer's license has been revoked by a regulatory authority.
992
+ *
873
993
  * @generated from enum value: TERMINATION_REASON_REVOKED = 13;
874
994
  */
875
995
  REVOKED = 13,
876
996
  /**
997
+ * Producer's license has been suspended for compliance issues.
998
+ *
877
999
  * @generated from enum value: TERMINATION_REASON_SUSPENDED_FOR_COMPLIANCE = 14;
878
1000
  */
879
1001
  SUSPENDED_FOR_COMPLIANCE = 14,
880
1002
  /**
1003
+ * Termination is being submitted for regulatory review by the state DOI.
1004
+ *
881
1005
  * @generated from enum value: TERMINATION_REASON_REQUEST_REGULATORY_REVIEW = 15;
882
1006
  */
883
1007
  REQUEST_REGULATORY_REVIEW = 15
@@ -199,7 +199,24 @@ var RiskReason;
199
199
  */
200
200
  exports.RiskReasonSchema = (0, codegenv2_1.enumDesc)(exports.file_producerflow_appointment_v1_appointment, 1);
201
201
  /**
202
- * Processing status of the appointment.
202
+ * ProcessingStatus represents the lifecycle state of an appointment as it
203
+ * moves through the NIPR processing pipeline.
204
+ *
205
+ * Appointment Lifecycle:
206
+ *
207
+ * RequestAppointment
208
+ * |
209
+ * v
210
+ * IN_PROGRESS -----> APPOINTED (active appointment)
211
+ * | |
212
+ * v v (TerminateAppointment)
213
+ * REJECTED TERMINATION_REQUESTED --> TERMINATED
214
+ *
215
+ * For registry states or capacity carriers (no NIPR integration):
216
+ * RequestAppointment --> APPOINTED (immediate)
217
+ * TerminateAppointment --> TERMINATED (immediate)
218
+ *
219
+ * Reference: https://pdb.nipr.com/Gateway
203
220
  *
204
221
  * @generated from enum producerflow.appointment.v1.ProcessingStatus
205
222
  */
@@ -210,26 +227,47 @@ var ProcessingStatus;
210
227
  */
211
228
  ProcessingStatus[ProcessingStatus["UNSPECIFIED"] = 0] = "UNSPECIFIED";
212
229
  /**
230
+ * Appointment request has been submitted to NIPR and is awaiting processing.
231
+ * This is a transient state; the final result will be delivered via webhook.
232
+ *
213
233
  * @generated from enum value: PROCESSING_STATUS_IN_PROGRESS = 1;
214
234
  */
215
235
  ProcessingStatus[ProcessingStatus["IN_PROGRESS"] = 1] = "IN_PROGRESS";
216
236
  /**
237
+ * Appointment has been approved and is active. The producer/agency can sell
238
+ * this carrier's products for the specified Line of Authority.
239
+ *
217
240
  * @generated from enum value: PROCESSING_STATUS_APPOINTED = 2;
218
241
  */
219
242
  ProcessingStatus[ProcessingStatus["APPOINTED"] = 2] = "APPOINTED";
220
243
  /**
244
+ * Appointment has been terminated. The producer/agency can no longer sell
245
+ * this carrier's products. This is a terminal state.
246
+ *
221
247
  * @generated from enum value: PROCESSING_STATUS_TERMINATED = 3;
222
248
  */
223
249
  ProcessingStatus[ProcessingStatus["TERMINATED"] = 3] = "TERMINATED";
224
250
  /**
251
+ * Appointment request was rejected by NIPR. Check not_eligible_reasons for
252
+ * details. Common reasons include: missing resident license, unmet
253
+ * continuing education requirements, or outstanding regulatory actions.
254
+ *
225
255
  * @generated from enum value: PROCESSING_STATUS_REJECTED = 4;
226
256
  */
227
257
  ProcessingStatus[ProcessingStatus["REJECTED"] = 4] = "REJECTED";
228
258
  /**
259
+ * The license required for this appointment is missing or could not be found.
260
+ * The producer/agency needs to obtain the appropriate license before the
261
+ * appointment can be processed.
262
+ *
229
263
  * @generated from enum value: PROCESSING_STATUS_MISSING_LICENSE = 5;
230
264
  */
231
265
  ProcessingStatus[ProcessingStatus["MISSING_LICENSE"] = 5] = "MISSING_LICENSE";
232
266
  /**
267
+ * A termination request has been submitted to NIPR and is awaiting
268
+ * processing. This is a transient state; the final result (TERMINATED)
269
+ * will be delivered via webhook.
270
+ *
233
271
  * @generated from enum value: PROCESSING_STATUS_TERMINATION_REQUESTED = 6;
234
272
  */
235
273
  ProcessingStatus[ProcessingStatus["TERMINATION_REQUESTED"] = 6] = "TERMINATION_REQUESTED";
@@ -239,7 +277,13 @@ var ProcessingStatus;
239
277
  */
240
278
  exports.ProcessingStatusSchema = (0, codegenv2_1.enumDesc)(exports.file_producerflow_appointment_v1_appointment, 2);
241
279
  /**
242
- * Type of appointment.
280
+ * AppointmentType categorizes how the appointment was established and
281
+ * processed.
282
+ *
283
+ * The appointment type determines the processing behavior:
284
+ * - Registry and Synthetic appointments are processed automatically
285
+ * - Up-front appointments go through NIPR's standard processing pipeline
286
+ * - Just-in-time appointments are created on demand when needed
243
287
  *
244
288
  * @generated from enum producerflow.appointment.v1.AppointmentType
245
289
  */
@@ -250,20 +294,31 @@ var AppointmentType;
250
294
  */
251
295
  AppointmentType[AppointmentType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
252
296
  /**
297
+ * Registry appointment: Processed automatically for licenses in registry
298
+ * states. Registry states allow appointments without going through NIPR's
299
+ * standard appointment process.
300
+ *
253
301
  * @generated from enum value: APPOINTMENT_TYPE_REGISTRY = 1;
254
302
  */
255
303
  AppointmentType[AppointmentType["REGISTRY"] = 1] = "REGISTRY";
256
304
  /**
305
+ * Up-front appointment: Standard appointment processed through NIPR.
306
+ * These require NIPR approval and may take time to process. The carrier
307
+ * pays appointment fees to NIPR/state.
308
+ *
257
309
  * @generated from enum value: APPOINTMENT_TYPE_UP_FRONT = 2;
258
310
  */
259
311
  AppointmentType[AppointmentType["UP_FRONT"] = 2] = "UP_FRONT";
260
312
  /**
313
+ * Just-in-time appointment: Created on demand when a producer needs to
314
+ * sell a product but doesn't have a pre-existing appointment.
315
+ *
261
316
  * @generated from enum value: APPOINTMENT_TYPE_JUST_IN_TIME = 3;
262
317
  */
263
318
  AppointmentType[AppointmentType["JUST_IN_TIME"] = 3] = "JUST_IN_TIME";
264
319
  /**
265
- * Synthetic appointments are programmatically created for individual
266
- * producers in states where only agency-level appointments are permitted
320
+ * Synthetic appointment: Programmatically created for individual producers
321
+ * in states where only agency-level appointments are permitted
267
322
  * (CA, DC, HI, KY, LA, MA, MT, UT, WA). They are automatically created when
268
323
  * an agency appointment is approved and inherit properties from the parent
269
324
  * agency appointment. The parent_appointment_id field links to the parent
@@ -283,8 +338,9 @@ exports.AppointmentTypeSchema = (0, codegenv2_1.enumDesc)(exports.file_producerf
283
338
  * TerminationReason represents the reason for the termination of an appointment.
284
339
  *
285
340
  * These reasons correspond to NIPR's valid termination codes and vary by
286
- * state. Use ListTerminationReasons to get the valid reasons for a specific
287
- * state before terminating an appointment.
341
+ * state. Not all reasons are valid in every state - use ListTerminationReasons
342
+ * to get the valid reasons for a specific state before calling
343
+ * TerminateAppointment.
288
344
  *
289
345
  * Reference: https://pdb.nipr.com/Gateway/ValidTerms
290
346
  *
@@ -297,62 +353,92 @@ var TerminationReason;
297
353
  */
298
354
  TerminationReason[TerminationReason["UNSPECIFIED"] = 0] = "UNSPECIFIED";
299
355
  /**
356
+ * Producer or agency voluntarily chose to end the appointment.
357
+ *
300
358
  * @generated from enum value: TERMINATION_REASON_VOLUNTARY_TERMINATION = 1;
301
359
  */
302
360
  TerminationReason[TerminationReason["VOLUNTARY_TERMINATION"] = 1] = "VOLUNTARY_TERMINATION";
303
361
  /**
362
+ * Carrier terminated due to insufficient premium production or sales volume.
363
+ *
304
364
  * @generated from enum value: TERMINATION_REASON_INADEQUATE_PRODUCTION = 2;
305
365
  */
306
366
  TerminationReason[TerminationReason["INADEQUATE_PRODUCTION"] = 2] = "INADEQUATE_PRODUCTION";
307
367
  /**
368
+ * Appointment was cancelled by the managing general agent (MGA).
369
+ *
308
370
  * @generated from enum value: TERMINATION_REASON_CANCELLED_BY_GENERAL_AGENT = 3;
309
371
  */
310
372
  TerminationReason[TerminationReason["CANCELLED_BY_GENERAL_AGENT"] = 3] = "CANCELLED_BY_GENERAL_AGENT";
311
373
  /**
374
+ * Producer has passed away.
375
+ *
312
376
  * @generated from enum value: TERMINATION_REASON_DEATH = 4;
313
377
  */
314
378
  TerminationReason[TerminationReason["DEATH"] = 4] = "DEATH";
315
379
  /**
380
+ * Insurance company has ceased operations or entered liquidation.
381
+ *
316
382
  * @generated from enum value: TERMINATION_REASON_COMPANY_DEFUNCT_OR_LIQUIDATION = 5;
317
383
  */
318
384
  TerminationReason[TerminationReason["COMPANY_DEFUNCT_OR_LIQUIDATION"] = 5] = "COMPANY_DEFUNCT_OR_LIQUIDATION";
319
385
  /**
386
+ * Producer owes money to the insurance company (e.g., unremitted premiums).
387
+ *
320
388
  * @generated from enum value: TERMINATION_REASON_COMPANY_INDEBTEDNESS = 6;
321
389
  */
322
390
  TerminationReason[TerminationReason["COMPANY_INDEBTEDNESS"] = 6] = "COMPANY_INDEBTEDNESS";
323
391
  /**
392
+ * Carrier terminated due to poor service to policyholders.
393
+ *
324
394
  * @generated from enum value: TERMINATION_REASON_POOR_POLICYHOLDER_SERVICE = 7;
325
395
  */
326
396
  TerminationReason[TerminationReason["POOR_POLICYHOLDER_SERVICE"] = 7] = "POOR_POLICYHOLDER_SERVICE";
327
397
  /**
398
+ * Producer relocated to a different jurisdiction.
399
+ *
328
400
  * @generated from enum value: TERMINATION_REASON_AGENT_MOVED = 8;
329
401
  */
330
402
  TerminationReason[TerminationReason["AGENT_MOVED"] = 8] = "AGENT_MOVED";
331
403
  /**
404
+ * Appointment was created in error and is being corrected.
405
+ *
332
406
  * @generated from enum value: TERMINATION_REASON_APPOINTED_IN_ERROR = 9;
333
407
  */
334
408
  TerminationReason[TerminationReason["APPOINTED_IN_ERROR"] = 9] = "APPOINTED_IN_ERROR";
335
409
  /**
410
+ * General cancellation without a more specific reason.
411
+ *
336
412
  * @generated from enum value: TERMINATION_REASON_CANCELLED = 10;
337
413
  */
338
414
  TerminationReason[TerminationReason["CANCELLED"] = 10] = "CANCELLED";
339
415
  /**
416
+ * Carrier terminated for cause (e.g., misconduct, policy violations).
417
+ *
340
418
  * @generated from enum value: TERMINATION_REASON_CANCELLED_FOR_CAUSE = 11;
341
419
  */
342
420
  TerminationReason[TerminationReason["CANCELLED_FOR_CAUSE"] = 11] = "CANCELLED_FOR_CAUSE";
343
421
  /**
422
+ * Insurance company merged with another company.
423
+ *
344
424
  * @generated from enum value: TERMINATION_REASON_COMPANY_MERGER = 12;
345
425
  */
346
426
  TerminationReason[TerminationReason["COMPANY_MERGER"] = 12] = "COMPANY_MERGER";
347
427
  /**
428
+ * Producer's license has been revoked by a regulatory authority.
429
+ *
348
430
  * @generated from enum value: TERMINATION_REASON_REVOKED = 13;
349
431
  */
350
432
  TerminationReason[TerminationReason["REVOKED"] = 13] = "REVOKED";
351
433
  /**
434
+ * Producer's license has been suspended for compliance issues.
435
+ *
352
436
  * @generated from enum value: TERMINATION_REASON_SUSPENDED_FOR_COMPLIANCE = 14;
353
437
  */
354
438
  TerminationReason[TerminationReason["SUSPENDED_FOR_COMPLIANCE"] = 14] = "SUSPENDED_FOR_COMPLIANCE";
355
439
  /**
440
+ * Termination is being submitted for regulatory review by the state DOI.
441
+ *
356
442
  * @generated from enum value: TERMINATION_REASON_REQUEST_REGULATORY_REVIEW = 15;
357
443
  */
358
444
  TerminationReason[TerminationReason["REQUEST_REGULATORY_REVIEW"] = 15] = "REQUEST_REGULATORY_REVIEW";