@producerflow/producerflowapi 1.0.2 → 1.0.5
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.
|
@@ -41,8 +41,11 @@ export type RequestAppointmentResponse = Message<"producerflow.appointment.v1.Re
|
|
|
41
41
|
appointmentId: string;
|
|
42
42
|
/**
|
|
43
43
|
* Processing status of the appointment request.
|
|
44
|
-
*
|
|
45
|
-
* For
|
|
44
|
+
*
|
|
45
|
+
* For NIPR-integrated carriers: IN_PROGRESS if accepted, REJECTED if
|
|
46
|
+
* rejected.
|
|
47
|
+
*
|
|
48
|
+
* For registry states or non-NIPR carriers: APPOINTED if successful.
|
|
46
49
|
*
|
|
47
50
|
* @generated from field: producerflow.appointment.v1.ProcessingStatus processing_status = 2;
|
|
48
51
|
*/
|
|
@@ -168,9 +171,9 @@ export type TerminateAppointmentRequest = Message<"producerflow.appointment.v1.T
|
|
|
168
171
|
*/
|
|
169
172
|
appointmentId: string;
|
|
170
173
|
/**
|
|
171
|
-
* Reason for termination. This must be a valid termination reason
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
+
* Reason for termination. This must be a valid termination reason for the
|
|
175
|
+
* state where the license is issued. Call ListTerminationReasons first to
|
|
176
|
+
* get the list of valid reasons for the specific state.
|
|
174
177
|
*
|
|
175
178
|
* @generated from field: producerflow.appointment.v1.TerminationReason reason = 2;
|
|
176
179
|
*/
|
|
@@ -186,7 +189,18 @@ export declare const TerminateAppointmentRequestSchema: GenMessage<TerminateAppo
|
|
|
186
189
|
*/
|
|
187
190
|
export type TerminateAppointmentResponse = Message<"producerflow.appointment.v1.TerminateAppointmentResponse"> & {
|
|
188
191
|
/**
|
|
189
|
-
* Indicates whether the termination request was successfully processed.
|
|
192
|
+
* Indicates whether the termination request was successfully processed.
|
|
193
|
+
*
|
|
194
|
+
* For NIPR-integrated carriers:
|
|
195
|
+
* - Indicates whether the termination request was successfully submitted to
|
|
196
|
+
* NIPR.
|
|
197
|
+
* - This does not indicate that the appointment has been terminated, only
|
|
198
|
+
* that the request has been accepted for processing.
|
|
199
|
+
* - The actual termination will be processed asynchronously by NIPR, and
|
|
200
|
+
* you will be notified via webhook when the process completes.
|
|
201
|
+
*
|
|
202
|
+
* For registry states or non-NIPR carriers:
|
|
203
|
+
* - Indicates whether the termination was successfully completed immediately.
|
|
190
204
|
*
|
|
191
205
|
* @generated from field: bool success = 1;
|
|
192
206
|
*/
|
|
@@ -315,6 +329,8 @@ export type GetTerminationFeesResponse = Message<"producerflow.appointment.v1.Ge
|
|
|
315
329
|
*/
|
|
316
330
|
export declare const GetTerminationFeesResponseSchema: GenMessage<GetTerminationFeesResponse>;
|
|
317
331
|
/**
|
|
332
|
+
* Request to retrieve carriers that are available to be appointed.
|
|
333
|
+
*
|
|
318
334
|
* @generated from message producerflow.appointment.v1.GetAppointableCarriersRequest
|
|
319
335
|
*/
|
|
320
336
|
export type GetAppointableCarriersRequest = Message<"producerflow.appointment.v1.GetAppointableCarriersRequest"> & {};
|
|
@@ -324,6 +340,8 @@ export type GetAppointableCarriersRequest = Message<"producerflow.appointment.v1
|
|
|
324
340
|
*/
|
|
325
341
|
export declare const GetAppointableCarriersRequestSchema: GenMessage<GetAppointableCarriersRequest>;
|
|
326
342
|
/**
|
|
343
|
+
* Response containing carriers that are available to be appointed.
|
|
344
|
+
*
|
|
327
345
|
* @generated from message producerflow.appointment.v1.GetAppointableCarriersResponse
|
|
328
346
|
*/
|
|
329
347
|
export type GetAppointableCarriersResponse = Message<"producerflow.appointment.v1.GetAppointableCarriersResponse"> & {
|
|
@@ -364,7 +382,7 @@ export type Carrier = Message<"producerflow.appointment.v1.Carrier"> & {
|
|
|
364
382
|
*/
|
|
365
383
|
npn: string;
|
|
366
384
|
/**
|
|
367
|
-
* The
|
|
385
|
+
* The FEIN of the carrier.
|
|
368
386
|
*
|
|
369
387
|
* @generated from field: string fein = 4;
|
|
370
388
|
*/
|
|
@@ -376,9 +394,9 @@ export type Carrier = Message<"producerflow.appointment.v1.Carrier"> & {
|
|
|
376
394
|
*/
|
|
377
395
|
cocode: string;
|
|
378
396
|
/**
|
|
379
|
-
* Indicates whether this carrier has NIPR integration enabled.
|
|
380
|
-
*
|
|
381
|
-
* automatically without going through NIPR.
|
|
397
|
+
* Indicates whether this carrier has NIPR integration enabled. Capacity
|
|
398
|
+
* carriers (carriers without NIPR integration) process appointments and
|
|
399
|
+
* terminations automatically without going through NIPR.
|
|
382
400
|
*
|
|
383
401
|
* @generated from field: bool has_nipr_integration = 6;
|
|
384
402
|
*/
|
|
@@ -404,15 +422,15 @@ export type AppointmentOperationalStatus = Message<"producerflow.appointment.v1.
|
|
|
404
422
|
*/
|
|
405
423
|
status: OperationalStatus;
|
|
406
424
|
/**
|
|
407
|
-
* Specific reason(s) why the appointment is at risk, if applicable.
|
|
408
|
-
*
|
|
425
|
+
* Specific reason(s) why the appointment is at risk, if applicable. This
|
|
426
|
+
* field is only populated when status is AT_RISK.
|
|
409
427
|
*
|
|
410
428
|
* @generated from field: repeated producerflow.appointment.v1.RiskReason risk_reasons = 2;
|
|
411
429
|
*/
|
|
412
430
|
riskReasons: RiskReason[];
|
|
413
431
|
/**
|
|
414
|
-
* Timestamp when the operational status was last updated.
|
|
415
|
-
*
|
|
432
|
+
* Timestamp when the operational status was last updated. This helps track
|
|
433
|
+
* when status changes occurred.
|
|
416
434
|
*
|
|
417
435
|
* @generated from field: google.protobuf.Timestamp last_updated = 3;
|
|
418
436
|
*/
|
|
@@ -454,7 +472,7 @@ export type Appointment = Message<"producerflow.appointment.v1.Appointment"> & {
|
|
|
454
472
|
*/
|
|
455
473
|
agencyId: string;
|
|
456
474
|
/**
|
|
457
|
-
* The id of the producer that is appointed, if any.
|
|
475
|
+
* Optional. The id of the producer that is appointed, if any.
|
|
458
476
|
*
|
|
459
477
|
* @generated from field: optional string producer_id = 5;
|
|
460
478
|
*/
|
|
@@ -478,19 +496,19 @@ export type Appointment = Message<"producerflow.appointment.v1.Appointment"> & {
|
|
|
478
496
|
*/
|
|
479
497
|
processingStatus: ProcessingStatus;
|
|
480
498
|
/**
|
|
481
|
-
* Optional
|
|
499
|
+
* Optional. Comments or notes related to the appointment.
|
|
482
500
|
*
|
|
483
501
|
* @generated from field: string comments = 9;
|
|
484
502
|
*/
|
|
485
503
|
comments: string;
|
|
486
504
|
/**
|
|
487
|
-
* Timestamp of the
|
|
505
|
+
* Timestamp of when the appointment becomes effective.
|
|
488
506
|
*
|
|
489
507
|
* @generated from field: google.protobuf.Timestamp effective_date = 10;
|
|
490
508
|
*/
|
|
491
509
|
effectiveDate?: Timestamp;
|
|
492
510
|
/**
|
|
493
|
-
* Timestamp of the termination of the appointment.
|
|
511
|
+
* Optional. Timestamp of the termination of the appointment.
|
|
494
512
|
*
|
|
495
513
|
* @generated from field: optional google.protobuf.Timestamp termination_date = 11;
|
|
496
514
|
*/
|
|
@@ -502,9 +520,9 @@ export type Appointment = Message<"producerflow.appointment.v1.Appointment"> & {
|
|
|
502
520
|
*/
|
|
503
521
|
updatedAt?: Timestamp;
|
|
504
522
|
/**
|
|
505
|
-
* Operational status information for the appointment.
|
|
506
|
-
*
|
|
507
|
-
*
|
|
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.
|
|
508
526
|
*
|
|
509
527
|
* @generated from field: producerflow.appointment.v1.AppointmentOperationalStatus operational_status = 13;
|
|
510
528
|
*/
|
|
@@ -516,8 +534,8 @@ export type Appointment = Message<"producerflow.appointment.v1.Appointment"> & {
|
|
|
516
534
|
*/
|
|
517
535
|
cocode: string;
|
|
518
536
|
/**
|
|
519
|
-
* The id of the parent appointment, if this is a synthetic
|
|
520
|
-
* It should be empty for non-synthetic appointments.
|
|
537
|
+
* Optional. The id of the parent appointment, if this is a synthetic
|
|
538
|
+
* appointment. It should be empty for non-synthetic appointments.
|
|
521
539
|
*
|
|
522
540
|
* @generated from field: string parent_appointment_id = 15;
|
|
523
541
|
*/
|
|
@@ -578,12 +596,19 @@ export type License = Message<"producerflow.appointment.v1.License"> & {
|
|
|
578
596
|
*/
|
|
579
597
|
licenseClass: string;
|
|
580
598
|
/**
|
|
581
|
-
* Indicates whether this license is in a registry state.
|
|
582
|
-
*
|
|
599
|
+
* Indicates whether this license is in a registry state. Licenses in
|
|
600
|
+
* registry states and capacity carriers are processed automatically without
|
|
601
|
+
* going through NIPR.
|
|
583
602
|
*
|
|
584
603
|
* @generated from field: bool is_registry_state = 7;
|
|
585
604
|
*/
|
|
586
605
|
isRegistryState: boolean;
|
|
606
|
+
/**
|
|
607
|
+
* The ID of the carrier associated with this license.
|
|
608
|
+
*
|
|
609
|
+
* @generated from field: string carrier_id = 8;
|
|
610
|
+
*/
|
|
611
|
+
carrierId: string;
|
|
587
612
|
};
|
|
588
613
|
/**
|
|
589
614
|
* Describes the message producerflow.appointment.v1.License.
|
|
@@ -595,9 +620,9 @@ export declare const LicenseSchema: GenMessage<License>;
|
|
|
595
620
|
*/
|
|
596
621
|
export type ListTerminationReasonsRequest = Message<"producerflow.appointment.v1.ListTerminationReasonsRequest"> & {
|
|
597
622
|
/**
|
|
598
|
-
* Required. The two-letter state code of the license for which you want to
|
|
599
|
-
* valid termination reasons. Different states may have different
|
|
600
|
-
* termination reasons accepted by NIPR.
|
|
623
|
+
* Required. The two-letter state code of the license for which you want to
|
|
624
|
+
* retrieve valid termination reasons. Different states may have different
|
|
625
|
+
* sets of valid termination reasons accepted by NIPR.
|
|
601
626
|
*
|
|
602
627
|
* @generated from field: string state = 1;
|
|
603
628
|
*/
|
|
@@ -613,9 +638,9 @@ export declare const ListTerminationReasonsRequestSchema: GenMessage<ListTermina
|
|
|
613
638
|
*/
|
|
614
639
|
export type ListTerminationReasonsResponse = Message<"producerflow.appointment.v1.ListTerminationReasonsResponse"> & {
|
|
615
640
|
/**
|
|
616
|
-
* The list of valid termination reasons for the specified state.
|
|
617
|
-
*
|
|
618
|
-
*
|
|
641
|
+
* The list of valid termination reasons for the specified state. These
|
|
642
|
+
* reasons can be used when calling TerminateAppointment for licenses issued
|
|
643
|
+
* in this state.
|
|
619
644
|
*
|
|
620
645
|
* @generated from field: repeated producerflow.appointment.v1.TerminationReason termination_reasons = 1;
|
|
621
646
|
*/
|
|
@@ -781,7 +806,13 @@ export declare enum AppointmentType {
|
|
|
781
806
|
*/
|
|
782
807
|
export declare const AppointmentTypeSchema: GenEnum<AppointmentType>;
|
|
783
808
|
/**
|
|
784
|
-
* TerminationReason represents the reason for the termination of an appointment.
|
|
809
|
+
* TerminationReason represents the reason for the termination of an appointment.
|
|
810
|
+
*
|
|
811
|
+
* 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.
|
|
814
|
+
*
|
|
815
|
+
* Reference: https://pdb.nipr.com/Gateway/ValidTerms
|
|
785
816
|
*
|
|
786
817
|
* @generated from enum producerflow.appointment.v1.TerminationReason
|
|
787
818
|
*/
|
|
@@ -856,11 +887,29 @@ export declare enum TerminationReason {
|
|
|
856
887
|
*/
|
|
857
888
|
export declare const TerminationReasonSchema: GenEnum<TerminationReason>;
|
|
858
889
|
/**
|
|
859
|
-
* AppointmentService manages license appointments through NIPR.
|
|
890
|
+
* AppointmentService manages license appointments through NIPR.
|
|
891
|
+
*
|
|
892
|
+
* The appointment flow in NIPR is as follows:
|
|
893
|
+
* 1. A new appointment (or termination) is requested for a license number.
|
|
894
|
+
* 2. Some time later, NIPR processes the request and returns the final result.
|
|
860
895
|
*
|
|
861
|
-
*
|
|
862
|
-
*
|
|
863
|
-
*
|
|
896
|
+
* Since NIPR does not return results immediately, RequestAppointment and
|
|
897
|
+
* TerminateAppointment RPCs will return a processing status of IN_PROGRESS if
|
|
898
|
+
* the request is accepted by NIPR. When the appointment is finally processed by
|
|
899
|
+
* NIPR, ProducerFlow will notify via a webhook of the final result. Also, any
|
|
900
|
+
* call from this point on to ListAppointments or GetAppointment will also
|
|
901
|
+
* return the final result.
|
|
902
|
+
*
|
|
903
|
+
* IMPORTANT: Appointments in registry states or with capacity carriers
|
|
904
|
+
* (carriers that do not have NIPR integration) are processed automatically
|
|
905
|
+
* without going through NIPR. In these cases:
|
|
906
|
+
* - RequestAppointment will immediately return APPOINTED status.
|
|
907
|
+
* - TerminateAppointment will immediately return TERMINATED status.
|
|
908
|
+
*
|
|
909
|
+
* Any call to this service must be authenticated using an API key in the
|
|
910
|
+
* request headers. The API key can be found in the ProducerFlow API key
|
|
911
|
+
* section of the ProducerFlow UI and it identifies the tenant that is making
|
|
912
|
+
* the request.
|
|
864
913
|
*
|
|
865
914
|
* @generated from service producerflow.appointment.v1.AppointmentService
|
|
866
915
|
*/
|
|
@@ -928,7 +977,27 @@ export declare const AppointmentService: GenService<{
|
|
|
928
977
|
output: typeof ListEligibleLicensesResponseSchema;
|
|
929
978
|
};
|
|
930
979
|
/**
|
|
931
|
-
* Requests a new appointment for a license that is eligible to be appointed.
|
|
980
|
+
* Requests a new appointment for a license that is eligible to be appointed.
|
|
981
|
+
*
|
|
982
|
+
* The simpler way to do this is to call ListEligibleLicenses to get a list of
|
|
983
|
+
* licenses that are eligible to be appointed. Then, call RequestAppointment
|
|
984
|
+
* for the licenses in the list that you want to appoint.
|
|
985
|
+
*
|
|
986
|
+
* Processing behavior varies based on the license state and carrier NIPR
|
|
987
|
+
* integration:
|
|
988
|
+
*
|
|
989
|
+
* For NIPR-integrated carriers in non-registry states:
|
|
990
|
+
* - If the request is accepted by NIPR, the appointment will have
|
|
991
|
+
* IN_PROGRESS processing status.
|
|
992
|
+
* - If rejected, it will have REJECTED status and reasons will be provided
|
|
993
|
+
* in not_eligible_reasons.
|
|
994
|
+
* - Final result will be delivered via webhook when NIPR completes
|
|
995
|
+
* processing.
|
|
996
|
+
*
|
|
997
|
+
* For registry states or capacity carriers (carriers without NIPR
|
|
998
|
+
* integration):
|
|
999
|
+
* - The appointment is processed automatically and immediately.
|
|
1000
|
+
* - Returns APPOINTED status immediately upon successful processing.
|
|
932
1001
|
*
|
|
933
1002
|
* @generated from rpc producerflow.appointment.v1.AppointmentService.RequestAppointment
|
|
934
1003
|
*/
|
|
@@ -938,7 +1007,38 @@ export declare const AppointmentService: GenService<{
|
|
|
938
1007
|
output: typeof RequestAppointmentResponseSchema;
|
|
939
1008
|
};
|
|
940
1009
|
/**
|
|
941
|
-
* Terminates an existing appointment, permanently ending the relationship
|
|
1010
|
+
* Terminates an existing appointment, permanently ending the relationship
|
|
1011
|
+
* between the license holder and the carrier.
|
|
1012
|
+
*
|
|
1013
|
+
* Before calling this method, you must:
|
|
1014
|
+
* 1. Ensure the appointment exists and is in APPOINTED status.
|
|
1015
|
+
* 2. Call ListTerminationReasons to get valid termination reasons for the
|
|
1016
|
+
* license's state.
|
|
1017
|
+
* 3. Select an appropriate termination reason from the state-specific list.
|
|
1018
|
+
*
|
|
1019
|
+
* Processing behavior varies based on the license state and carrier NIPR
|
|
1020
|
+
* integration:
|
|
1021
|
+
*
|
|
1022
|
+
* For NIPR-integrated carriers in non-registry states:
|
|
1023
|
+
* - The request is submitted to NIPR for processing.
|
|
1024
|
+
* - Once NIPR completes processing, the status becomes TERMINATED.
|
|
1025
|
+
* - If rejected by NIPR, the appointment remains in its current status.
|
|
1026
|
+
* - You will receive webhook notifications when the termination is processed
|
|
1027
|
+
* by NIPR.
|
|
1028
|
+
*
|
|
1029
|
+
* For registry states or capacity carriers (carriers without NIPR
|
|
1030
|
+
* integration):
|
|
1031
|
+
* - The termination is processed automatically and immediately.
|
|
1032
|
+
* - Returns TERMINATED status immediately upon successful processing.
|
|
1033
|
+
*
|
|
1034
|
+
* Important considerations:
|
|
1035
|
+
* - Termination is permanent and cannot be undone.
|
|
1036
|
+
* - Termination reasons must be valid for the specific state where the
|
|
1037
|
+
* license is issued.
|
|
1038
|
+
* - Some terminations may incur fees (check GetTerminationFees first).
|
|
1039
|
+
* - The response indicates whether the termination request was successfully
|
|
1040
|
+
* submitted, not whether the actual termination was completed (since NIPR
|
|
1041
|
+
* processes asynchronously).
|
|
942
1042
|
*
|
|
943
1043
|
* @generated from rpc producerflow.appointment.v1.AppointmentService.TerminateAppointment
|
|
944
1044
|
*/
|
|
@@ -948,7 +1048,18 @@ export declare const AppointmentService: GenService<{
|
|
|
948
1048
|
output: typeof TerminateAppointmentResponseSchema;
|
|
949
1049
|
};
|
|
950
1050
|
/**
|
|
951
|
-
* Lists the valid termination reasons for appointments in a specific state.
|
|
1051
|
+
* Lists the valid termination reasons for appointments in a specific state.
|
|
1052
|
+
*
|
|
1053
|
+
* When terminating an appointment, you must provide a valid termination
|
|
1054
|
+
* reason that is accepted by NIPR for the state where the license is
|
|
1055
|
+
* issued. Termination reasons vary by state, so you should call this method
|
|
1056
|
+
* first to retrieve the list of valid reasons before calling
|
|
1057
|
+
* TerminateAppointment.
|
|
1058
|
+
*
|
|
1059
|
+
* The termination reasons returned are based on NIPR's valid termination
|
|
1060
|
+
* codes for the specified state. Each reason corresponds to a specific
|
|
1061
|
+
* business scenario for why an appointment might be terminated (e.g.,
|
|
1062
|
+
* voluntary termination, inadequate production, company merger, etc.).
|
|
952
1063
|
*
|
|
953
1064
|
* @generated from rpc producerflow.appointment.v1.AppointmentService.ListTerminationReasons
|
|
954
1065
|
*/
|
|
@@ -10,7 +10,7 @@ const wkt_1 = require("@bufbuild/protobuf/wkt");
|
|
|
10
10
|
/**
|
|
11
11
|
* Describes the file producerflow/appointment/v1/appointment.proto.
|
|
12
12
|
*/
|
|
13
|
-
exports.file_producerflow_appointment_v1_appointment = (0, codegenv2_1.fileDesc)("
|
|
13
|
+
exports.file_producerflow_appointment_v1_appointment = (0, codegenv2_1.fileDesc)("Ci1wcm9kdWNlcmZsb3cvYXBwb2ludG1lbnQvdjEvYXBwb2ludG1lbnQucHJvdG8SG3Byb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MSJXChlSZXF1ZXN0QXBwb2ludG1lbnRSZXF1ZXN0EhwKCmxpY2Vuc2VfaWQYASABKAlCCLpIBXIDsAEBEhwKCmNhcnJpZXJfaWQYAiABKAlCCLpIBXIDsAEBIpwBChpSZXF1ZXN0QXBwb2ludG1lbnRSZXNwb25zZRIWCg5hcHBvaW50bWVudF9pZBgBIAEoCRJIChFwcm9jZXNzaW5nX3N0YXR1cxgCIAEoDjItLnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5Qcm9jZXNzaW5nU3RhdHVzEhwKFG5vdF9lbGlnaWJsZV9yZWFzb25zGAMgAygJIjkKFUdldEFwcG9pbnRtZW50UmVxdWVzdBIgCg5hcHBvaW50bWVudF9pZBgBIAEoCUIIukgFcgOwAQEiVwoWR2V0QXBwb2ludG1lbnRSZXNwb25zZRI9CgthcHBvaW50bWVudBgBIAEoCzIoLnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5BcHBvaW50bWVudCK7AQoXTGlzdEFwcG9pbnRtZW50c1JlcXVlc3QSSAoRcHJvY2Vzc2luZ19zdGF0dXMYASADKA4yLS5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuUHJvY2Vzc2luZ1N0YXR1cxIfCgtwcm9kdWNlcl9pZBgCIAEoCUIIukgFcgOwAQFIABIdCglhZ2VuY3lfaWQYAyABKAlCCLpIBXIDsAEBSABCFgoNbGljZW5zZV9vd25lchIFukgCCAEicwoYTGlzdEFwcG9pbnRtZW50c1Jlc3BvbnNlEj4KDGFwcG9pbnRtZW50cxgBIAMoCzIoLnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5BcHBvaW50bWVudBIXCg9uZXh0X3BhZ2VfdG9rZW4YAiABKAkiiQEKG1Rlcm1pbmF0ZUFwcG9pbnRtZW50UmVxdWVzdBIgCg5hcHBvaW50bWVudF9pZBgBIAEoCUIIukgFcgOwAQESSAoGcmVhc29uGAIgASgOMi4ucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLlRlcm1pbmF0aW9uUmVhc29uQgi6SAWCAQIQASIvChxUZXJtaW5hdGVBcHBvaW50bWVudFJlc3BvbnNlEg8KB3N1Y2Nlc3MYASABKAgicQobTGlzdEVsaWdpYmxlTGljZW5zZXNSZXF1ZXN0Eh8KC3Byb2R1Y2VyX2lkGAEgASgJQgi6SAVyA7ABAUgAEh0KCWFnZW5jeV9pZBgCIAEoCUIIukgFcgOwAQFIAEISCglhcHBsaWNhbnQSBbpIAggBIlYKHExpc3RFbGlnaWJsZUxpY2Vuc2VzUmVzcG9uc2USNgoIbGljZW5zZXMYASADKAsyJC5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuTGljZW5zZSI5ChlHZXRBcHBvaW50bWVudEZlZXNSZXF1ZXN0EhwKCmxpY2Vuc2VfaWQYASABKAlCCLpIBXIDsAEBIjIKGkdldEFwcG9pbnRtZW50RmVlc1Jlc3BvbnNlEhQKDGZlZV9pbl9jZW50cxgBIAEoAyI5ChlHZXRUZXJtaW5hdGlvbkZlZXNSZXF1ZXN0EhwKCmxpY2Vuc2VfaWQYASABKAlCCLpIBXIDsAEBIjIKGkdldFRlcm1pbmF0aW9uRmVlc1Jlc3BvbnNlEhQKDGZlZV9pbl9jZW50cxgBIAEoAyIfCh1HZXRBcHBvaW50YWJsZUNhcnJpZXJzUmVxdWVzdCJYCh5HZXRBcHBvaW50YWJsZUNhcnJpZXJzUmVzcG9uc2USNgoIY2FycmllcnMYASADKAsyJC5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuQ2FycmllciJ0CgdDYXJyaWVyEhIKCmNhcnJpZXJfaWQYASABKAkSDAoEbmFtZRgCIAEoCRILCgNucG4YAyABKAkSDAoEZmVpbhgEIAEoCRIOCgZjb2NvZGUYBSABKAkSHAoUaGFzX25pcHJfaW50ZWdyYXRpb24YBiABKAgizwEKHEFwcG9pbnRtZW50T3BlcmF0aW9uYWxTdGF0dXMSPgoGc3RhdHVzGAEgASgOMi4ucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLk9wZXJhdGlvbmFsU3RhdHVzEj0KDHJpc2tfcmVhc29ucxgCIAMoDjInLnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5SaXNrUmVhc29uEjAKDGxhc3RfdXBkYXRlZBgDIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXAilgUKC0FwcG9pbnRtZW50EhYKDmFwcG9pbnRtZW50X2lkGAEgASgJEjUKB2xpY2Vuc2UYAiABKAsyJC5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuTGljZW5zZRIMCgRuYW1lGAMgASgJEhEKCWFnZW5jeV9pZBgEIAEoCRIYCgtwcm9kdWNlcl9pZBgFIAEoCUgAiAEBEg8KB2NhcnJpZXIYBiABKAkSRgoQYXBwb2ludG1lbnRfdHlwZRgHIAEoDjIsLnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5BcHBvaW50bWVudFR5cGUSSAoRcHJvY2Vzc2luZ19zdGF0dXMYCCABKA4yLS5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuUHJvY2Vzc2luZ1N0YXR1cxIQCghjb21tZW50cxgJIAEoCRIyCg5lZmZlY3RpdmVfZGF0ZRgKIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASOQoQdGVybWluYXRpb25fZGF0ZRgLIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBIAYgBARIuCgp1cGRhdGVkX2F0GAwgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBJVChJvcGVyYXRpb25hbF9zdGF0dXMYDSABKAsyOS5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuQXBwb2ludG1lbnRPcGVyYXRpb25hbFN0YXR1cxIOCgZjb2NvZGUYDiABKAkSHQoVcGFyZW50X2FwcG9pbnRtZW50X2lkGA8gASgJQg4KDF9wcm9kdWNlcl9pZEITChFfdGVybWluYXRpb25fZGF0ZSKEAgoHTGljZW5zZRIcCgpsaWNlbnNlX2lkGAEgASgJQgi6SAVyA7ABARIhCg5saWNlbnNlX251bWJlchgCIAEoCUIJukgGcgQQARgyEh8KC3Byb2R1Y2VyX2lkGAMgASgJQgi6SAVyA7ABAUgAEh0KCWFnZW5jeV9pZBgEIAEoCUIIukgFcgOwAQFIABIXCgVzdGF0ZRgFIAEoCUIIukgFcgOYAQISFQoNbGljZW5zZV9jbGFzcxgGIAEoCRIZChFpc19yZWdpc3RyeV9zdGF0ZRgHIAEoCBIcCgpjYXJyaWVyX2lkGAggASgJQgi6SAVyA7ABAUIPCg1saWNlbnNlX293bmVyIjgKHUxpc3RUZXJtaW5hdGlvblJlYXNvbnNSZXF1ZXN0EhcKBXN0YXRlGAEgASgJQgi6SAVyA5gBAiJtCh5MaXN0VGVybWluYXRpb25SZWFzb25zUmVzcG9uc2USSwoTdGVybWluYXRpb25fcmVhc29ucxgBIAMoDjIuLnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5UZXJtaW5hdGlvblJlYXNvbip2ChFPcGVyYXRpb25hbFN0YXR1cxIiCh5PUEVSQVRJT05BTF9TVEFUVVNfVU5TUEVDSUZJRUQQABIdChlPUEVSQVRJT05BTF9TVEFUVVNfQUNUSVZFEAESHgoaT1BFUkFUSU9OQUxfU1RBVFVTX0FUX1JJU0sQAirDAQoKUmlza1JlYXNvbhIbChdSSVNLX1JFQVNPTl9VTlNQRUNJRklFRBAAEiAKHFJJU0tfUkVBU09OX0xJQ0VOU0VfSU5BQ1RJVkUQARIfChtSSVNLX1JFQVNPTl9MSUNFTlNFX0VYUElSRUQQAhIcChhSSVNLX1JFQVNPTl9FT19OT1RfRk9VTkQQAxIbChdSSVNLX1JFQVNPTl9FT19JTkFDVElWRRAEEhoKFlJJU0tfUkVBU09OX0VPX0VYUElSRUQQBSqPAgoQUHJvY2Vzc2luZ1N0YXR1cxIhCh1QUk9DRVNTSU5HX1NUQVRVU19VTlNQRUNJRklFRBAAEiEKHVBST0NFU1NJTkdfU1RBVFVTX0lOX1BST0dSRVNTEAESHwobUFJPQ0VTU0lOR19TVEFUVVNfQVBQT0lOVEVEEAISIAocUFJPQ0VTU0lOR19TVEFUVVNfVEVSTUlOQVRFRBADEh4KGlBST0NFU1NJTkdfU1RBVFVTX1JFSkVDVEVEEAQSJQohUFJPQ0VTU0lOR19TVEFUVVNfTUlTU0lOR19MSUNFTlNFEAUSKwonUFJPQ0VTU0lOR19TVEFUVVNfVEVSTUlOQVRJT05fUkVRVUVTVEVEEAYqtAEKD0FwcG9pbnRtZW50VHlwZRIgChxBUFBPSU5UTUVOVF9UWVBFX1VOU1BFQ0lGSUVEEAASHQoZQVBQT0lOVE1FTlRfVFlQRV9SRUdJU1RSWRABEh0KGUFQUE9JTlRNRU5UX1RZUEVfVVBfRlJPTlQQAhIhCh1BUFBPSU5UTUVOVF9UWVBFX0pVU1RfSU5fVElNRRADEh4KGkFQUE9JTlRNRU5UX1RZUEVfU1lOVEhFVElDEAQqwQUKEVRlcm1pbmF0aW9uUmVhc29uEiIKHlRFUk1JTkFUSU9OX1JFQVNPTl9VTlNQRUNJRklFRBAAEiwKKFRFUk1JTkFUSU9OX1JFQVNPTl9WT0xVTlRBUllfVEVSTUlOQVRJT04QARIsCihURVJNSU5BVElPTl9SRUFTT05fSU5BREVRVUFURV9QUk9EVUNUSU9OEAISMQotVEVSTUlOQVRJT05fUkVBU09OX0NBTkNFTExFRF9CWV9HRU5FUkFMX0FHRU5UEAMSHAoYVEVSTUlOQVRJT05fUkVBU09OX0RFQVRIEAQSNQoxVEVSTUlOQVRJT05fUkVBU09OX0NPTVBBTllfREVGVU5DVF9PUl9MSVFVSURBVElPThAFEisKJ1RFUk1JTkFUSU9OX1JFQVNPTl9DT01QQU5ZX0lOREVCVEVETkVTUxAGEjAKLFRFUk1JTkFUSU9OX1JFQVNPTl9QT09SX1BPTElDWUhPTERFUl9TRVJWSUNFEAcSIgoeVEVSTUlOQVRJT05fUkVBU09OX0FHRU5UX01PVkVEEAgSKQolVEVSTUlOQVRJT05fUkVBU09OX0FQUE9JTlRFRF9JTl9FUlJPUhAJEiAKHFRFUk1JTkFUSU9OX1JFQVNPTl9DQU5DRUxMRUQQChIqCiZURVJNSU5BVElPTl9SRUFTT05fQ0FOQ0VMTEVEX0ZPUl9DQVVTRRALEiUKIVRFUk1JTkFUSU9OX1JFQVNPTl9DT01QQU5ZX01FUkdFUhAMEh4KGlRFUk1JTkFUSU9OX1JFQVNPTl9SRVZPS0VEEA0SLworVEVSTUlOQVRJT05fUkVBU09OX1NVU1BFTkRFRF9GT1JfQ09NUExJQU5DRRAOEjAKLFRFUk1JTkFUSU9OX1JFQVNPTl9SRVFVRVNUX1JFR1VMQVRPUllfUkVWSUVXEA8y8AkKEkFwcG9pbnRtZW50U2VydmljZRJ5Cg5HZXRBcHBvaW50bWVudBIyLnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5HZXRBcHBvaW50bWVudFJlcXVlc3QaMy5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuR2V0QXBwb2ludG1lbnRSZXNwb25zZRKFAQoSR2V0QXBwb2ludG1lbnRGZWVzEjYucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLkdldEFwcG9pbnRtZW50RmVlc1JlcXVlc3QaNy5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuR2V0QXBwb2ludG1lbnRGZWVzUmVzcG9uc2USkQEKFkdldEFwcG9pbnRhYmxlQ2FycmllcnMSOi5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuR2V0QXBwb2ludGFibGVDYXJyaWVyc1JlcXVlc3QaOy5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuR2V0QXBwb2ludGFibGVDYXJyaWVyc1Jlc3BvbnNlEoUBChJHZXRUZXJtaW5hdGlvbkZlZXMSNi5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuR2V0VGVybWluYXRpb25GZWVzUmVxdWVzdBo3LnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5HZXRUZXJtaW5hdGlvbkZlZXNSZXNwb25zZRJ/ChBMaXN0QXBwb2ludG1lbnRzEjQucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLkxpc3RBcHBvaW50bWVudHNSZXF1ZXN0GjUucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLkxpc3RBcHBvaW50bWVudHNSZXNwb25zZRKLAQoUTGlzdEVsaWdpYmxlTGljZW5zZXMSOC5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuTGlzdEVsaWdpYmxlTGljZW5zZXNSZXF1ZXN0GjkucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLkxpc3RFbGlnaWJsZUxpY2Vuc2VzUmVzcG9uc2UShwEKElJlcXVlc3RBcHBvaW50bWVudBI2LnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5SZXF1ZXN0QXBwb2ludG1lbnRSZXF1ZXN0GjcucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLlJlcXVlc3RBcHBvaW50bWVudFJlc3BvbnNlIgASjQEKFFRlcm1pbmF0ZUFwcG9pbnRtZW50EjgucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxLlRlcm1pbmF0ZUFwcG9pbnRtZW50UmVxdWVzdBo5LnByb2R1Y2VyZmxvdy5hcHBvaW50bWVudC52MS5UZXJtaW5hdGVBcHBvaW50bWVudFJlc3BvbnNlIgASkQEKFkxpc3RUZXJtaW5hdGlvblJlYXNvbnMSOi5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuTGlzdFRlcm1pbmF0aW9uUmVhc29uc1JlcXVlc3QaOy5wcm9kdWNlcmZsb3cuYXBwb2ludG1lbnQudjEuTGlzdFRlcm1pbmF0aW9uUmVhc29uc1Jlc3BvbnNlQpsCCh9jb20ucHJvZHVjZXJmbG93LmFwcG9pbnRtZW50LnYxQhBBcHBvaW50bWVudFByb3RvUAFaWGdpdGh1Yi5jb20vcHJvZHVjZXJmbG93L3Byb2R1Y2VyZmxvd2FwaS9nZW4vZ28vcHJvZHVjZXJmbG93L2FwcG9pbnRtZW50L3YxO2FwcG9pbnRtZW50djGiAgNQQViqAhtQcm9kdWNlcmZsb3cuQXBwb2ludG1lbnQuVjHKAhtQcm9kdWNlcmZsb3dcQXBwb2ludG1lbnRcVjHiAidQcm9kdWNlcmZsb3dcQXBwb2ludG1lbnRcVjFcR1BCTWV0YWRhdGHqAh1Qcm9kdWNlcmZsb3c6OkFwcG9pbnRtZW50OjpWMWIGcHJvdG8z", [validate_pb_1.file_buf_validate_validate, wkt_1.file_google_protobuf_timestamp]);
|
|
14
14
|
/**
|
|
15
15
|
* Describes the message producerflow.appointment.v1.RequestAppointmentRequest.
|
|
16
16
|
* Use `create(RequestAppointmentRequestSchema)` to create a new message.
|
|
@@ -280,7 +280,13 @@ var AppointmentType;
|
|
|
280
280
|
*/
|
|
281
281
|
exports.AppointmentTypeSchema = (0, codegenv2_1.enumDesc)(exports.file_producerflow_appointment_v1_appointment, 3);
|
|
282
282
|
/**
|
|
283
|
-
* TerminationReason represents the reason for the termination of an appointment.
|
|
283
|
+
* TerminationReason represents the reason for the termination of an appointment.
|
|
284
|
+
*
|
|
285
|
+
* 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.
|
|
288
|
+
*
|
|
289
|
+
* Reference: https://pdb.nipr.com/Gateway/ValidTerms
|
|
284
290
|
*
|
|
285
291
|
* @generated from enum producerflow.appointment.v1.TerminationReason
|
|
286
292
|
*/
|
|
@@ -356,11 +362,29 @@ var TerminationReason;
|
|
|
356
362
|
*/
|
|
357
363
|
exports.TerminationReasonSchema = (0, codegenv2_1.enumDesc)(exports.file_producerflow_appointment_v1_appointment, 4);
|
|
358
364
|
/**
|
|
359
|
-
* AppointmentService manages license appointments through NIPR.
|
|
365
|
+
* AppointmentService manages license appointments through NIPR.
|
|
366
|
+
*
|
|
367
|
+
* The appointment flow in NIPR is as follows:
|
|
368
|
+
* 1. A new appointment (or termination) is requested for a license number.
|
|
369
|
+
* 2. Some time later, NIPR processes the request and returns the final result.
|
|
370
|
+
*
|
|
371
|
+
* Since NIPR does not return results immediately, RequestAppointment and
|
|
372
|
+
* TerminateAppointment RPCs will return a processing status of IN_PROGRESS if
|
|
373
|
+
* the request is accepted by NIPR. When the appointment is finally processed by
|
|
374
|
+
* NIPR, ProducerFlow will notify via a webhook of the final result. Also, any
|
|
375
|
+
* call from this point on to ListAppointments or GetAppointment will also
|
|
376
|
+
* return the final result.
|
|
377
|
+
*
|
|
378
|
+
* IMPORTANT: Appointments in registry states or with capacity carriers
|
|
379
|
+
* (carriers that do not have NIPR integration) are processed automatically
|
|
380
|
+
* without going through NIPR. In these cases:
|
|
381
|
+
* - RequestAppointment will immediately return APPOINTED status.
|
|
382
|
+
* - TerminateAppointment will immediately return TERMINATED status.
|
|
360
383
|
*
|
|
361
|
-
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
384
|
+
* Any call to this service must be authenticated using an API key in the
|
|
385
|
+
* request headers. The API key can be found in the ProducerFlow API key
|
|
386
|
+
* section of the ProducerFlow UI and it identifies the tenant that is making
|
|
387
|
+
* the request.
|
|
364
388
|
*
|
|
365
389
|
* @generated from service producerflow.appointment.v1.AppointmentService
|
|
366
390
|
*/
|