@producerflow/producerflowapi 0.0.1
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.
- package/README.md +58 -0
- package/dist/README.md +58 -0
- package/dist/buf/validate/validate_pb.d.ts +4638 -0
- package/dist/buf/validate/validate_pb.js +414 -0
- package/dist/google/type/dayofweek_pb.d.ts +64 -0
- package/dist/google/type/dayofweek_pb.js +81 -0
- package/dist/google/type/timeofday_pb.d.ts +47 -0
- package/dist/google/type/timeofday_pb.js +26 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +21 -0
- package/dist/producerflow/appointment/v1/appointment_pb.d.ts +843 -0
- package/dist/producerflow/appointment/v1/appointment_pb.js +283 -0
- package/dist/producerflow/producer/v1/producer_pb.d.ts +3329 -0
- package/dist/producerflow/producer/v1/producer_pb.js +665 -0
- package/package.json +34 -0
|
@@ -0,0 +1,3329 @@
|
|
|
1
|
+
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { Timestamp } from "@bufbuild/protobuf/wkt";
|
|
3
|
+
import type { DayOfWeek } from "../../../google/type/dayofweek_pb";
|
|
4
|
+
import type { TimeOfDay } from "../../../google/type/timeofday_pb";
|
|
5
|
+
import type { Message } from "@bufbuild/protobuf";
|
|
6
|
+
/**
|
|
7
|
+
* Describes the file producerflow/producer/v1/producer.proto.
|
|
8
|
+
*/
|
|
9
|
+
export declare const file_producerflow_producer_v1_producer: GenFile;
|
|
10
|
+
/**
|
|
11
|
+
* Address represents a physical location with standard address components.
|
|
12
|
+
* Used for mailing, physical, and invoicing addresses throughout the API.
|
|
13
|
+
*
|
|
14
|
+
* @generated from message producerflow.producer.v1.Address
|
|
15
|
+
*/
|
|
16
|
+
export type Address = Message<"producerflow.producer.v1.Address"> & {
|
|
17
|
+
/**
|
|
18
|
+
* Street address including house/building number and street name
|
|
19
|
+
*
|
|
20
|
+
* @generated from field: string street = 1;
|
|
21
|
+
*/
|
|
22
|
+
street: string;
|
|
23
|
+
/**
|
|
24
|
+
* City of the address
|
|
25
|
+
*
|
|
26
|
+
* @generated from field: string city = 2;
|
|
27
|
+
*/
|
|
28
|
+
city: string;
|
|
29
|
+
/**
|
|
30
|
+
* State of the address
|
|
31
|
+
*
|
|
32
|
+
* @generated from field: string state = 3;
|
|
33
|
+
*/
|
|
34
|
+
state: string;
|
|
35
|
+
/**
|
|
36
|
+
* Zip code of the address
|
|
37
|
+
*
|
|
38
|
+
* @generated from field: string zip = 4;
|
|
39
|
+
*/
|
|
40
|
+
zip: string;
|
|
41
|
+
/**
|
|
42
|
+
* County of the address
|
|
43
|
+
*
|
|
44
|
+
* @generated from field: string county = 5;
|
|
45
|
+
*/
|
|
46
|
+
county: string;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* Describes the message producerflow.producer.v1.Address.
|
|
50
|
+
* Use `create(AddressSchema)` to create a new message.
|
|
51
|
+
*/
|
|
52
|
+
export declare const AddressSchema: GenMessage<Address>;
|
|
53
|
+
/**
|
|
54
|
+
* CreateAgencyOnboardingURLRequest contains information needed to generate
|
|
55
|
+
* an agency onboarding URL. This includes basic agency information and defaults.
|
|
56
|
+
*
|
|
57
|
+
* All fields in this request are optional. You can provide as much or as little
|
|
58
|
+
* information as you have available. Any missing information will be collected
|
|
59
|
+
* from the user during the onboarding process through the generated URL.
|
|
60
|
+
*
|
|
61
|
+
* @generated from message producerflow.producer.v1.CreateAgencyOnboardingURLRequest
|
|
62
|
+
*/
|
|
63
|
+
export type CreateAgencyOnboardingURLRequest = Message<"producerflow.producer.v1.CreateAgencyOnboardingURLRequest"> & {
|
|
64
|
+
/**
|
|
65
|
+
* @generated from field: producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency agency = 1;
|
|
66
|
+
*/
|
|
67
|
+
agency?: CreateAgencyOnboardingURLRequest_Agency;
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Describes the message producerflow.producer.v1.CreateAgencyOnboardingURLRequest.
|
|
71
|
+
* Use `create(CreateAgencyOnboardingURLRequestSchema)` to create a new message.
|
|
72
|
+
*/
|
|
73
|
+
export declare const CreateAgencyOnboardingURLRequestSchema: GenMessage<CreateAgencyOnboardingURLRequest>;
|
|
74
|
+
/**
|
|
75
|
+
* Agency contains the information about the agency to be onboarded.
|
|
76
|
+
* All fields within the Agency message are also optional.
|
|
77
|
+
*
|
|
78
|
+
* @generated from message producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency
|
|
79
|
+
*/
|
|
80
|
+
export type CreateAgencyOnboardingURLRequest_Agency = Message<"producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency"> & {
|
|
81
|
+
/**
|
|
82
|
+
* Name of the agency
|
|
83
|
+
*
|
|
84
|
+
* @generated from field: string name = 1;
|
|
85
|
+
*/
|
|
86
|
+
name: string;
|
|
87
|
+
/**
|
|
88
|
+
* Entity type of the agency: Sole Proprietor, Agency or Ask during onboarding
|
|
89
|
+
*
|
|
90
|
+
* @generated from field: producerflow.producer.v1.EntityType entity_type = 2;
|
|
91
|
+
*/
|
|
92
|
+
entityType: EntityType;
|
|
93
|
+
/**
|
|
94
|
+
* Tenant agency id is a unique identifier for the agency used by the tenant
|
|
95
|
+
* this is used to identify the agency in the tenant system not in the producerflow system
|
|
96
|
+
*
|
|
97
|
+
* @generated from field: string tenant_agency_id = 3;
|
|
98
|
+
*/
|
|
99
|
+
tenantAgencyId: string;
|
|
100
|
+
/**
|
|
101
|
+
* DocuSign template id is the id of the docusign template used to send the contract to the agency
|
|
102
|
+
*
|
|
103
|
+
* @generated from field: string docusign_template_id = 4;
|
|
104
|
+
*/
|
|
105
|
+
docusignTemplateId: string;
|
|
106
|
+
/**
|
|
107
|
+
* FEIN (Federal Employer Identification Number) of the agency
|
|
108
|
+
*
|
|
109
|
+
* @generated from field: string fein = 5;
|
|
110
|
+
*/
|
|
111
|
+
fein: string;
|
|
112
|
+
/**
|
|
113
|
+
* Email of the agency
|
|
114
|
+
*
|
|
115
|
+
* @generated from field: string email = 6;
|
|
116
|
+
*/
|
|
117
|
+
email: string;
|
|
118
|
+
/**
|
|
119
|
+
* Phone of the agency
|
|
120
|
+
*
|
|
121
|
+
* @generated from field: string phone = 7;
|
|
122
|
+
*/
|
|
123
|
+
phone: string;
|
|
124
|
+
/**
|
|
125
|
+
* Fax of the agency
|
|
126
|
+
*
|
|
127
|
+
* @generated from field: string fax = 8;
|
|
128
|
+
*/
|
|
129
|
+
fax: string;
|
|
130
|
+
/**
|
|
131
|
+
* Website of the agency
|
|
132
|
+
*
|
|
133
|
+
* @generated from field: string website = 9;
|
|
134
|
+
*/
|
|
135
|
+
website: string;
|
|
136
|
+
/**
|
|
137
|
+
* NPN of the agency. Note that if the entity type is Sole Proprietor the NPN will be ignored
|
|
138
|
+
*
|
|
139
|
+
* @generated from field: string npn = 10;
|
|
140
|
+
*/
|
|
141
|
+
npn: string;
|
|
142
|
+
/**
|
|
143
|
+
* Mailing address of the agency
|
|
144
|
+
*
|
|
145
|
+
* @generated from field: producerflow.producer.v1.Address mailing_address = 11;
|
|
146
|
+
*/
|
|
147
|
+
mailingAddress?: Address;
|
|
148
|
+
/**
|
|
149
|
+
* Physical address of the agency
|
|
150
|
+
*
|
|
151
|
+
* @generated from field: producerflow.producer.v1.Address physical_address = 12;
|
|
152
|
+
*/
|
|
153
|
+
physicalAddress?: Address;
|
|
154
|
+
/**
|
|
155
|
+
* Invoicing address of the agency
|
|
156
|
+
*
|
|
157
|
+
* @generated from field: producerflow.producer.v1.Address invoicing_address = 13;
|
|
158
|
+
*/
|
|
159
|
+
invoicingAddress?: Address;
|
|
160
|
+
/**
|
|
161
|
+
* Organization ID of the agency.
|
|
162
|
+
* To get valid organization IDs, use the ListOrganizations RPC.
|
|
163
|
+
*
|
|
164
|
+
* @generated from field: string organization_id = 15;
|
|
165
|
+
*/
|
|
166
|
+
organizationId: string;
|
|
167
|
+
/**
|
|
168
|
+
* @generated from field: producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency.Principal principal = 14;
|
|
169
|
+
*/
|
|
170
|
+
principal?: CreateAgencyOnboardingURLRequest_Agency_Principal;
|
|
171
|
+
};
|
|
172
|
+
/**
|
|
173
|
+
* Describes the message producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency.
|
|
174
|
+
* Use `create(CreateAgencyOnboardingURLRequest_AgencySchema)` to create a new message.
|
|
175
|
+
*/
|
|
176
|
+
export declare const CreateAgencyOnboardingURLRequest_AgencySchema: GenMessage<CreateAgencyOnboardingURLRequest_Agency>;
|
|
177
|
+
/**
|
|
178
|
+
* Principal is the person responsible for the agency.
|
|
179
|
+
* All fields within the Principal message are also optional.
|
|
180
|
+
*
|
|
181
|
+
* @generated from message producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency.Principal
|
|
182
|
+
*/
|
|
183
|
+
export type CreateAgencyOnboardingURLRequest_Agency_Principal = Message<"producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency.Principal"> & {
|
|
184
|
+
/**
|
|
185
|
+
* Tenant ID of the principal
|
|
186
|
+
*
|
|
187
|
+
* @generated from field: string tenant_id = 1;
|
|
188
|
+
*/
|
|
189
|
+
tenantId: string;
|
|
190
|
+
/**
|
|
191
|
+
* First name of the principal
|
|
192
|
+
*
|
|
193
|
+
* @generated from field: string first_name = 2;
|
|
194
|
+
*/
|
|
195
|
+
firstName: string;
|
|
196
|
+
/**
|
|
197
|
+
* Last name of the principal
|
|
198
|
+
*
|
|
199
|
+
* @generated from field: string last_name = 3;
|
|
200
|
+
*/
|
|
201
|
+
lastName: string;
|
|
202
|
+
/**
|
|
203
|
+
* Middle name of the principal
|
|
204
|
+
*
|
|
205
|
+
* @generated from field: string middle_name = 4;
|
|
206
|
+
*/
|
|
207
|
+
middleName: string;
|
|
208
|
+
/**
|
|
209
|
+
* Email of the principal
|
|
210
|
+
*
|
|
211
|
+
* @generated from field: string email = 5;
|
|
212
|
+
*/
|
|
213
|
+
email: string;
|
|
214
|
+
/**
|
|
215
|
+
* Phone of the principal
|
|
216
|
+
*
|
|
217
|
+
* @generated from field: string phone = 6;
|
|
218
|
+
*/
|
|
219
|
+
phone: string;
|
|
220
|
+
/**
|
|
221
|
+
* NPN of the principal
|
|
222
|
+
*
|
|
223
|
+
* @generated from field: string npn = 7;
|
|
224
|
+
*/
|
|
225
|
+
npn: string;
|
|
226
|
+
/**
|
|
227
|
+
* Address of the principal
|
|
228
|
+
*
|
|
229
|
+
* @generated from field: producerflow.producer.v1.Address address = 8;
|
|
230
|
+
*/
|
|
231
|
+
address?: Address;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Describes the message producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency.Principal.
|
|
235
|
+
* Use `create(CreateAgencyOnboardingURLRequest_Agency_PrincipalSchema)` to create a new message.
|
|
236
|
+
*/
|
|
237
|
+
export declare const CreateAgencyOnboardingURLRequest_Agency_PrincipalSchema: GenMessage<CreateAgencyOnboardingURLRequest_Agency_Principal>;
|
|
238
|
+
/**
|
|
239
|
+
* CreateAgencyOnboardingURLResponse contains the generated URL for agency onboarding
|
|
240
|
+
*
|
|
241
|
+
* @generated from message producerflow.producer.v1.CreateAgencyOnboardingURLResponse
|
|
242
|
+
*/
|
|
243
|
+
export type CreateAgencyOnboardingURLResponse = Message<"producerflow.producer.v1.CreateAgencyOnboardingURLResponse"> & {
|
|
244
|
+
/**
|
|
245
|
+
* URL that can be shared with the agency for self-onboarding
|
|
246
|
+
*
|
|
247
|
+
* @generated from field: string url = 1;
|
|
248
|
+
*/
|
|
249
|
+
url: string;
|
|
250
|
+
};
|
|
251
|
+
/**
|
|
252
|
+
* Describes the message producerflow.producer.v1.CreateAgencyOnboardingURLResponse.
|
|
253
|
+
* Use `create(CreateAgencyOnboardingURLResponseSchema)` to create a new message.
|
|
254
|
+
*/
|
|
255
|
+
export declare const CreateAgencyOnboardingURLResponseSchema: GenMessage<CreateAgencyOnboardingURLResponse>;
|
|
256
|
+
/**
|
|
257
|
+
* NewAgencyRequest contains complete information for creating a new agency
|
|
258
|
+
*
|
|
259
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest
|
|
260
|
+
*/
|
|
261
|
+
export type NewAgencyRequest = Message<"producerflow.producer.v1.NewAgencyRequest"> & {
|
|
262
|
+
/**
|
|
263
|
+
* @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency agency = 1;
|
|
264
|
+
*/
|
|
265
|
+
agency?: NewAgencyRequest_Agency;
|
|
266
|
+
/**
|
|
267
|
+
* Determines if the agency should be auto approved.
|
|
268
|
+
*
|
|
269
|
+
* @generated from field: bool auto_approve = 2 [deprecated = true];
|
|
270
|
+
* @deprecated
|
|
271
|
+
*/
|
|
272
|
+
autoApprove: boolean;
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.
|
|
276
|
+
* Use `create(NewAgencyRequestSchema)` to create a new message.
|
|
277
|
+
*/
|
|
278
|
+
export declare const NewAgencyRequestSchema: GenMessage<NewAgencyRequest>;
|
|
279
|
+
/**
|
|
280
|
+
* Agency contains all information about the agency to be created
|
|
281
|
+
*
|
|
282
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest.Agency
|
|
283
|
+
*/
|
|
284
|
+
export type NewAgencyRequest_Agency = Message<"producerflow.producer.v1.NewAgencyRequest.Agency"> & {
|
|
285
|
+
/**
|
|
286
|
+
* The name of the agency.
|
|
287
|
+
*
|
|
288
|
+
* @generated from field: string name = 1;
|
|
289
|
+
*/
|
|
290
|
+
name: string;
|
|
291
|
+
/**
|
|
292
|
+
* The email address of the agency.
|
|
293
|
+
*
|
|
294
|
+
* @generated from field: string email = 2;
|
|
295
|
+
*/
|
|
296
|
+
email: string;
|
|
297
|
+
/**
|
|
298
|
+
* National Producer Number for the agency
|
|
299
|
+
* Required for ENTITY_TYPE_AGENCY if FEIN is not provided
|
|
300
|
+
* Not allowed for ENTITY_TYPE_SOLE_PROPRIETOR
|
|
301
|
+
*
|
|
302
|
+
* @generated from field: string npn = 3;
|
|
303
|
+
*/
|
|
304
|
+
npn: string;
|
|
305
|
+
/**
|
|
306
|
+
* The phone number of the agency.
|
|
307
|
+
*
|
|
308
|
+
* @generated from field: string phone = 5;
|
|
309
|
+
*/
|
|
310
|
+
phone: string;
|
|
311
|
+
/**
|
|
312
|
+
* The website of the agency.
|
|
313
|
+
*
|
|
314
|
+
* @generated from field: string website = 6;
|
|
315
|
+
*/
|
|
316
|
+
website: string;
|
|
317
|
+
/**
|
|
318
|
+
* Information about the agency's principal.
|
|
319
|
+
* This is a required field as each agency must have a principal.
|
|
320
|
+
*
|
|
321
|
+
* @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency.Principal principal = 7;
|
|
322
|
+
*/
|
|
323
|
+
principal?: NewAgencyRequest_Agency_Principal;
|
|
324
|
+
/**
|
|
325
|
+
* @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency.BankAccount bank_account = 9;
|
|
326
|
+
*/
|
|
327
|
+
bankAccount?: NewAgencyRequest_Agency_BankAccount;
|
|
328
|
+
/**
|
|
329
|
+
* @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency.EOInfo eo_info = 10;
|
|
330
|
+
*/
|
|
331
|
+
eoInfo?: NewAgencyRequest_Agency_EOInfo;
|
|
332
|
+
/**
|
|
333
|
+
* @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours business_hours = 11;
|
|
334
|
+
*/
|
|
335
|
+
businessHours?: NewAgencyRequest_Agency_BusinessHours;
|
|
336
|
+
/**
|
|
337
|
+
* List of producers associated with the agency
|
|
338
|
+
*
|
|
339
|
+
* @generated from field: repeated producerflow.producer.v1.NewProducer producers = 12;
|
|
340
|
+
*/
|
|
341
|
+
producers: NewProducer[];
|
|
342
|
+
/**
|
|
343
|
+
* @generated from field: repeated producerflow.producer.v1.NewAgencyRequest.Agency.PointOfContact points_of_contact = 13;
|
|
344
|
+
*/
|
|
345
|
+
pointsOfContact: NewAgencyRequest_Agency_PointOfContact[];
|
|
346
|
+
/**
|
|
347
|
+
* RootOrganizationID represents the ID of the root organization that the agency belongs to.
|
|
348
|
+
* An example of a root organization is an Aggregator (Like AgencyHero) or an Agency Network.
|
|
349
|
+
* We currently don't support multiple levels of organizations or agencies.
|
|
350
|
+
* Agencies are not always part of an organization, so this field is optional.
|
|
351
|
+
* To get valid organization IDs, use the ListOrganizations RPC.
|
|
352
|
+
*
|
|
353
|
+
* @generated from field: optional string root_organization_id = 14;
|
|
354
|
+
*/
|
|
355
|
+
rootOrganizationId?: string;
|
|
356
|
+
/**
|
|
357
|
+
* EntityType represents the type of business entity for an agency.
|
|
358
|
+
*
|
|
359
|
+
* @generated from field: producerflow.producer.v1.EntityType entity_type = 15;
|
|
360
|
+
*/
|
|
361
|
+
entityType: EntityType;
|
|
362
|
+
/**
|
|
363
|
+
* FEIN represents the Federal Employer Identification Number of the agency.
|
|
364
|
+
* Required for ENTITY_TYPE_AGENCY
|
|
365
|
+
* Not allowed for ENTITY_TYPE_SOLE_PROPRIETOR
|
|
366
|
+
*
|
|
367
|
+
* @generated from field: optional string fein = 16;
|
|
368
|
+
*/
|
|
369
|
+
fein?: string;
|
|
370
|
+
/**
|
|
371
|
+
* MailingAddress represents the mailing address of the agency.
|
|
372
|
+
*
|
|
373
|
+
* @generated from field: producerflow.producer.v1.Address mailing_address = 8;
|
|
374
|
+
*/
|
|
375
|
+
mailingAddress?: Address;
|
|
376
|
+
/**
|
|
377
|
+
* PhysicalAddress represents the physical address of the agency.
|
|
378
|
+
*
|
|
379
|
+
* @generated from field: producerflow.producer.v1.Address physical_address = 17;
|
|
380
|
+
*/
|
|
381
|
+
physicalAddress?: Address;
|
|
382
|
+
/**
|
|
383
|
+
* InvoicingAddress represents the invoicing address of the agency.
|
|
384
|
+
*
|
|
385
|
+
* @generated from field: producerflow.producer.v1.Address invoicing_address = 18;
|
|
386
|
+
*/
|
|
387
|
+
invoicingAddress?: Address;
|
|
388
|
+
/**
|
|
389
|
+
* TenantAgencyID represents the ID of the agency in the tenant.
|
|
390
|
+
* This is used to link the agency to the tenant.
|
|
391
|
+
*
|
|
392
|
+
* @generated from field: string tenant_agency_id = 19;
|
|
393
|
+
*/
|
|
394
|
+
tenantAgencyId: string;
|
|
395
|
+
};
|
|
396
|
+
/**
|
|
397
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.
|
|
398
|
+
* Use `create(NewAgencyRequest_AgencySchema)` to create a new message.
|
|
399
|
+
*/
|
|
400
|
+
export declare const NewAgencyRequest_AgencySchema: GenMessage<NewAgencyRequest_Agency>;
|
|
401
|
+
/**
|
|
402
|
+
* Principal is a data structure that represents the principal of a agency.
|
|
403
|
+
* A principal is the person or entity that is responsible for the day-to-day operations of the agency.
|
|
404
|
+
* The principal is usually the CEO or CFO of the agency.nThe principal is also known as the "owner" of the agency.
|
|
405
|
+
*
|
|
406
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest.Agency.Principal
|
|
407
|
+
*/
|
|
408
|
+
export type NewAgencyRequest_Agency_Principal = Message<"producerflow.producer.v1.NewAgencyRequest.Agency.Principal"> & {
|
|
409
|
+
/**
|
|
410
|
+
* The first name of the principal.
|
|
411
|
+
*
|
|
412
|
+
* @generated from field: string first_name = 1;
|
|
413
|
+
*/
|
|
414
|
+
firstName: string;
|
|
415
|
+
/**
|
|
416
|
+
* The last name of the principal.
|
|
417
|
+
*
|
|
418
|
+
* @generated from field: string last_name = 2;
|
|
419
|
+
*/
|
|
420
|
+
lastName: string;
|
|
421
|
+
/**
|
|
422
|
+
* The middle name of the principal.
|
|
423
|
+
*
|
|
424
|
+
* @generated from field: string middle_name = 13;
|
|
425
|
+
*/
|
|
426
|
+
middleName: string;
|
|
427
|
+
/**
|
|
428
|
+
* The email address of the principal.
|
|
429
|
+
*
|
|
430
|
+
* @generated from field: string email = 3;
|
|
431
|
+
*/
|
|
432
|
+
email: string;
|
|
433
|
+
/**
|
|
434
|
+
* The phone number of the principal.
|
|
435
|
+
*
|
|
436
|
+
* @generated from field: string phone = 4;
|
|
437
|
+
*/
|
|
438
|
+
phone: string;
|
|
439
|
+
/**
|
|
440
|
+
* The National Producer Number (NPN) of the principal.
|
|
441
|
+
*
|
|
442
|
+
* @generated from field: string npn = 5;
|
|
443
|
+
*/
|
|
444
|
+
npn: string;
|
|
445
|
+
/**
|
|
446
|
+
* @generated from field: string tenant_id = 6;
|
|
447
|
+
*/
|
|
448
|
+
tenantId: string;
|
|
449
|
+
};
|
|
450
|
+
/**
|
|
451
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.Principal.
|
|
452
|
+
* Use `create(NewAgencyRequest_Agency_PrincipalSchema)` to create a new message.
|
|
453
|
+
*/
|
|
454
|
+
export declare const NewAgencyRequest_Agency_PrincipalSchema: GenMessage<NewAgencyRequest_Agency_Principal>;
|
|
455
|
+
/**
|
|
456
|
+
* BankAccount contains banking information for commission payments
|
|
457
|
+
* This is used to store the bank account information for the agency
|
|
458
|
+
*
|
|
459
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest.Agency.BankAccount
|
|
460
|
+
*/
|
|
461
|
+
export type NewAgencyRequest_Agency_BankAccount = Message<"producerflow.producer.v1.NewAgencyRequest.Agency.BankAccount"> & {
|
|
462
|
+
/**
|
|
463
|
+
* @generated from field: string account_number = 1;
|
|
464
|
+
*/
|
|
465
|
+
accountNumber: string;
|
|
466
|
+
/**
|
|
467
|
+
* Routing number for the bank account
|
|
468
|
+
*
|
|
469
|
+
* @generated from field: string routing_number = 2;
|
|
470
|
+
*/
|
|
471
|
+
routingNumber: string;
|
|
472
|
+
/**
|
|
473
|
+
* Type of account (checking or savings)
|
|
474
|
+
*
|
|
475
|
+
* @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency.BankAccount.AccountType account_type = 3;
|
|
476
|
+
*/
|
|
477
|
+
accountType: NewAgencyRequest_Agency_BankAccount_AccountType;
|
|
478
|
+
/**
|
|
479
|
+
* Name of the account holder
|
|
480
|
+
*
|
|
481
|
+
* @generated from field: string account_holder_name = 4;
|
|
482
|
+
*/
|
|
483
|
+
accountHolderName: string;
|
|
484
|
+
};
|
|
485
|
+
/**
|
|
486
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.BankAccount.
|
|
487
|
+
* Use `create(NewAgencyRequest_Agency_BankAccountSchema)` to create a new message.
|
|
488
|
+
*/
|
|
489
|
+
export declare const NewAgencyRequest_Agency_BankAccountSchema: GenMessage<NewAgencyRequest_Agency_BankAccount>;
|
|
490
|
+
/**
|
|
491
|
+
* @generated from enum producerflow.producer.v1.NewAgencyRequest.Agency.BankAccount.AccountType
|
|
492
|
+
*/
|
|
493
|
+
export declare enum NewAgencyRequest_Agency_BankAccount_AccountType {
|
|
494
|
+
/**
|
|
495
|
+
* Default unspecified value. Avoid using this.
|
|
496
|
+
*
|
|
497
|
+
* @generated from enum value: ACCOUNT_TYPE_UNSPECIFIED = 0;
|
|
498
|
+
*/
|
|
499
|
+
UNSPECIFIED = 0,
|
|
500
|
+
/**
|
|
501
|
+
* Standard checking account
|
|
502
|
+
*
|
|
503
|
+
* @generated from enum value: ACCOUNT_TYPE_CHECKING = 1;
|
|
504
|
+
*/
|
|
505
|
+
CHECKING = 1,
|
|
506
|
+
/**
|
|
507
|
+
* Savings account
|
|
508
|
+
*
|
|
509
|
+
* @generated from enum value: ACCOUNT_TYPE_SAVINGS = 2;
|
|
510
|
+
*/
|
|
511
|
+
SAVINGS = 2
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* Describes the enum producerflow.producer.v1.NewAgencyRequest.Agency.BankAccount.AccountType.
|
|
515
|
+
*/
|
|
516
|
+
export declare const NewAgencyRequest_Agency_BankAccount_AccountTypeSchema: GenEnum<NewAgencyRequest_Agency_BankAccount_AccountType>;
|
|
517
|
+
/**
|
|
518
|
+
* EOInfo contains Errors & Omissions insurance information
|
|
519
|
+
*
|
|
520
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest.Agency.EOInfo
|
|
521
|
+
*/
|
|
522
|
+
export type NewAgencyRequest_Agency_EOInfo = Message<"producerflow.producer.v1.NewAgencyRequest.Agency.EOInfo"> & {
|
|
523
|
+
/**
|
|
524
|
+
* Insurance carrier providing the E&O coverage
|
|
525
|
+
*
|
|
526
|
+
* @generated from field: string carrier = 1;
|
|
527
|
+
*/
|
|
528
|
+
carrier: string;
|
|
529
|
+
/**
|
|
530
|
+
* Date when the E&O coverage will expire
|
|
531
|
+
*
|
|
532
|
+
* @generated from field: google.protobuf.Timestamp expiration_date = 2;
|
|
533
|
+
*/
|
|
534
|
+
expirationDate?: Timestamp;
|
|
535
|
+
/**
|
|
536
|
+
* Amount of coverage provided by the E&O policy (aggregate limit)
|
|
537
|
+
*
|
|
538
|
+
* @generated from field: string coverage_amount = 3;
|
|
539
|
+
*/
|
|
540
|
+
coverageAmount: string;
|
|
541
|
+
/**
|
|
542
|
+
* Date when the E&O coverage will become effective
|
|
543
|
+
*
|
|
544
|
+
* @generated from field: google.protobuf.Timestamp effective_date = 4;
|
|
545
|
+
*/
|
|
546
|
+
effectiveDate?: Timestamp;
|
|
547
|
+
/**
|
|
548
|
+
* Per occurrence limit for the E&O policy
|
|
549
|
+
*
|
|
550
|
+
* @generated from field: string per_occurrence = 5;
|
|
551
|
+
*/
|
|
552
|
+
perOccurrence: string;
|
|
553
|
+
};
|
|
554
|
+
/**
|
|
555
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.EOInfo.
|
|
556
|
+
* Use `create(NewAgencyRequest_Agency_EOInfoSchema)` to create a new message.
|
|
557
|
+
*/
|
|
558
|
+
export declare const NewAgencyRequest_Agency_EOInfoSchema: GenMessage<NewAgencyRequest_Agency_EOInfo>;
|
|
559
|
+
/**
|
|
560
|
+
* BusinessHours contains the business hours of the agency
|
|
561
|
+
*
|
|
562
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours
|
|
563
|
+
*/
|
|
564
|
+
export type NewAgencyRequest_Agency_BusinessHours = Message<"producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours"> & {
|
|
565
|
+
/**
|
|
566
|
+
* Timezone of the agency
|
|
567
|
+
*
|
|
568
|
+
* @generated from field: string timezone = 1;
|
|
569
|
+
*/
|
|
570
|
+
timezone: string;
|
|
571
|
+
/**
|
|
572
|
+
* @generated from field: repeated producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours.BusinessHour business_hours = 2;
|
|
573
|
+
*/
|
|
574
|
+
businessHours: NewAgencyRequest_Agency_BusinessHours_BusinessHour[];
|
|
575
|
+
};
|
|
576
|
+
/**
|
|
577
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours.
|
|
578
|
+
* Use `create(NewAgencyRequest_Agency_BusinessHoursSchema)` to create a new message.
|
|
579
|
+
*/
|
|
580
|
+
export declare const NewAgencyRequest_Agency_BusinessHoursSchema: GenMessage<NewAgencyRequest_Agency_BusinessHours>;
|
|
581
|
+
/**
|
|
582
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours.BusinessHour
|
|
583
|
+
*/
|
|
584
|
+
export type NewAgencyRequest_Agency_BusinessHours_BusinessHour = Message<"producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours.BusinessHour"> & {
|
|
585
|
+
/**
|
|
586
|
+
* Days of the week when the agency is open
|
|
587
|
+
*
|
|
588
|
+
* @generated from field: repeated google.type.DayOfWeek week_days = 1;
|
|
589
|
+
*/
|
|
590
|
+
weekDays: DayOfWeek[];
|
|
591
|
+
/**
|
|
592
|
+
* Time when the agency opens
|
|
593
|
+
*
|
|
594
|
+
* @generated from field: google.type.TimeOfDay opening_time = 2;
|
|
595
|
+
*/
|
|
596
|
+
openingTime?: TimeOfDay;
|
|
597
|
+
/**
|
|
598
|
+
* Time when the agency closes
|
|
599
|
+
*
|
|
600
|
+
* @generated from field: google.type.TimeOfDay closing_time = 3;
|
|
601
|
+
*/
|
|
602
|
+
closingTime?: TimeOfDay;
|
|
603
|
+
};
|
|
604
|
+
/**
|
|
605
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.BusinessHours.BusinessHour.
|
|
606
|
+
* Use `create(NewAgencyRequest_Agency_BusinessHours_BusinessHourSchema)` to create a new message.
|
|
607
|
+
*/
|
|
608
|
+
export declare const NewAgencyRequest_Agency_BusinessHours_BusinessHourSchema: GenMessage<NewAgencyRequest_Agency_BusinessHours_BusinessHour>;
|
|
609
|
+
/**
|
|
610
|
+
* PointOfContact contains contact information for the agency. Each point of contact
|
|
611
|
+
* consists of an email address with an associated role. Carriers will send specific
|
|
612
|
+
* information to these email addresses based on their roles. For example, if an email
|
|
613
|
+
* is assigned the COMMUNICATION_ROLE_ACCOUNTING role, all accounting information from
|
|
614
|
+
* the carrier will be sent to that email address.
|
|
615
|
+
*
|
|
616
|
+
* @generated from message producerflow.producer.v1.NewAgencyRequest.Agency.PointOfContact
|
|
617
|
+
*/
|
|
618
|
+
export type NewAgencyRequest_Agency_PointOfContact = Message<"producerflow.producer.v1.NewAgencyRequest.Agency.PointOfContact"> & {
|
|
619
|
+
/**
|
|
620
|
+
* Email address of the point of contact
|
|
621
|
+
*
|
|
622
|
+
* @generated from field: string email = 1;
|
|
623
|
+
*/
|
|
624
|
+
email: string;
|
|
625
|
+
/**
|
|
626
|
+
* Role of the point of contact
|
|
627
|
+
*
|
|
628
|
+
* @generated from field: producerflow.producer.v1.NewAgencyRequest.Agency.PointOfContact.CommunicationRole role = 2;
|
|
629
|
+
*/
|
|
630
|
+
role: NewAgencyRequest_Agency_PointOfContact_CommunicationRole;
|
|
631
|
+
};
|
|
632
|
+
/**
|
|
633
|
+
* Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.PointOfContact.
|
|
634
|
+
* Use `create(NewAgencyRequest_Agency_PointOfContactSchema)` to create a new message.
|
|
635
|
+
*/
|
|
636
|
+
export declare const NewAgencyRequest_Agency_PointOfContactSchema: GenMessage<NewAgencyRequest_Agency_PointOfContact>;
|
|
637
|
+
/**
|
|
638
|
+
* @generated from enum producerflow.producer.v1.NewAgencyRequest.Agency.PointOfContact.CommunicationRole
|
|
639
|
+
*/
|
|
640
|
+
export declare enum NewAgencyRequest_Agency_PointOfContact_CommunicationRole {
|
|
641
|
+
/**
|
|
642
|
+
* Default unspecified value. Avoid using this.
|
|
643
|
+
*
|
|
644
|
+
* @generated from enum value: COMMUNICATION_ROLE_UNSPECIFIED = 0;
|
|
645
|
+
*/
|
|
646
|
+
UNSPECIFIED = 0,
|
|
647
|
+
/**
|
|
648
|
+
* Accounting role
|
|
649
|
+
*
|
|
650
|
+
* @generated from enum value: COMMUNICATION_ROLE_ACCOUNTING = 1;
|
|
651
|
+
*/
|
|
652
|
+
ACCOUNTING = 1,
|
|
653
|
+
/**
|
|
654
|
+
* Licensing role
|
|
655
|
+
*
|
|
656
|
+
* @generated from enum value: COMMUNICATION_ROLE_LICENSING = 2;
|
|
657
|
+
*/
|
|
658
|
+
LICENSING = 2,
|
|
659
|
+
/**
|
|
660
|
+
* Reporting role
|
|
661
|
+
*
|
|
662
|
+
* @generated from enum value: COMMUNICATION_ROLE_REPORTING = 3;
|
|
663
|
+
*/
|
|
664
|
+
REPORTING = 3,
|
|
665
|
+
/**
|
|
666
|
+
* Sales role
|
|
667
|
+
*
|
|
668
|
+
* @generated from enum value: COMMUNICATION_ROLE_SALES = 4;
|
|
669
|
+
*/
|
|
670
|
+
SALES = 4,
|
|
671
|
+
/**
|
|
672
|
+
* Customer service role
|
|
673
|
+
*
|
|
674
|
+
* @generated from enum value: COMMUNICATION_ROLE_CUSTOMER_SERVICE = 5;
|
|
675
|
+
*/
|
|
676
|
+
CUSTOMER_SERVICE = 5,
|
|
677
|
+
/**
|
|
678
|
+
* All roles
|
|
679
|
+
*
|
|
680
|
+
* @generated from enum value: COMMUNICATION_ROLE_ALL = 6;
|
|
681
|
+
*/
|
|
682
|
+
ALL = 6
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
* Describes the enum producerflow.producer.v1.NewAgencyRequest.Agency.PointOfContact.CommunicationRole.
|
|
686
|
+
*/
|
|
687
|
+
export declare const NewAgencyRequest_Agency_PointOfContact_CommunicationRoleSchema: GenEnum<NewAgencyRequest_Agency_PointOfContact_CommunicationRole>;
|
|
688
|
+
/**
|
|
689
|
+
* NewAgencyResponse contains the IDs of created resources after a successful agency creation
|
|
690
|
+
*
|
|
691
|
+
* @generated from message producerflow.producer.v1.NewAgencyResponse
|
|
692
|
+
*/
|
|
693
|
+
export type NewAgencyResponse = Message<"producerflow.producer.v1.NewAgencyResponse"> & {
|
|
694
|
+
/**
|
|
695
|
+
* Unique identifier for the created agency
|
|
696
|
+
*
|
|
697
|
+
* @generated from field: string agency_id = 1;
|
|
698
|
+
*/
|
|
699
|
+
agencyId: string;
|
|
700
|
+
/**
|
|
701
|
+
* List of unique identifiers for any producers created with the agency
|
|
702
|
+
*
|
|
703
|
+
* @generated from field: repeated string producer_ids = 2;
|
|
704
|
+
*/
|
|
705
|
+
producerIds: string[];
|
|
706
|
+
/**
|
|
707
|
+
* Unique identifier for the principal producer
|
|
708
|
+
*
|
|
709
|
+
* @generated from field: string principal_id = 3;
|
|
710
|
+
*/
|
|
711
|
+
principalId: string;
|
|
712
|
+
};
|
|
713
|
+
/**
|
|
714
|
+
* Describes the message producerflow.producer.v1.NewAgencyResponse.
|
|
715
|
+
* Use `create(NewAgencyResponseSchema)` to create a new message.
|
|
716
|
+
*/
|
|
717
|
+
export declare const NewAgencyResponseSchema: GenMessage<NewAgencyResponse>;
|
|
718
|
+
/**
|
|
719
|
+
* GetProducerRequest allows retrieving producer information through one of three
|
|
720
|
+
* possible lookup methods: by ID, by NPN, or by email address.
|
|
721
|
+
*
|
|
722
|
+
* @generated from message producerflow.producer.v1.GetProducerRequest
|
|
723
|
+
*/
|
|
724
|
+
export type GetProducerRequest = Message<"producerflow.producer.v1.GetProducerRequest"> & {
|
|
725
|
+
/**
|
|
726
|
+
* Only one lookup method can be specified.
|
|
727
|
+
*
|
|
728
|
+
* @generated from oneof producerflow.producer.v1.GetProducerRequest.lookup_method
|
|
729
|
+
*/
|
|
730
|
+
lookupMethod: {
|
|
731
|
+
/**
|
|
732
|
+
* Look up producer by ID.
|
|
733
|
+
*
|
|
734
|
+
* @generated from field: producerflow.producer.v1.GetProducerRequest.ProducerIDLookup producer_id_lookup = 1;
|
|
735
|
+
*/
|
|
736
|
+
value: GetProducerRequest_ProducerIDLookup;
|
|
737
|
+
case: "producerIdLookup";
|
|
738
|
+
} | {
|
|
739
|
+
/**
|
|
740
|
+
* Look up producer by NPN.
|
|
741
|
+
*
|
|
742
|
+
* @generated from field: producerflow.producer.v1.GetProducerRequest.ProducerNPNLookup npn_lookup = 2;
|
|
743
|
+
*/
|
|
744
|
+
value: GetProducerRequest_ProducerNPNLookup;
|
|
745
|
+
case: "npnLookup";
|
|
746
|
+
} | {
|
|
747
|
+
/**
|
|
748
|
+
* Look up producer by email.
|
|
749
|
+
*
|
|
750
|
+
* @generated from field: producerflow.producer.v1.GetProducerRequest.EmailLookup email_lookup = 3;
|
|
751
|
+
*/
|
|
752
|
+
value: GetProducerRequest_EmailLookup;
|
|
753
|
+
case: "emailLookup";
|
|
754
|
+
} | {
|
|
755
|
+
case: undefined;
|
|
756
|
+
value?: undefined;
|
|
757
|
+
};
|
|
758
|
+
};
|
|
759
|
+
/**
|
|
760
|
+
* Describes the message producerflow.producer.v1.GetProducerRequest.
|
|
761
|
+
* Use `create(GetProducerRequestSchema)` to create a new message.
|
|
762
|
+
*/
|
|
763
|
+
export declare const GetProducerRequestSchema: GenMessage<GetProducerRequest>;
|
|
764
|
+
/**
|
|
765
|
+
* ProducerIDLookup allows looking up a producer by their unique identifier.
|
|
766
|
+
*
|
|
767
|
+
* @generated from message producerflow.producer.v1.GetProducerRequest.ProducerIDLookup
|
|
768
|
+
*/
|
|
769
|
+
export type GetProducerRequest_ProducerIDLookup = Message<"producerflow.producer.v1.GetProducerRequest.ProducerIDLookup"> & {
|
|
770
|
+
/**
|
|
771
|
+
* The UUID of the producer to retrieve.
|
|
772
|
+
* Must be a valid UUID format.
|
|
773
|
+
*
|
|
774
|
+
* @generated from field: string producer_id = 1;
|
|
775
|
+
*/
|
|
776
|
+
producerId: string;
|
|
777
|
+
};
|
|
778
|
+
/**
|
|
779
|
+
* Describes the message producerflow.producer.v1.GetProducerRequest.ProducerIDLookup.
|
|
780
|
+
* Use `create(GetProducerRequest_ProducerIDLookupSchema)` to create a new message.
|
|
781
|
+
*/
|
|
782
|
+
export declare const GetProducerRequest_ProducerIDLookupSchema: GenMessage<GetProducerRequest_ProducerIDLookup>;
|
|
783
|
+
/**
|
|
784
|
+
* ProducerNPNLookup allows looking up a producer by their National Producer Number (NPN).
|
|
785
|
+
*
|
|
786
|
+
* @generated from message producerflow.producer.v1.GetProducerRequest.ProducerNPNLookup
|
|
787
|
+
*/
|
|
788
|
+
export type GetProducerRequest_ProducerNPNLookup = Message<"producerflow.producer.v1.GetProducerRequest.ProducerNPNLookup"> & {
|
|
789
|
+
/**
|
|
790
|
+
* The National Producer Number (NPN) of the producer to retrieve.
|
|
791
|
+
* Must be a non-empty string.
|
|
792
|
+
*
|
|
793
|
+
* @generated from field: string producer_npn = 1;
|
|
794
|
+
*/
|
|
795
|
+
producerNpn: string;
|
|
796
|
+
};
|
|
797
|
+
/**
|
|
798
|
+
* Describes the message producerflow.producer.v1.GetProducerRequest.ProducerNPNLookup.
|
|
799
|
+
* Use `create(GetProducerRequest_ProducerNPNLookupSchema)` to create a new message.
|
|
800
|
+
*/
|
|
801
|
+
export declare const GetProducerRequest_ProducerNPNLookupSchema: GenMessage<GetProducerRequest_ProducerNPNLookup>;
|
|
802
|
+
/**
|
|
803
|
+
* EmailLookup allows looking up a producer by their email address.
|
|
804
|
+
*
|
|
805
|
+
* @generated from message producerflow.producer.v1.GetProducerRequest.EmailLookup
|
|
806
|
+
*/
|
|
807
|
+
export type GetProducerRequest_EmailLookup = Message<"producerflow.producer.v1.GetProducerRequest.EmailLookup"> & {
|
|
808
|
+
/**
|
|
809
|
+
* The email address of the producer to retrieve.
|
|
810
|
+
* Must be a valid email format.
|
|
811
|
+
*
|
|
812
|
+
* @generated from field: string email = 1;
|
|
813
|
+
*/
|
|
814
|
+
email: string;
|
|
815
|
+
};
|
|
816
|
+
/**
|
|
817
|
+
* Describes the message producerflow.producer.v1.GetProducerRequest.EmailLookup.
|
|
818
|
+
* Use `create(GetProducerRequest_EmailLookupSchema)` to create a new message.
|
|
819
|
+
*/
|
|
820
|
+
export declare const GetProducerRequest_EmailLookupSchema: GenMessage<GetProducerRequest_EmailLookup>;
|
|
821
|
+
/**
|
|
822
|
+
* GetProducerResponse contains the producer information retrieved by the GetProducer RPC.
|
|
823
|
+
*
|
|
824
|
+
* @generated from message producerflow.producer.v1.GetProducerResponse
|
|
825
|
+
*/
|
|
826
|
+
export type GetProducerResponse = Message<"producerflow.producer.v1.GetProducerResponse"> & {
|
|
827
|
+
/**
|
|
828
|
+
* The complete producer information including personal details, agency association,
|
|
829
|
+
* and NIPR data.
|
|
830
|
+
*
|
|
831
|
+
* @generated from field: producerflow.producer.v1.Producer producer = 1;
|
|
832
|
+
*/
|
|
833
|
+
producer?: Producer;
|
|
834
|
+
};
|
|
835
|
+
/**
|
|
836
|
+
* Describes the message producerflow.producer.v1.GetProducerResponse.
|
|
837
|
+
* Use `create(GetProducerResponseSchema)` to create a new message.
|
|
838
|
+
*/
|
|
839
|
+
export declare const GetProducerResponseSchema: GenMessage<GetProducerResponse>;
|
|
840
|
+
/**
|
|
841
|
+
* GetAgencyAndProducersRequest requests information about an agency and all associated producers.
|
|
842
|
+
*
|
|
843
|
+
* @generated from message producerflow.producer.v1.GetAgencyAndProducersRequest
|
|
844
|
+
*/
|
|
845
|
+
export type GetAgencyAndProducersRequest = Message<"producerflow.producer.v1.GetAgencyAndProducersRequest"> & {
|
|
846
|
+
/**
|
|
847
|
+
* The UUID of the agency to retrieve information for.
|
|
848
|
+
* Must be a valid UUID format.
|
|
849
|
+
*
|
|
850
|
+
* @generated from field: string agency_id = 1;
|
|
851
|
+
*/
|
|
852
|
+
agencyId: string;
|
|
853
|
+
};
|
|
854
|
+
/**
|
|
855
|
+
* Describes the message producerflow.producer.v1.GetAgencyAndProducersRequest.
|
|
856
|
+
* Use `create(GetAgencyAndProducersRequestSchema)` to create a new message.
|
|
857
|
+
*/
|
|
858
|
+
export declare const GetAgencyAndProducersRequestSchema: GenMessage<GetAgencyAndProducersRequest>;
|
|
859
|
+
/**
|
|
860
|
+
* GetAgencyAndProducersResponse contains the agency information and all associated producers.
|
|
861
|
+
*
|
|
862
|
+
* @generated from message producerflow.producer.v1.GetAgencyAndProducersResponse
|
|
863
|
+
*/
|
|
864
|
+
export type GetAgencyAndProducersResponse = Message<"producerflow.producer.v1.GetAgencyAndProducersResponse"> & {
|
|
865
|
+
/**
|
|
866
|
+
* Complete agency information including contact details, principal, and bank account.
|
|
867
|
+
*
|
|
868
|
+
* @generated from field: producerflow.producer.v1.Agency agency = 1;
|
|
869
|
+
*/
|
|
870
|
+
agency?: Agency;
|
|
871
|
+
/**
|
|
872
|
+
* List of all producers associated with the specified agency.
|
|
873
|
+
*
|
|
874
|
+
* @generated from field: repeated producerflow.producer.v1.Producer producers = 2;
|
|
875
|
+
*/
|
|
876
|
+
producers: Producer[];
|
|
877
|
+
};
|
|
878
|
+
/**
|
|
879
|
+
* Describes the message producerflow.producer.v1.GetAgencyAndProducersResponse.
|
|
880
|
+
* Use `create(GetAgencyAndProducersResponseSchema)` to create a new message.
|
|
881
|
+
*/
|
|
882
|
+
export declare const GetAgencyAndProducersResponseSchema: GenMessage<GetAgencyAndProducersResponse>;
|
|
883
|
+
/**
|
|
884
|
+
* GetAgencyFilesRequest requests URLs for files associated with an agency.
|
|
885
|
+
*
|
|
886
|
+
* @generated from message producerflow.producer.v1.GetAgencyFilesRequest
|
|
887
|
+
*/
|
|
888
|
+
export type GetAgencyFilesRequest = Message<"producerflow.producer.v1.GetAgencyFilesRequest"> & {
|
|
889
|
+
/**
|
|
890
|
+
* The UUID of the agency to retrieve files for.
|
|
891
|
+
* Must be a valid UUID format.
|
|
892
|
+
*
|
|
893
|
+
* @generated from field: string agency_id = 1;
|
|
894
|
+
*/
|
|
895
|
+
agencyId: string;
|
|
896
|
+
};
|
|
897
|
+
/**
|
|
898
|
+
* Describes the message producerflow.producer.v1.GetAgencyFilesRequest.
|
|
899
|
+
* Use `create(GetAgencyFilesRequestSchema)` to create a new message.
|
|
900
|
+
*/
|
|
901
|
+
export declare const GetAgencyFilesRequestSchema: GenMessage<GetAgencyFilesRequest>;
|
|
902
|
+
/**
|
|
903
|
+
* GetAgencyFilesResponse contains URLs for various documents associated with an agency.
|
|
904
|
+
*
|
|
905
|
+
* @generated from message producerflow.producer.v1.GetAgencyFilesResponse
|
|
906
|
+
*/
|
|
907
|
+
export type GetAgencyFilesResponse = Message<"producerflow.producer.v1.GetAgencyFilesResponse"> & {
|
|
908
|
+
/**
|
|
909
|
+
* URL of the Errors & Omissions (E&O) insurance document.
|
|
910
|
+
*
|
|
911
|
+
* @generated from field: string eo_doc_url = 1;
|
|
912
|
+
*/
|
|
913
|
+
eoDocUrl: string;
|
|
914
|
+
/**
|
|
915
|
+
* URL of the bank voided check document.
|
|
916
|
+
* It's used to safely share bank account information for
|
|
917
|
+
* electronic transfers.
|
|
918
|
+
*
|
|
919
|
+
* @generated from field: string voided_check_doc_url = 2;
|
|
920
|
+
*/
|
|
921
|
+
voidedCheckDocUrl: string;
|
|
922
|
+
/**
|
|
923
|
+
* URL of the W9 form document.
|
|
924
|
+
* It's a U.S. internal revenue service form, an identification
|
|
925
|
+
* document used in the onboarding process for tax reporting purposes.
|
|
926
|
+
*
|
|
927
|
+
* @generated from field: string w9_doc_url = 3;
|
|
928
|
+
*/
|
|
929
|
+
w9DocUrl: string;
|
|
930
|
+
/**
|
|
931
|
+
* URL of the license document.
|
|
932
|
+
* An identification document that shows that the agency
|
|
933
|
+
* is licensed to carry out its operations in the relevant jurisdictions.
|
|
934
|
+
*
|
|
935
|
+
* @generated from field: string license_doc_url = 4;
|
|
936
|
+
*/
|
|
937
|
+
licenseDocUrl: string;
|
|
938
|
+
/**
|
|
939
|
+
* URL of the broker bond document.
|
|
940
|
+
* It's a surety bond that a broker needs to operate legally,
|
|
941
|
+
* providing financial security for clients.
|
|
942
|
+
*
|
|
943
|
+
* @generated from field: string broker_bond_doc_url = 5;
|
|
944
|
+
*/
|
|
945
|
+
brokerBondDocUrl: string;
|
|
946
|
+
};
|
|
947
|
+
/**
|
|
948
|
+
* Describes the message producerflow.producer.v1.GetAgencyFilesResponse.
|
|
949
|
+
* Use `create(GetAgencyFilesResponseSchema)` to create a new message.
|
|
950
|
+
*/
|
|
951
|
+
export declare const GetAgencyFilesResponseSchema: GenMessage<GetAgencyFilesResponse>;
|
|
952
|
+
/**
|
|
953
|
+
* UpdateProducerRequest contains the fields that can be updated in a producer record.
|
|
954
|
+
* Only information collected during the onboarding process can be updated.
|
|
955
|
+
* Information from NIPR and other third-party sources cannot be updated directly.
|
|
956
|
+
*
|
|
957
|
+
* @generated from message producerflow.producer.v1.UpdateProducerRequest
|
|
958
|
+
*/
|
|
959
|
+
export type UpdateProducerRequest = Message<"producerflow.producer.v1.UpdateProducerRequest"> & {
|
|
960
|
+
/**
|
|
961
|
+
* The ID of the producer to update.
|
|
962
|
+
* Must be a valid UUID format.
|
|
963
|
+
*
|
|
964
|
+
* @generated from field: string producer_id = 1;
|
|
965
|
+
*/
|
|
966
|
+
producerId: string;
|
|
967
|
+
/**
|
|
968
|
+
* The producer information to update.
|
|
969
|
+
* The field is required.
|
|
970
|
+
*
|
|
971
|
+
* @generated from field: producerflow.producer.v1.UpdateProducerRequest.Producer producer = 2;
|
|
972
|
+
*/
|
|
973
|
+
producer?: UpdateProducerRequest_Producer;
|
|
974
|
+
};
|
|
975
|
+
/**
|
|
976
|
+
* Describes the message producerflow.producer.v1.UpdateProducerRequest.
|
|
977
|
+
* Use `create(UpdateProducerRequestSchema)` to create a new message.
|
|
978
|
+
*/
|
|
979
|
+
export declare const UpdateProducerRequestSchema: GenMessage<UpdateProducerRequest>;
|
|
980
|
+
/**
|
|
981
|
+
* Producer contains the fields that can be updated for a producer.
|
|
982
|
+
* All fields are optional, allowing partial updates.
|
|
983
|
+
*
|
|
984
|
+
* @generated from message producerflow.producer.v1.UpdateProducerRequest.Producer
|
|
985
|
+
*/
|
|
986
|
+
export type UpdateProducerRequest_Producer = Message<"producerflow.producer.v1.UpdateProducerRequest.Producer"> & {
|
|
987
|
+
/**
|
|
988
|
+
* First name of the producer.
|
|
989
|
+
* If provided, must be non-empty.
|
|
990
|
+
*
|
|
991
|
+
* @generated from field: optional string first_name = 1;
|
|
992
|
+
*/
|
|
993
|
+
firstName?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Last name of the producer.
|
|
996
|
+
* If provided, must be non-empty.
|
|
997
|
+
*
|
|
998
|
+
* @generated from field: optional string last_name = 2;
|
|
999
|
+
*/
|
|
1000
|
+
lastName?: string;
|
|
1001
|
+
/**
|
|
1002
|
+
* Middle name of the producer.
|
|
1003
|
+
* If provided, must be non-empty.
|
|
1004
|
+
*
|
|
1005
|
+
* @generated from field: optional string middle_name = 10;
|
|
1006
|
+
*/
|
|
1007
|
+
middleName?: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* Email address of the producer.
|
|
1010
|
+
* If provided, must be a valid email format.
|
|
1011
|
+
* Must be unique within the tenant.
|
|
1012
|
+
*
|
|
1013
|
+
* @generated from field: optional string email = 3;
|
|
1014
|
+
*/
|
|
1015
|
+
email?: string;
|
|
1016
|
+
/**
|
|
1017
|
+
* National Producer Number (NPN) of the producer.
|
|
1018
|
+
* If provided, must be non-empty.
|
|
1019
|
+
*
|
|
1020
|
+
* @generated from field: optional string npn = 4;
|
|
1021
|
+
*/
|
|
1022
|
+
npn?: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* Phone number of the producer.
|
|
1025
|
+
* If provided, must be a valid phone number format.
|
|
1026
|
+
*
|
|
1027
|
+
* @generated from field: optional string phone = 5;
|
|
1028
|
+
*/
|
|
1029
|
+
phone?: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* Street address of the producer.
|
|
1032
|
+
* If provided, must be non-empty.
|
|
1033
|
+
*
|
|
1034
|
+
* @generated from field: optional string street = 6;
|
|
1035
|
+
*/
|
|
1036
|
+
street?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* City of the producer.
|
|
1039
|
+
* If provided, must be non-empty.
|
|
1040
|
+
*
|
|
1041
|
+
* @generated from field: optional string city = 7;
|
|
1042
|
+
*/
|
|
1043
|
+
city?: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* State of the producer.
|
|
1046
|
+
* If provided, must be non-empty.
|
|
1047
|
+
*
|
|
1048
|
+
* @generated from field: optional string state = 8;
|
|
1049
|
+
*/
|
|
1050
|
+
state?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* ZIP code of the producer's address.
|
|
1053
|
+
* If provided, must be at least 5 characters.
|
|
1054
|
+
*
|
|
1055
|
+
* @generated from field: optional string zip = 9;
|
|
1056
|
+
*/
|
|
1057
|
+
zip?: string;
|
|
1058
|
+
};
|
|
1059
|
+
/**
|
|
1060
|
+
* Describes the message producerflow.producer.v1.UpdateProducerRequest.Producer.
|
|
1061
|
+
* Use `create(UpdateProducerRequest_ProducerSchema)` to create a new message.
|
|
1062
|
+
*/
|
|
1063
|
+
export declare const UpdateProducerRequest_ProducerSchema: GenMessage<UpdateProducerRequest_Producer>;
|
|
1064
|
+
/**
|
|
1065
|
+
* UpdateProducerResponse is the empty response returned after successfully updating a producer.
|
|
1066
|
+
*
|
|
1067
|
+
* @generated from message producerflow.producer.v1.UpdateProducerResponse
|
|
1068
|
+
*/
|
|
1069
|
+
export type UpdateProducerResponse = Message<"producerflow.producer.v1.UpdateProducerResponse"> & {};
|
|
1070
|
+
/**
|
|
1071
|
+
* Describes the message producerflow.producer.v1.UpdateProducerResponse.
|
|
1072
|
+
* Use `create(UpdateProducerResponseSchema)` to create a new message.
|
|
1073
|
+
*/
|
|
1074
|
+
export declare const UpdateProducerResponseSchema: GenMessage<UpdateProducerResponse>;
|
|
1075
|
+
/**
|
|
1076
|
+
* ListNewProducersRequest requests a list of new producers, optionally filtered by agency.
|
|
1077
|
+
*
|
|
1078
|
+
* @generated from message producerflow.producer.v1.ListNewProducersRequest
|
|
1079
|
+
*/
|
|
1080
|
+
export type ListNewProducersRequest = Message<"producerflow.producer.v1.ListNewProducersRequest"> & {
|
|
1081
|
+
/**
|
|
1082
|
+
* Optional agency ID to filter producers by.
|
|
1083
|
+
* If provided, only producers belonging to this agency will be returned.
|
|
1084
|
+
* If not provided, producers from all agencies will be returned.
|
|
1085
|
+
*
|
|
1086
|
+
* @generated from field: optional string agency_id = 1;
|
|
1087
|
+
*/
|
|
1088
|
+
agencyId?: string;
|
|
1089
|
+
};
|
|
1090
|
+
/**
|
|
1091
|
+
* Describes the message producerflow.producer.v1.ListNewProducersRequest.
|
|
1092
|
+
* Use `create(ListNewProducersRequestSchema)` to create a new message.
|
|
1093
|
+
*/
|
|
1094
|
+
export declare const ListNewProducersRequestSchema: GenMessage<ListNewProducersRequest>;
|
|
1095
|
+
/**
|
|
1096
|
+
* ListNewProducersResponse contains a list of new producers that match the filter criteria.
|
|
1097
|
+
*
|
|
1098
|
+
* @generated from message producerflow.producer.v1.ListNewProducersResponse
|
|
1099
|
+
*/
|
|
1100
|
+
export type ListNewProducersResponse = Message<"producerflow.producer.v1.ListNewProducersResponse"> & {
|
|
1101
|
+
/**
|
|
1102
|
+
* List of new producers matching the filter criteria.
|
|
1103
|
+
* These are producers typically in the NEW or pending onboarding state.
|
|
1104
|
+
*
|
|
1105
|
+
* @generated from field: repeated producerflow.producer.v1.Producer new_producers = 1;
|
|
1106
|
+
*/
|
|
1107
|
+
newProducers: Producer[];
|
|
1108
|
+
};
|
|
1109
|
+
/**
|
|
1110
|
+
* Describes the message producerflow.producer.v1.ListNewProducersResponse.
|
|
1111
|
+
* Use `create(ListNewProducersResponseSchema)` to create a new message.
|
|
1112
|
+
*/
|
|
1113
|
+
export declare const ListNewProducersResponseSchema: GenMessage<ListNewProducersResponse>;
|
|
1114
|
+
/**
|
|
1115
|
+
* ApproveProducerRequest requests approval for a producer in the onboarding process.
|
|
1116
|
+
*
|
|
1117
|
+
* @generated from message producerflow.producer.v1.ApproveProducerRequest
|
|
1118
|
+
* @deprecated
|
|
1119
|
+
*/
|
|
1120
|
+
export type ApproveProducerRequest = Message<"producerflow.producer.v1.ApproveProducerRequest"> & {
|
|
1121
|
+
/**
|
|
1122
|
+
* The UUID of the producer to approve.
|
|
1123
|
+
* Must be a valid UUID format.
|
|
1124
|
+
*
|
|
1125
|
+
* @generated from field: string producer_id = 1;
|
|
1126
|
+
*/
|
|
1127
|
+
producerId: string;
|
|
1128
|
+
};
|
|
1129
|
+
/**
|
|
1130
|
+
* Describes the message producerflow.producer.v1.ApproveProducerRequest.
|
|
1131
|
+
* Use `create(ApproveProducerRequestSchema)` to create a new message.
|
|
1132
|
+
* @deprecated
|
|
1133
|
+
*/
|
|
1134
|
+
export declare const ApproveProducerRequestSchema: GenMessage<ApproveProducerRequest>;
|
|
1135
|
+
/**
|
|
1136
|
+
* ApproveProducerResponse is the empty response returned after successfully approving a producer.
|
|
1137
|
+
*
|
|
1138
|
+
* @generated from message producerflow.producer.v1.ApproveProducerResponse
|
|
1139
|
+
*/
|
|
1140
|
+
export type ApproveProducerResponse = Message<"producerflow.producer.v1.ApproveProducerResponse"> & {};
|
|
1141
|
+
/**
|
|
1142
|
+
* Describes the message producerflow.producer.v1.ApproveProducerResponse.
|
|
1143
|
+
* Use `create(ApproveProducerResponseSchema)` to create a new message.
|
|
1144
|
+
*/
|
|
1145
|
+
export declare const ApproveProducerResponseSchema: GenMessage<ApproveProducerResponse>;
|
|
1146
|
+
/**
|
|
1147
|
+
* RejectProducerRequest requests rejection of a producer in the onboarding process.
|
|
1148
|
+
*
|
|
1149
|
+
* @generated from message producerflow.producer.v1.RejectProducerRequest
|
|
1150
|
+
*/
|
|
1151
|
+
export type RejectProducerRequest = Message<"producerflow.producer.v1.RejectProducerRequest"> & {
|
|
1152
|
+
/**
|
|
1153
|
+
* The UUID of the producer to reject.
|
|
1154
|
+
* Must be a valid UUID format.
|
|
1155
|
+
*
|
|
1156
|
+
* @generated from field: string producer_id = 1;
|
|
1157
|
+
*/
|
|
1158
|
+
producerId: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* The reason for rejecting the producer.
|
|
1161
|
+
* Must be non-empty to provide context for the rejection.
|
|
1162
|
+
*
|
|
1163
|
+
* @generated from field: string reason = 2;
|
|
1164
|
+
*/
|
|
1165
|
+
reason: string;
|
|
1166
|
+
};
|
|
1167
|
+
/**
|
|
1168
|
+
* Describes the message producerflow.producer.v1.RejectProducerRequest.
|
|
1169
|
+
* Use `create(RejectProducerRequestSchema)` to create a new message.
|
|
1170
|
+
*/
|
|
1171
|
+
export declare const RejectProducerRequestSchema: GenMessage<RejectProducerRequest>;
|
|
1172
|
+
/**
|
|
1173
|
+
* RejectProducerResponse is the empty response returned after successfully rejecting a producer.
|
|
1174
|
+
*
|
|
1175
|
+
* @generated from message producerflow.producer.v1.RejectProducerResponse
|
|
1176
|
+
*/
|
|
1177
|
+
export type RejectProducerResponse = Message<"producerflow.producer.v1.RejectProducerResponse"> & {};
|
|
1178
|
+
/**
|
|
1179
|
+
* Describes the message producerflow.producer.v1.RejectProducerResponse.
|
|
1180
|
+
* Use `create(RejectProducerResponseSchema)` to create a new message.
|
|
1181
|
+
*/
|
|
1182
|
+
export declare const RejectProducerResponseSchema: GenMessage<RejectProducerResponse>;
|
|
1183
|
+
/**
|
|
1184
|
+
* Agency represents a complete agency entity with all associated information.
|
|
1185
|
+
*
|
|
1186
|
+
* @generated from message producerflow.producer.v1.Agency
|
|
1187
|
+
*/
|
|
1188
|
+
export type Agency = Message<"producerflow.producer.v1.Agency"> & {
|
|
1189
|
+
/**
|
|
1190
|
+
* Unique identifier for the agency.
|
|
1191
|
+
*
|
|
1192
|
+
* @generated from field: string agency_id = 1;
|
|
1193
|
+
*/
|
|
1194
|
+
agencyId: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* AgencyInfo type field named agency_info
|
|
1197
|
+
*
|
|
1198
|
+
* @generated from field: producerflow.producer.v1.Agency.AgencyInfo agency_info = 2;
|
|
1199
|
+
*/
|
|
1200
|
+
agencyInfo?: Agency_AgencyInfo;
|
|
1201
|
+
/**
|
|
1202
|
+
* Address type field named address.
|
|
1203
|
+
*
|
|
1204
|
+
* @generated from field: producerflow.producer.v1.Agency.Address address = 3;
|
|
1205
|
+
*/
|
|
1206
|
+
address?: Agency_Address;
|
|
1207
|
+
/**
|
|
1208
|
+
* Address type field named mailing_address.
|
|
1209
|
+
*
|
|
1210
|
+
* @generated from field: producerflow.producer.v1.Agency.Address mailing_address = 4;
|
|
1211
|
+
*/
|
|
1212
|
+
mailingAddress?: Agency_Address;
|
|
1213
|
+
/**
|
|
1214
|
+
* Banking information for commission payments.
|
|
1215
|
+
* Used for electronic transfers of commissions and other payments.
|
|
1216
|
+
*
|
|
1217
|
+
* @generated from field: producerflow.producer.v1.Agency.BankAccount bank_account = 5;
|
|
1218
|
+
*/
|
|
1219
|
+
bankAccount?: Agency_BankAccount;
|
|
1220
|
+
/**
|
|
1221
|
+
* @generated from field: producerflow.producer.v1.Agency.EOInfo eo_info = 6;
|
|
1222
|
+
*/
|
|
1223
|
+
eoInfo?: Agency_EOInfo;
|
|
1224
|
+
/**
|
|
1225
|
+
* Information about the agency's principal.
|
|
1226
|
+
* This is a required field as each agency must have a principal.
|
|
1227
|
+
*
|
|
1228
|
+
* @generated from field: producerflow.producer.v1.Agency.Principal principal = 7;
|
|
1229
|
+
*/
|
|
1230
|
+
principal?: Agency_Principal;
|
|
1231
|
+
/**
|
|
1232
|
+
* IVANS account information for electronic carrier communication.
|
|
1233
|
+
* This is optional and only used if the agency uses IVANS.
|
|
1234
|
+
*
|
|
1235
|
+
* @generated from field: producerflow.producer.v1.Agency.IvansAccount ivans_account = 8;
|
|
1236
|
+
*/
|
|
1237
|
+
ivansAccount?: Agency_IvansAccount;
|
|
1238
|
+
/**
|
|
1239
|
+
* The list of requested appointments for the agency.
|
|
1240
|
+
*
|
|
1241
|
+
* @generated from field: repeated string requested_appointments = 9;
|
|
1242
|
+
*/
|
|
1243
|
+
requestedAppointments: string[];
|
|
1244
|
+
};
|
|
1245
|
+
/**
|
|
1246
|
+
* Describes the message producerflow.producer.v1.Agency.
|
|
1247
|
+
* Use `create(AgencySchema)` to create a new message.
|
|
1248
|
+
*/
|
|
1249
|
+
export declare const AgencySchema: GenMessage<Agency>;
|
|
1250
|
+
/**
|
|
1251
|
+
* AgencyInfo contains contact and identification information for an agency.
|
|
1252
|
+
*
|
|
1253
|
+
* @generated from message producerflow.producer.v1.Agency.AgencyInfo
|
|
1254
|
+
*/
|
|
1255
|
+
export type Agency_AgencyInfo = Message<"producerflow.producer.v1.Agency.AgencyInfo"> & {
|
|
1256
|
+
/**
|
|
1257
|
+
* The unique identifier for the onboarding process.
|
|
1258
|
+
* Used to track the agency through the onboarding flow.
|
|
1259
|
+
*
|
|
1260
|
+
* @generated from field: string onboarding_id = 1;
|
|
1261
|
+
*/
|
|
1262
|
+
onboardingId: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* The organization ID represents the ID of the root organization that the agency belongs to.
|
|
1265
|
+
* An example of a root organization is an Aggregator (Like AgencyHero) or an Agency Network.
|
|
1266
|
+
* We currently don't support multiple levels of organizations or agencies.
|
|
1267
|
+
* Agencies are not always part of an organization, so this field is optional.
|
|
1268
|
+
*
|
|
1269
|
+
* @generated from field: string root_organization_id = 2;
|
|
1270
|
+
*/
|
|
1271
|
+
rootOrganizationId: string;
|
|
1272
|
+
/**
|
|
1273
|
+
* The official name of the agency.
|
|
1274
|
+
* This is typically the legal name of the entity.
|
|
1275
|
+
*
|
|
1276
|
+
* @generated from field: string agency_name = 3;
|
|
1277
|
+
*/
|
|
1278
|
+
agencyName: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* Federal Employer Identification Number (FEIN) of the agency.
|
|
1281
|
+
* This is a unique nine-digit number assigned by the Internal
|
|
1282
|
+
* Revenue Service (IRS) to businesses operating in the United States.
|
|
1283
|
+
*
|
|
1284
|
+
* @generated from field: string agency_fein = 4;
|
|
1285
|
+
*/
|
|
1286
|
+
agencyFein: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* Primary email address for the agency.
|
|
1289
|
+
* Used for communication and must be unique.
|
|
1290
|
+
*
|
|
1291
|
+
* @generated from field: string email = 5;
|
|
1292
|
+
*/
|
|
1293
|
+
email: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* Phone number for the agency.
|
|
1296
|
+
*
|
|
1297
|
+
* @generated from field: string phone = 6;
|
|
1298
|
+
*/
|
|
1299
|
+
phone: string;
|
|
1300
|
+
/**
|
|
1301
|
+
* Fax number for the agency.
|
|
1302
|
+
*
|
|
1303
|
+
* @generated from field: string fax = 7;
|
|
1304
|
+
*/
|
|
1305
|
+
fax: string;
|
|
1306
|
+
/**
|
|
1307
|
+
* Website URL for the agency, if available.
|
|
1308
|
+
*
|
|
1309
|
+
* @generated from field: string website = 8;
|
|
1310
|
+
*/
|
|
1311
|
+
website: string;
|
|
1312
|
+
/**
|
|
1313
|
+
* National Producer Number (NPN) of the agency.
|
|
1314
|
+
* This is a unique identifier assigned by the National Association of Insurance Commissioners (NAIC).
|
|
1315
|
+
*
|
|
1316
|
+
* @generated from field: string npn = 9;
|
|
1317
|
+
*/
|
|
1318
|
+
npn: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* Indicates whether the agency is enabled to be synchronized with NIPR API.
|
|
1321
|
+
* When true, the system will regularly check for updates from NIPR.
|
|
1322
|
+
*
|
|
1323
|
+
* @generated from field: bool pdb_alerts_sync_enabled = 10;
|
|
1324
|
+
*/
|
|
1325
|
+
pdbAlertsSyncEnabled: boolean;
|
|
1326
|
+
};
|
|
1327
|
+
/**
|
|
1328
|
+
* Describes the message producerflow.producer.v1.Agency.AgencyInfo.
|
|
1329
|
+
* Use `create(Agency_AgencyInfoSchema)` to create a new message.
|
|
1330
|
+
*/
|
|
1331
|
+
export declare const Agency_AgencyInfoSchema: GenMessage<Agency_AgencyInfo>;
|
|
1332
|
+
/**
|
|
1333
|
+
* Address is a data structure that represents a physical or mailing
|
|
1334
|
+
* location.
|
|
1335
|
+
*
|
|
1336
|
+
* @generated from message producerflow.producer.v1.Agency.Address
|
|
1337
|
+
*/
|
|
1338
|
+
export type Agency_Address = Message<"producerflow.producer.v1.Agency.Address"> & {
|
|
1339
|
+
/**
|
|
1340
|
+
* Street name and number of the location.
|
|
1341
|
+
*
|
|
1342
|
+
* @generated from field: string street = 1;
|
|
1343
|
+
*/
|
|
1344
|
+
street: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* City where the location resides.
|
|
1347
|
+
*
|
|
1348
|
+
* @generated from field: string city = 2;
|
|
1349
|
+
*/
|
|
1350
|
+
city: string;
|
|
1351
|
+
/**
|
|
1352
|
+
* State/Province where the location resides.
|
|
1353
|
+
*
|
|
1354
|
+
* @generated from field: string state = 3;
|
|
1355
|
+
*/
|
|
1356
|
+
state: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* ZIP/Postal code of the location.
|
|
1359
|
+
*
|
|
1360
|
+
* @generated from field: string zip = 4;
|
|
1361
|
+
*/
|
|
1362
|
+
zip: string;
|
|
1363
|
+
};
|
|
1364
|
+
/**
|
|
1365
|
+
* Describes the message producerflow.producer.v1.Agency.Address.
|
|
1366
|
+
* Use `create(Agency_AddressSchema)` to create a new message.
|
|
1367
|
+
*/
|
|
1368
|
+
export declare const Agency_AddressSchema: GenMessage<Agency_Address>;
|
|
1369
|
+
/**
|
|
1370
|
+
* BankAccount contains information about a bank account for commission payments.
|
|
1371
|
+
*
|
|
1372
|
+
* @generated from message producerflow.producer.v1.Agency.BankAccount
|
|
1373
|
+
*/
|
|
1374
|
+
export type Agency_BankAccount = Message<"producerflow.producer.v1.Agency.BankAccount"> & {
|
|
1375
|
+
/**
|
|
1376
|
+
* Account number for the bank account.
|
|
1377
|
+
*
|
|
1378
|
+
* @generated from field: string account_number = 1;
|
|
1379
|
+
*/
|
|
1380
|
+
accountNumber: string;
|
|
1381
|
+
/**
|
|
1382
|
+
* Routing number for the bank.
|
|
1383
|
+
* This is a nine-digit code identifying the financial institution.
|
|
1384
|
+
*
|
|
1385
|
+
* @generated from field: string routing_number = 2;
|
|
1386
|
+
*/
|
|
1387
|
+
routingNumber: string;
|
|
1388
|
+
/**
|
|
1389
|
+
* Type of account (checking or savings).
|
|
1390
|
+
* Indicates how the account should be treated for electronic transfers.
|
|
1391
|
+
*
|
|
1392
|
+
* @generated from field: producerflow.producer.v1.Agency.BankAccount.AccountType account_type = 3;
|
|
1393
|
+
*/
|
|
1394
|
+
accountType: Agency_BankAccount_AccountType;
|
|
1395
|
+
/**
|
|
1396
|
+
* Name of the account holder as it appears on bank records.
|
|
1397
|
+
*
|
|
1398
|
+
* @generated from field: string account_holder_name = 4;
|
|
1399
|
+
*/
|
|
1400
|
+
accountHolderName: string;
|
|
1401
|
+
};
|
|
1402
|
+
/**
|
|
1403
|
+
* Describes the message producerflow.producer.v1.Agency.BankAccount.
|
|
1404
|
+
* Use `create(Agency_BankAccountSchema)` to create a new message.
|
|
1405
|
+
*/
|
|
1406
|
+
export declare const Agency_BankAccountSchema: GenMessage<Agency_BankAccount>;
|
|
1407
|
+
/**
|
|
1408
|
+
* The type of account.
|
|
1409
|
+
*
|
|
1410
|
+
* @generated from enum producerflow.producer.v1.Agency.BankAccount.AccountType
|
|
1411
|
+
*/
|
|
1412
|
+
export declare enum Agency_BankAccount_AccountType {
|
|
1413
|
+
/**
|
|
1414
|
+
* Default unspecified value. Avoid using this.
|
|
1415
|
+
*
|
|
1416
|
+
* @generated from enum value: ACCOUNT_TYPE_UNSPECIFIED = 0;
|
|
1417
|
+
*/
|
|
1418
|
+
UNSPECIFIED = 0,
|
|
1419
|
+
/**
|
|
1420
|
+
* Standard checking account.
|
|
1421
|
+
*
|
|
1422
|
+
* @generated from enum value: ACCOUNT_TYPE_CHECKING = 1;
|
|
1423
|
+
*/
|
|
1424
|
+
CHECKING = 1,
|
|
1425
|
+
/**
|
|
1426
|
+
* Savings account.
|
|
1427
|
+
*
|
|
1428
|
+
* @generated from enum value: ACCOUNT_TYPE_SAVINGS = 2;
|
|
1429
|
+
*/
|
|
1430
|
+
SAVINGS = 2
|
|
1431
|
+
}
|
|
1432
|
+
/**
|
|
1433
|
+
* Describes the enum producerflow.producer.v1.Agency.BankAccount.AccountType.
|
|
1434
|
+
*/
|
|
1435
|
+
export declare const Agency_BankAccount_AccountTypeSchema: GenEnum<Agency_BankAccount_AccountType>;
|
|
1436
|
+
/**
|
|
1437
|
+
* EOInfo contains Errors & Omissions insurance information
|
|
1438
|
+
*
|
|
1439
|
+
* @generated from message producerflow.producer.v1.Agency.EOInfo
|
|
1440
|
+
*/
|
|
1441
|
+
export type Agency_EOInfo = Message<"producerflow.producer.v1.Agency.EOInfo"> & {
|
|
1442
|
+
/**
|
|
1443
|
+
* Insurance carrier providing the E&O coverage
|
|
1444
|
+
*
|
|
1445
|
+
* @generated from field: string carrier = 1;
|
|
1446
|
+
*/
|
|
1447
|
+
carrier: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* Date when the E&O coverage will expire
|
|
1450
|
+
*
|
|
1451
|
+
* @generated from field: google.protobuf.Timestamp expiration_date = 2;
|
|
1452
|
+
*/
|
|
1453
|
+
expirationDate?: Timestamp;
|
|
1454
|
+
/**
|
|
1455
|
+
* Amount of coverage provided by the E&O policy (aggregate limit)
|
|
1456
|
+
*
|
|
1457
|
+
* @generated from field: string coverage_amount = 3;
|
|
1458
|
+
*/
|
|
1459
|
+
coverageAmount: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* Per occurrence limit for the E&O policy
|
|
1462
|
+
*
|
|
1463
|
+
* @generated from field: string per_occurrence = 4;
|
|
1464
|
+
*/
|
|
1465
|
+
perOccurrence: string;
|
|
1466
|
+
};
|
|
1467
|
+
/**
|
|
1468
|
+
* Describes the message producerflow.producer.v1.Agency.EOInfo.
|
|
1469
|
+
* Use `create(Agency_EOInfoSchema)` to create a new message.
|
|
1470
|
+
*/
|
|
1471
|
+
export declare const Agency_EOInfoSchema: GenMessage<Agency_EOInfo>;
|
|
1472
|
+
/**
|
|
1473
|
+
* Principal is a data structure that represents the principal of a agency.
|
|
1474
|
+
* A principal is the person or entity that is responsible for the day-to-day operations of the agency.
|
|
1475
|
+
* The principal is usually the CEO or CFO of the agency.nThe principal is also known as the "owner" of the agency.
|
|
1476
|
+
*
|
|
1477
|
+
* @generated from message producerflow.producer.v1.Agency.Principal
|
|
1478
|
+
*/
|
|
1479
|
+
export type Agency_Principal = Message<"producerflow.producer.v1.Agency.Principal"> & {
|
|
1480
|
+
/**
|
|
1481
|
+
* Unique identifier for the principal (as a producer).
|
|
1482
|
+
*
|
|
1483
|
+
* @generated from field: string id = 1;
|
|
1484
|
+
*/
|
|
1485
|
+
id: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* First name of the principal.
|
|
1488
|
+
*
|
|
1489
|
+
* @generated from field: string first_name = 2;
|
|
1490
|
+
*/
|
|
1491
|
+
firstName: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* Last name of the principal.
|
|
1494
|
+
*
|
|
1495
|
+
* @generated from field: string last_name = 3;
|
|
1496
|
+
*/
|
|
1497
|
+
lastName: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* Middle name of the principal.
|
|
1500
|
+
*
|
|
1501
|
+
* @generated from field: string middle_name = 9;
|
|
1502
|
+
*/
|
|
1503
|
+
middleName: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* Email address of the principal.
|
|
1506
|
+
* Must be unique and is used for communication.
|
|
1507
|
+
*
|
|
1508
|
+
* @generated from field: string email = 4;
|
|
1509
|
+
*/
|
|
1510
|
+
email: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* The NPN of the principal. This is used to
|
|
1513
|
+
* retrieve the license information
|
|
1514
|
+
* of the principal from the NIPR API.
|
|
1515
|
+
*
|
|
1516
|
+
* @generated from field: string npn = 5;
|
|
1517
|
+
*/
|
|
1518
|
+
npn: string;
|
|
1519
|
+
/**
|
|
1520
|
+
* Phone number of the principal.
|
|
1521
|
+
* Used for communication.
|
|
1522
|
+
*
|
|
1523
|
+
* @generated from field: string phone = 6;
|
|
1524
|
+
*/
|
|
1525
|
+
phone: string;
|
|
1526
|
+
/**
|
|
1527
|
+
* Mailing address of the principal.
|
|
1528
|
+
* This may differ from the agency address.
|
|
1529
|
+
*
|
|
1530
|
+
* @generated from field: producerflow.producer.v1.Agency.Address mailing_address = 8;
|
|
1531
|
+
*/
|
|
1532
|
+
mailingAddress?: Agency_Address;
|
|
1533
|
+
};
|
|
1534
|
+
/**
|
|
1535
|
+
* Describes the message producerflow.producer.v1.Agency.Principal.
|
|
1536
|
+
* Use `create(Agency_PrincipalSchema)` to create a new message.
|
|
1537
|
+
*/
|
|
1538
|
+
export declare const Agency_PrincipalSchema: GenMessage<Agency_Principal>;
|
|
1539
|
+
/**
|
|
1540
|
+
* IvansAccount contains information for IVANS integration.
|
|
1541
|
+
* IVANS is a system for electronic communication between insurance agencies and carriers.
|
|
1542
|
+
*
|
|
1543
|
+
* @generated from message producerflow.producer.v1.Agency.IvansAccount
|
|
1544
|
+
*/
|
|
1545
|
+
export type Agency_IvansAccount = Message<"producerflow.producer.v1.Agency.IvansAccount"> & {
|
|
1546
|
+
/**
|
|
1547
|
+
* Account number for the IVANS service.
|
|
1548
|
+
*
|
|
1549
|
+
* @generated from field: string account_number = 1;
|
|
1550
|
+
*/
|
|
1551
|
+
accountNumber: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* Software used for IVANS communication.
|
|
1554
|
+
*
|
|
1555
|
+
* @generated from field: string ams_software = 2;
|
|
1556
|
+
*/
|
|
1557
|
+
amsSoftware: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* Version of the IVANS software.
|
|
1560
|
+
*
|
|
1561
|
+
* @generated from field: string ams_version = 3;
|
|
1562
|
+
*/
|
|
1563
|
+
amsVersion: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* Mailbox number for the IVANS service.
|
|
1566
|
+
* Used for routing electronic messages.
|
|
1567
|
+
*
|
|
1568
|
+
* @generated from field: string mailbox_number = 4;
|
|
1569
|
+
*/
|
|
1570
|
+
mailboxNumber: string;
|
|
1571
|
+
};
|
|
1572
|
+
/**
|
|
1573
|
+
* Describes the message producerflow.producer.v1.Agency.IvansAccount.
|
|
1574
|
+
* Use `create(Agency_IvansAccountSchema)` to create a new message.
|
|
1575
|
+
*/
|
|
1576
|
+
export declare const Agency_IvansAccountSchema: GenMessage<Agency_IvansAccount>;
|
|
1577
|
+
/**
|
|
1578
|
+
* Producer represents a producer that has been onboarded.
|
|
1579
|
+
*
|
|
1580
|
+
* Internal ID of the producer.
|
|
1581
|
+
*
|
|
1582
|
+
* @generated from message producerflow.producer.v1.Producer
|
|
1583
|
+
*/
|
|
1584
|
+
export type Producer = Message<"producerflow.producer.v1.Producer"> & {
|
|
1585
|
+
/**
|
|
1586
|
+
* The full name of the producer.
|
|
1587
|
+
*
|
|
1588
|
+
* @generated from field: string id = 1;
|
|
1589
|
+
*/
|
|
1590
|
+
id: string;
|
|
1591
|
+
/**
|
|
1592
|
+
* @generated from field: string name = 2;
|
|
1593
|
+
*/
|
|
1594
|
+
name: string;
|
|
1595
|
+
/**
|
|
1596
|
+
* The email address of the producer.
|
|
1597
|
+
* Used for communication and must be unique within the tenant.
|
|
1598
|
+
* Must be a valid email format.
|
|
1599
|
+
*
|
|
1600
|
+
* @generated from field: string email = 3;
|
|
1601
|
+
*/
|
|
1602
|
+
email: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* The National Producer Number (NPN) of the producer.
|
|
1605
|
+
* This is used to retrieve license information from the NIPR API.
|
|
1606
|
+
* Must be non-empty.
|
|
1607
|
+
*
|
|
1608
|
+
* @generated from field: string npn = 4;
|
|
1609
|
+
*/
|
|
1610
|
+
npn: string;
|
|
1611
|
+
/**
|
|
1612
|
+
* Indicates whether the producer is enabled to be synchronized with NIPR API.
|
|
1613
|
+
* When true, the system will regularly check for updates from NIPR.
|
|
1614
|
+
*
|
|
1615
|
+
* @generated from field: bool pdb_alerts_sync_enabled = 13;
|
|
1616
|
+
*/
|
|
1617
|
+
pdbAlertsSyncEnabled: boolean;
|
|
1618
|
+
/**
|
|
1619
|
+
* Basic information about the agency this producer is associated with.
|
|
1620
|
+
*
|
|
1621
|
+
* @generated from field: producerflow.producer.v1.Producer.Agency agency = 7;
|
|
1622
|
+
*/
|
|
1623
|
+
agency?: Producer_Agency;
|
|
1624
|
+
/**
|
|
1625
|
+
* Data synchronized from the NIPR service.
|
|
1626
|
+
* Contains license information, biographic data, regulatory actions,
|
|
1627
|
+
* and carrier appointments.
|
|
1628
|
+
*
|
|
1629
|
+
* @generated from field: producerflow.producer.v1.Producer.NIPR nipr = 6;
|
|
1630
|
+
*/
|
|
1631
|
+
nipr?: Producer_NIPR;
|
|
1632
|
+
/**
|
|
1633
|
+
* The status of the producer onboarding process.
|
|
1634
|
+
* This field is deprecated and should not be used in new code.
|
|
1635
|
+
*
|
|
1636
|
+
* @generated from field: producerflow.producer.v1.ProducerOnboardingState onboarding_status = 11 [deprecated = true];
|
|
1637
|
+
* @deprecated
|
|
1638
|
+
*/
|
|
1639
|
+
onboardingStatus: ProducerOnboardingState;
|
|
1640
|
+
/**
|
|
1641
|
+
* Indicates whether this producer is the principal of an agency.
|
|
1642
|
+
* A principal producer has additional responsibilities and permissions.
|
|
1643
|
+
*
|
|
1644
|
+
* @generated from field: bool is_principal = 12;
|
|
1645
|
+
*/
|
|
1646
|
+
isPrincipal: boolean;
|
|
1647
|
+
/**
|
|
1648
|
+
* The list of requested appointments for the producer.
|
|
1649
|
+
*
|
|
1650
|
+
* @generated from field: repeated string requested_appointments = 14;
|
|
1651
|
+
*/
|
|
1652
|
+
requestedAppointments: string[];
|
|
1653
|
+
};
|
|
1654
|
+
/**
|
|
1655
|
+
* Describes the message producerflow.producer.v1.Producer.
|
|
1656
|
+
* Use `create(ProducerSchema)` to create a new message.
|
|
1657
|
+
*/
|
|
1658
|
+
export declare const ProducerSchema: GenMessage<Producer>;
|
|
1659
|
+
/**
|
|
1660
|
+
* Agency contains basic information about the agency this producer is associated with.
|
|
1661
|
+
*
|
|
1662
|
+
* @generated from message producerflow.producer.v1.Producer.Agency
|
|
1663
|
+
*/
|
|
1664
|
+
export type Producer_Agency = Message<"producerflow.producer.v1.Producer.Agency"> & {
|
|
1665
|
+
/**
|
|
1666
|
+
* Unique identifier for the associated agency.
|
|
1667
|
+
*
|
|
1668
|
+
* @generated from field: string agency_id = 1;
|
|
1669
|
+
*/
|
|
1670
|
+
agencyId: string;
|
|
1671
|
+
/**
|
|
1672
|
+
* Name of the associated agency.
|
|
1673
|
+
*
|
|
1674
|
+
* @generated from field: string name = 2;
|
|
1675
|
+
*/
|
|
1676
|
+
name: string;
|
|
1677
|
+
};
|
|
1678
|
+
/**
|
|
1679
|
+
* Describes the message producerflow.producer.v1.Producer.Agency.
|
|
1680
|
+
* Use `create(Producer_AgencySchema)` to create a new message.
|
|
1681
|
+
*/
|
|
1682
|
+
export declare const Producer_AgencySchema: GenMessage<Producer_Agency>;
|
|
1683
|
+
/**
|
|
1684
|
+
* NIPR contains data synchronized from the National Insurance Producer Registry.
|
|
1685
|
+
*
|
|
1686
|
+
* @generated from message producerflow.producer.v1.Producer.NIPR
|
|
1687
|
+
*/
|
|
1688
|
+
export type Producer_NIPR = Message<"producerflow.producer.v1.Producer.NIPR"> & {
|
|
1689
|
+
/**
|
|
1690
|
+
* List of all licenses held by the producer across different states.
|
|
1691
|
+
*
|
|
1692
|
+
* @generated from field: repeated producerflow.producer.v1.Producer.NIPR.License licenses = 6;
|
|
1693
|
+
*/
|
|
1694
|
+
licenses: Producer_NIPR_License[];
|
|
1695
|
+
/**
|
|
1696
|
+
* Biographic information of the producer from NIPR
|
|
1697
|
+
*
|
|
1698
|
+
* @generated from field: producerflow.producer.v1.Producer.NIPR.Biographic biographic = 8;
|
|
1699
|
+
*/
|
|
1700
|
+
biographic?: Producer_NIPR_Biographic;
|
|
1701
|
+
/**
|
|
1702
|
+
* Producer's regulatory information from NIPR
|
|
1703
|
+
*
|
|
1704
|
+
* @generated from field: producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo regulatory_info = 9;
|
|
1705
|
+
*/
|
|
1706
|
+
regulatoryInfo?: Producer_NIPR_ProducerRegulatoryInfo;
|
|
1707
|
+
/**
|
|
1708
|
+
* List of carrier appointments held by the producer in NIPR.
|
|
1709
|
+
* These represent relationships with insurance carriers that allow
|
|
1710
|
+
* the producer to sell their products.
|
|
1711
|
+
*
|
|
1712
|
+
* @generated from field: repeated producerflow.producer.v1.Producer.NIPR.Appointment appointments = 10;
|
|
1713
|
+
*/
|
|
1714
|
+
appointments: Producer_NIPR_Appointment[];
|
|
1715
|
+
};
|
|
1716
|
+
/**
|
|
1717
|
+
* Describes the message producerflow.producer.v1.Producer.NIPR.
|
|
1718
|
+
* Use `create(Producer_NIPRSchema)` to create a new message.
|
|
1719
|
+
*/
|
|
1720
|
+
export declare const Producer_NIPRSchema: GenMessage<Producer_NIPR>;
|
|
1721
|
+
/**
|
|
1722
|
+
* License contains information about a producer's insurance license.
|
|
1723
|
+
*
|
|
1724
|
+
* @generated from message producerflow.producer.v1.Producer.NIPR.License
|
|
1725
|
+
*/
|
|
1726
|
+
export type Producer_NIPR_License = Message<"producerflow.producer.v1.Producer.NIPR.License"> & {
|
|
1727
|
+
/**
|
|
1728
|
+
* The license number assigned by the state regulatory authority.
|
|
1729
|
+
*
|
|
1730
|
+
* @generated from field: string license_number = 1;
|
|
1731
|
+
*/
|
|
1732
|
+
licenseNumber: string;
|
|
1733
|
+
/**
|
|
1734
|
+
* The state that issued the license.
|
|
1735
|
+
* Typically a two-letter state code.
|
|
1736
|
+
*
|
|
1737
|
+
* @generated from field: string license_state = 2;
|
|
1738
|
+
*/
|
|
1739
|
+
licenseState: string;
|
|
1740
|
+
/**
|
|
1741
|
+
* Indicates whether this is a resident or non-resident license.
|
|
1742
|
+
* Values are typically "Resident" or "Non-Resident".
|
|
1743
|
+
*
|
|
1744
|
+
* @generated from field: string residency_status = 3;
|
|
1745
|
+
*/
|
|
1746
|
+
residencyStatus: string;
|
|
1747
|
+
/**
|
|
1748
|
+
* Indicates whether the license is currently active.
|
|
1749
|
+
*
|
|
1750
|
+
* @generated from field: bool active = 4;
|
|
1751
|
+
*/
|
|
1752
|
+
active: boolean;
|
|
1753
|
+
/**
|
|
1754
|
+
* The current status of the license (valid, expired, etc.).
|
|
1755
|
+
*
|
|
1756
|
+
* @generated from field: producerflow.producer.v1.Producer.NIPR.License.LicenseStatus status = 5;
|
|
1757
|
+
*/
|
|
1758
|
+
status: Producer_NIPR_License_LicenseStatus;
|
|
1759
|
+
/**
|
|
1760
|
+
* The date when the license will expire if not renewed.
|
|
1761
|
+
*
|
|
1762
|
+
* @generated from field: google.protobuf.Timestamp expiration_date = 6;
|
|
1763
|
+
*/
|
|
1764
|
+
expirationDate?: Timestamp;
|
|
1765
|
+
/**
|
|
1766
|
+
* The last time this license information was updated from NIPR.
|
|
1767
|
+
*
|
|
1768
|
+
* @generated from field: google.protobuf.Timestamp updated_at = 7;
|
|
1769
|
+
*/
|
|
1770
|
+
updatedAt?: Timestamp;
|
|
1771
|
+
/**
|
|
1772
|
+
* Lines of Authority associated with this license.
|
|
1773
|
+
* These define what types of insurance the producer can sell in this state.
|
|
1774
|
+
*
|
|
1775
|
+
* @generated from field: repeated producerflow.producer.v1.Producer.NIPR.License.LineOfAuthority lines_of_authority = 8;
|
|
1776
|
+
*/
|
|
1777
|
+
linesOfAuthority: Producer_NIPR_License_LineOfAuthority[];
|
|
1778
|
+
};
|
|
1779
|
+
/**
|
|
1780
|
+
* Describes the message producerflow.producer.v1.Producer.NIPR.License.
|
|
1781
|
+
* Use `create(Producer_NIPR_LicenseSchema)` to create a new message.
|
|
1782
|
+
*/
|
|
1783
|
+
export declare const Producer_NIPR_LicenseSchema: GenMessage<Producer_NIPR_License>;
|
|
1784
|
+
/**
|
|
1785
|
+
* LineOfAuthority represents a specific type of insurance coverage
|
|
1786
|
+
* that a producer is authorized to sell under this license.
|
|
1787
|
+
*
|
|
1788
|
+
* @generated from message producerflow.producer.v1.Producer.NIPR.License.LineOfAuthority
|
|
1789
|
+
*/
|
|
1790
|
+
export type Producer_NIPR_License_LineOfAuthority = Message<"producerflow.producer.v1.Producer.NIPR.License.LineOfAuthority"> & {
|
|
1791
|
+
/**
|
|
1792
|
+
* The Line of Authority description (e.g., "Life", "Property and Casualty", "Health").
|
|
1793
|
+
* This is typically an uppercase string that describes the insurance type.
|
|
1794
|
+
*
|
|
1795
|
+
* @generated from field: string loa = 1;
|
|
1796
|
+
*/
|
|
1797
|
+
loa: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* Whether this Line of Authority is currently active.
|
|
1800
|
+
*
|
|
1801
|
+
* @generated from field: bool active = 2;
|
|
1802
|
+
*/
|
|
1803
|
+
active: boolean;
|
|
1804
|
+
/**
|
|
1805
|
+
* The date when this Line of Authority was issued.
|
|
1806
|
+
*
|
|
1807
|
+
* @generated from field: google.protobuf.Timestamp issue_date = 3;
|
|
1808
|
+
*/
|
|
1809
|
+
issueDate?: Timestamp;
|
|
1810
|
+
};
|
|
1811
|
+
/**
|
|
1812
|
+
* Describes the message producerflow.producer.v1.Producer.NIPR.License.LineOfAuthority.
|
|
1813
|
+
* Use `create(Producer_NIPR_License_LineOfAuthoritySchema)` to create a new message.
|
|
1814
|
+
*/
|
|
1815
|
+
export declare const Producer_NIPR_License_LineOfAuthoritySchema: GenMessage<Producer_NIPR_License_LineOfAuthority>;
|
|
1816
|
+
/**
|
|
1817
|
+
* LicenseStatus defines the possible statuses of an insurance license.
|
|
1818
|
+
*
|
|
1819
|
+
* @generated from enum producerflow.producer.v1.Producer.NIPR.License.LicenseStatus
|
|
1820
|
+
*/
|
|
1821
|
+
export declare enum Producer_NIPR_License_LicenseStatus {
|
|
1822
|
+
/**
|
|
1823
|
+
* Default unspecified value. Avoid using this.
|
|
1824
|
+
*
|
|
1825
|
+
* @generated from enum value: LICENSE_STATUS_UNSPECIFIED = 0;
|
|
1826
|
+
*/
|
|
1827
|
+
UNSPECIFIED = 0,
|
|
1828
|
+
/**
|
|
1829
|
+
* The license has expired and is no longer valid.
|
|
1830
|
+
*
|
|
1831
|
+
* @generated from enum value: LICENSE_STATUS_EXPIRED = 1;
|
|
1832
|
+
*/
|
|
1833
|
+
EXPIRED = 1,
|
|
1834
|
+
/**
|
|
1835
|
+
* License is currently active.
|
|
1836
|
+
*
|
|
1837
|
+
* @generated from enum value: LICENSE_STATUS_VALID = 2;
|
|
1838
|
+
*/
|
|
1839
|
+
VALID = 2,
|
|
1840
|
+
/**
|
|
1841
|
+
* The license exists but is not in an active state.
|
|
1842
|
+
* This could be due to suspension, revocation, or other reasons.
|
|
1843
|
+
*
|
|
1844
|
+
* @generated from enum value: LICENSE_STATUS_NOT_ACTIVE = 3;
|
|
1845
|
+
*/
|
|
1846
|
+
NOT_ACTIVE = 3
|
|
1847
|
+
}
|
|
1848
|
+
/**
|
|
1849
|
+
* Describes the enum producerflow.producer.v1.Producer.NIPR.License.LicenseStatus.
|
|
1850
|
+
*/
|
|
1851
|
+
export declare const Producer_NIPR_License_LicenseStatusSchema: GenEnum<Producer_NIPR_License_LicenseStatus>;
|
|
1852
|
+
/**
|
|
1853
|
+
* Biographic contains personal and identifying information about the producer.
|
|
1854
|
+
*
|
|
1855
|
+
* @generated from message producerflow.producer.v1.Producer.NIPR.Biographic
|
|
1856
|
+
*/
|
|
1857
|
+
export type Producer_NIPR_Biographic = Message<"producerflow.producer.v1.Producer.NIPR.Biographic"> & {
|
|
1858
|
+
/**
|
|
1859
|
+
* Last name of the producer as recorded in NIPR.
|
|
1860
|
+
*
|
|
1861
|
+
* @generated from field: string last_name = 1;
|
|
1862
|
+
*/
|
|
1863
|
+
lastName: string;
|
|
1864
|
+
/**
|
|
1865
|
+
* First name of the producer as recorded in NIPR.
|
|
1866
|
+
*
|
|
1867
|
+
* @generated from field: string first_name = 2;
|
|
1868
|
+
*/
|
|
1869
|
+
firstName: string;
|
|
1870
|
+
/**
|
|
1871
|
+
* Middle name of the producer as recorded in NIPR.
|
|
1872
|
+
*
|
|
1873
|
+
* @generated from field: string middle_name = 3;
|
|
1874
|
+
*/
|
|
1875
|
+
middleName: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* Date of birth of the producer.
|
|
1878
|
+
*
|
|
1879
|
+
* @generated from field: google.protobuf.Timestamp date_of_birth = 4;
|
|
1880
|
+
*/
|
|
1881
|
+
dateOfBirth?: Timestamp;
|
|
1882
|
+
/**
|
|
1883
|
+
* Federal Employer Identification Number if the producer is a business entity.
|
|
1884
|
+
*
|
|
1885
|
+
* @generated from field: string fein = 7;
|
|
1886
|
+
*/
|
|
1887
|
+
fein: string;
|
|
1888
|
+
/**
|
|
1889
|
+
* Company name if the producer is a business entity.
|
|
1890
|
+
*
|
|
1891
|
+
* @generated from field: string company_name = 8;
|
|
1892
|
+
*/
|
|
1893
|
+
companyName: string;
|
|
1894
|
+
/**
|
|
1895
|
+
* State of domicile (resident state) for the producer.
|
|
1896
|
+
* This is the state where the producer is primarily located.
|
|
1897
|
+
*
|
|
1898
|
+
* @generated from field: string state_domicile = 9;
|
|
1899
|
+
*/
|
|
1900
|
+
stateDomicile: string;
|
|
1901
|
+
};
|
|
1902
|
+
/**
|
|
1903
|
+
* Describes the message producerflow.producer.v1.Producer.NIPR.Biographic.
|
|
1904
|
+
* Use `create(Producer_NIPR_BiographicSchema)` to create a new message.
|
|
1905
|
+
*/
|
|
1906
|
+
export declare const Producer_NIPR_BiographicSchema: GenMessage<Producer_NIPR_Biographic>;
|
|
1907
|
+
/**
|
|
1908
|
+
* ProducerRegulatoryInfo contains regulatory information about a producer,
|
|
1909
|
+
* including any regulatory actions taken against them.
|
|
1910
|
+
*
|
|
1911
|
+
* @generated from message producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo
|
|
1912
|
+
*/
|
|
1913
|
+
export type Producer_NIPR_ProducerRegulatoryInfo = Message<"producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo"> & {
|
|
1914
|
+
/**
|
|
1915
|
+
* Map of regulatory actions by state.
|
|
1916
|
+
* The key is the state code, and the value is the regulatory action.
|
|
1917
|
+
*
|
|
1918
|
+
* @generated from field: map<string, producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo.RegulatoryAction> regulatory_actions_by_state = 1;
|
|
1919
|
+
*/
|
|
1920
|
+
regulatoryActionsByState: {
|
|
1921
|
+
[key: string]: Producer_NIPR_ProducerRegulatoryInfo_RegulatoryAction;
|
|
1922
|
+
};
|
|
1923
|
+
/**
|
|
1924
|
+
* Clearance certification information for the producer.
|
|
1925
|
+
*
|
|
1926
|
+
* @generated from field: string clearance_certification_info = 2;
|
|
1927
|
+
*/
|
|
1928
|
+
clearanceCertificationInfo: string;
|
|
1929
|
+
/**
|
|
1930
|
+
* Details about NASD/FINRA examinations taken by the producer.
|
|
1931
|
+
*
|
|
1932
|
+
* @generated from field: string nasd_exam_details = 3;
|
|
1933
|
+
*/
|
|
1934
|
+
nasdExamDetails: string;
|
|
1935
|
+
};
|
|
1936
|
+
/**
|
|
1937
|
+
* Describes the message producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo.
|
|
1938
|
+
* Use `create(Producer_NIPR_ProducerRegulatoryInfoSchema)` to create a new message.
|
|
1939
|
+
*/
|
|
1940
|
+
export declare const Producer_NIPR_ProducerRegulatoryInfoSchema: GenMessage<Producer_NIPR_ProducerRegulatoryInfo>;
|
|
1941
|
+
/**
|
|
1942
|
+
* RegulatoryAction represents a regulatory action taken against a producer.
|
|
1943
|
+
*
|
|
1944
|
+
* @generated from message producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo.RegulatoryAction
|
|
1945
|
+
*/
|
|
1946
|
+
export type Producer_NIPR_ProducerRegulatoryInfo_RegulatoryAction = Message<"producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo.RegulatoryAction"> & {
|
|
1947
|
+
/**
|
|
1948
|
+
* Unique identifier for the regulatory action.
|
|
1949
|
+
*
|
|
1950
|
+
* @generated from field: string action_id = 1;
|
|
1951
|
+
*/
|
|
1952
|
+
actionId: string;
|
|
1953
|
+
/**
|
|
1954
|
+
* The regulatory body that originated the action.
|
|
1955
|
+
* Typically a state insurance department or FINRA.
|
|
1956
|
+
*
|
|
1957
|
+
* @generated from field: string origin_of_action = 2;
|
|
1958
|
+
*/
|
|
1959
|
+
originOfAction: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* The reason why the regulatory action was taken.
|
|
1962
|
+
*
|
|
1963
|
+
* @generated from field: string reason_for_action = 3;
|
|
1964
|
+
*/
|
|
1965
|
+
reasonForAction: string;
|
|
1966
|
+
/**
|
|
1967
|
+
* The outcome or resolution of the regulatory action.
|
|
1968
|
+
*
|
|
1969
|
+
* @generated from field: string disposition = 4;
|
|
1970
|
+
*/
|
|
1971
|
+
disposition: string;
|
|
1972
|
+
/**
|
|
1973
|
+
* The date when the regulatory action was taken.
|
|
1974
|
+
*
|
|
1975
|
+
* @generated from field: google.protobuf.Timestamp date_of_action = 5;
|
|
1976
|
+
*/
|
|
1977
|
+
dateOfAction?: Timestamp;
|
|
1978
|
+
/**
|
|
1979
|
+
* The date when the regulatory action became effective.
|
|
1980
|
+
*
|
|
1981
|
+
* @generated from field: google.protobuf.Timestamp effective_date = 6;
|
|
1982
|
+
*/
|
|
1983
|
+
effectiveDate?: Timestamp;
|
|
1984
|
+
/**
|
|
1985
|
+
* The date when the producer entered into the regulatory action.
|
|
1986
|
+
*
|
|
1987
|
+
* @generated from field: google.protobuf.Timestamp enter_date = 7;
|
|
1988
|
+
*/
|
|
1989
|
+
enterDate?: Timestamp;
|
|
1990
|
+
/**
|
|
1991
|
+
* Reference number for the regulatory action file.
|
|
1992
|
+
*
|
|
1993
|
+
* @generated from field: string file_ref = 8;
|
|
1994
|
+
*/
|
|
1995
|
+
fileRef: string;
|
|
1996
|
+
/**
|
|
1997
|
+
* Any financial penalties associated with the regulatory action.
|
|
1998
|
+
*
|
|
1999
|
+
* @generated from field: string penalty_fine_forfeiture = 9;
|
|
2000
|
+
*/
|
|
2001
|
+
penaltyFineForfeiture: string;
|
|
2002
|
+
/**
|
|
2003
|
+
* Duration of any orders associated with the regulatory action.
|
|
2004
|
+
*
|
|
2005
|
+
* @generated from field: string length_of_order = 10;
|
|
2006
|
+
*/
|
|
2007
|
+
lengthOfOrder: string;
|
|
2008
|
+
};
|
|
2009
|
+
/**
|
|
2010
|
+
* Describes the message producerflow.producer.v1.Producer.NIPR.ProducerRegulatoryInfo.RegulatoryAction.
|
|
2011
|
+
* Use `create(Producer_NIPR_ProducerRegulatoryInfo_RegulatoryActionSchema)` to create a new message.
|
|
2012
|
+
*/
|
|
2013
|
+
export declare const Producer_NIPR_ProducerRegulatoryInfo_RegulatoryActionSchema: GenMessage<Producer_NIPR_ProducerRegulatoryInfo_RegulatoryAction>;
|
|
2014
|
+
/**
|
|
2015
|
+
* Appointment represents a relationship between a producer and an insurance carrier.
|
|
2016
|
+
*
|
|
2017
|
+
* @generated from message producerflow.producer.v1.Producer.NIPR.Appointment
|
|
2018
|
+
*/
|
|
2019
|
+
export type Producer_NIPR_Appointment = Message<"producerflow.producer.v1.Producer.NIPR.Appointment"> & {
|
|
2020
|
+
/**
|
|
2021
|
+
* @generated from field: string branch_id = 1;
|
|
2022
|
+
*/
|
|
2023
|
+
branchId: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* Name of the insurance company for this appointment.
|
|
2026
|
+
*
|
|
2027
|
+
* @generated from field: string company_name = 2;
|
|
2028
|
+
*/
|
|
2029
|
+
companyName: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* Federal Employer Identification Number of the producer's company.
|
|
2032
|
+
*
|
|
2033
|
+
* @generated from field: string fein = 3;
|
|
2034
|
+
*/
|
|
2035
|
+
fein: string;
|
|
2036
|
+
/**
|
|
2037
|
+
* Company code for the insurance carrier.
|
|
2038
|
+
*
|
|
2039
|
+
* @generated from field: string co_code = 4;
|
|
2040
|
+
*/
|
|
2041
|
+
coCode: string;
|
|
2042
|
+
/**
|
|
2043
|
+
* Line of authority for this appointment (e.g., Life, Property, Casualty).
|
|
2044
|
+
* Indicates what types of insurance the producer can sell.
|
|
2045
|
+
*
|
|
2046
|
+
* @generated from field: string line_of_authority = 5;
|
|
2047
|
+
*/
|
|
2048
|
+
lineOfAuthority: string;
|
|
2049
|
+
/**
|
|
2050
|
+
* Code for the line of authority for this appointment.
|
|
2051
|
+
*
|
|
2052
|
+
* @generated from field: string loa_code = 6;
|
|
2053
|
+
*/
|
|
2054
|
+
loaCode: string;
|
|
2055
|
+
/**
|
|
2056
|
+
* Current status of the appointment (e.g., Active, Terminated).
|
|
2057
|
+
*
|
|
2058
|
+
* @generated from field: string status = 7;
|
|
2059
|
+
*/
|
|
2060
|
+
status: string;
|
|
2061
|
+
/**
|
|
2062
|
+
* Reason for termination if the appointment has been terminated.
|
|
2063
|
+
*
|
|
2064
|
+
* @generated from field: string termination_reason = 8;
|
|
2065
|
+
*/
|
|
2066
|
+
terminationReason: string;
|
|
2067
|
+
/**
|
|
2068
|
+
* Date associated with the current status or reason.
|
|
2069
|
+
*
|
|
2070
|
+
* @generated from field: google.protobuf.Timestamp status_reason_date = 9;
|
|
2071
|
+
*/
|
|
2072
|
+
statusReasonDate?: Timestamp;
|
|
2073
|
+
/**
|
|
2074
|
+
* Date when the appointment will renew.
|
|
2075
|
+
*
|
|
2076
|
+
* @generated from field: google.protobuf.Timestamp appointment_renewal_date = 10;
|
|
2077
|
+
*/
|
|
2078
|
+
appointmentRenewalDate?: Timestamp;
|
|
2079
|
+
/**
|
|
2080
|
+
* Additional affiliations or roles the producer has with the agency.
|
|
2081
|
+
*
|
|
2082
|
+
* @generated from field: string agency_affiliations = 11;
|
|
2083
|
+
*/
|
|
2084
|
+
agencyAffiliations: string;
|
|
2085
|
+
};
|
|
2086
|
+
/**
|
|
2087
|
+
* Describes the message producerflow.producer.v1.Producer.NIPR.Appointment.
|
|
2088
|
+
* Use `create(Producer_NIPR_AppointmentSchema)` to create a new message.
|
|
2089
|
+
*/
|
|
2090
|
+
export declare const Producer_NIPR_AppointmentSchema: GenMessage<Producer_NIPR_Appointment>;
|
|
2091
|
+
/**
|
|
2092
|
+
* NewProducer represents the data needed to create a new producer in the system.
|
|
2093
|
+
*
|
|
2094
|
+
* @generated from message producerflow.producer.v1.NewProducer
|
|
2095
|
+
*/
|
|
2096
|
+
export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
|
|
2097
|
+
/**
|
|
2098
|
+
* First name of the producer.
|
|
2099
|
+
* Required and must be non-empty.
|
|
2100
|
+
*
|
|
2101
|
+
* @generated from field: string first_name = 1;
|
|
2102
|
+
*/
|
|
2103
|
+
firstName: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* Last name of the producer.
|
|
2106
|
+
* Required and must be non-empty.
|
|
2107
|
+
*
|
|
2108
|
+
* @generated from field: string last_name = 2;
|
|
2109
|
+
*/
|
|
2110
|
+
lastName: string;
|
|
2111
|
+
/**
|
|
2112
|
+
* Middle name of the producer.
|
|
2113
|
+
* Optional.
|
|
2114
|
+
*
|
|
2115
|
+
* @generated from field: string middle_name = 7;
|
|
2116
|
+
*/
|
|
2117
|
+
middleName: string;
|
|
2118
|
+
/**
|
|
2119
|
+
* Email address of the producer.
|
|
2120
|
+
* Required and must be a valid email format.
|
|
2121
|
+
* Must be unique within the tenant.
|
|
2122
|
+
*
|
|
2123
|
+
* @generated from field: string email = 3;
|
|
2124
|
+
*/
|
|
2125
|
+
email: string;
|
|
2126
|
+
/**
|
|
2127
|
+
* National Producer Number (NPN) of the producer.
|
|
2128
|
+
* Optional, but recommended for license verification.
|
|
2129
|
+
*
|
|
2130
|
+
* @generated from field: string npn = 4;
|
|
2131
|
+
*/
|
|
2132
|
+
npn: string;
|
|
2133
|
+
/**
|
|
2134
|
+
* Phone number of the producer.
|
|
2135
|
+
* Optional if default value, but if provided must match the pattern of a valid phone number.
|
|
2136
|
+
*
|
|
2137
|
+
* @generated from field: string phone = 5;
|
|
2138
|
+
*/
|
|
2139
|
+
phone: string;
|
|
2140
|
+
/**
|
|
2141
|
+
* Mailing address of the producer.
|
|
2142
|
+
* This is where correspondence will be sent.
|
|
2143
|
+
*
|
|
2144
|
+
* @generated from field: producerflow.producer.v1.NewProducer.Address mailing_address = 6;
|
|
2145
|
+
*/
|
|
2146
|
+
mailingAddress?: NewProducer_Address;
|
|
2147
|
+
/**
|
|
2148
|
+
* External tenant identifier for the producer.
|
|
2149
|
+
* Used for integration with external systems.
|
|
2150
|
+
*
|
|
2151
|
+
* @generated from field: string tenant_id = 8;
|
|
2152
|
+
*/
|
|
2153
|
+
tenantId: string;
|
|
2154
|
+
/**
|
|
2155
|
+
* Indicates whether the producer should be automatically approved.
|
|
2156
|
+
* This field is deprecated and should not be used in new code.
|
|
2157
|
+
*
|
|
2158
|
+
* @generated from field: bool auto_approve = 9 [deprecated = true];
|
|
2159
|
+
* @deprecated
|
|
2160
|
+
*/
|
|
2161
|
+
autoApprove: boolean;
|
|
2162
|
+
};
|
|
2163
|
+
/**
|
|
2164
|
+
* Describes the message producerflow.producer.v1.NewProducer.
|
|
2165
|
+
* Use `create(NewProducerSchema)` to create a new message.
|
|
2166
|
+
*/
|
|
2167
|
+
export declare const NewProducerSchema: GenMessage<NewProducer>;
|
|
2168
|
+
/**
|
|
2169
|
+
* Address represents a mailing address for the producer.
|
|
2170
|
+
*
|
|
2171
|
+
* @generated from message producerflow.producer.v1.NewProducer.Address
|
|
2172
|
+
*/
|
|
2173
|
+
export type NewProducer_Address = Message<"producerflow.producer.v1.NewProducer.Address"> & {
|
|
2174
|
+
/**
|
|
2175
|
+
* Street address of the producer.
|
|
2176
|
+
* Required and must be non-empty.
|
|
2177
|
+
*
|
|
2178
|
+
* @generated from field: string street = 1;
|
|
2179
|
+
*/
|
|
2180
|
+
street: string;
|
|
2181
|
+
/**
|
|
2182
|
+
* City of the producer.
|
|
2183
|
+
* Required and must be non-empty.
|
|
2184
|
+
*
|
|
2185
|
+
* @generated from field: string city = 2;
|
|
2186
|
+
*/
|
|
2187
|
+
city: string;
|
|
2188
|
+
/**
|
|
2189
|
+
* State of the producer.
|
|
2190
|
+
* Required and must be a 2-letter state code.
|
|
2191
|
+
*
|
|
2192
|
+
* @generated from field: string state = 3;
|
|
2193
|
+
*/
|
|
2194
|
+
state: string;
|
|
2195
|
+
/**
|
|
2196
|
+
* Zip code of the producer.
|
|
2197
|
+
* Required and must be between 1 and 10 characters.
|
|
2198
|
+
*
|
|
2199
|
+
* @generated from field: string zip = 4;
|
|
2200
|
+
*/
|
|
2201
|
+
zip: string;
|
|
2202
|
+
};
|
|
2203
|
+
/**
|
|
2204
|
+
* Describes the message producerflow.producer.v1.NewProducer.Address.
|
|
2205
|
+
* Use `create(NewProducer_AddressSchema)` to create a new message.
|
|
2206
|
+
*/
|
|
2207
|
+
export declare const NewProducer_AddressSchema: GenMessage<NewProducer_Address>;
|
|
2208
|
+
/**
|
|
2209
|
+
* NewProducerRequest is used to create a new producer and associate it with an agency.
|
|
2210
|
+
* This will trigger a call to the NIPR API to retrieve license information of the producer.
|
|
2211
|
+
*
|
|
2212
|
+
* @generated from message producerflow.producer.v1.NewProducerRequest
|
|
2213
|
+
*/
|
|
2214
|
+
export type NewProducerRequest = Message<"producerflow.producer.v1.NewProducerRequest"> & {
|
|
2215
|
+
/**
|
|
2216
|
+
* The UUID of the agency to associate the producer with.
|
|
2217
|
+
* Must be a valid UUID format.
|
|
2218
|
+
*
|
|
2219
|
+
* @generated from field: string agency_id = 1;
|
|
2220
|
+
*/
|
|
2221
|
+
agencyId: string;
|
|
2222
|
+
/**
|
|
2223
|
+
* Information about the producer to create.
|
|
2224
|
+
* This field is required.
|
|
2225
|
+
*
|
|
2226
|
+
* @generated from field: producerflow.producer.v1.NewProducer producer = 2;
|
|
2227
|
+
*/
|
|
2228
|
+
producer?: NewProducer;
|
|
2229
|
+
};
|
|
2230
|
+
/**
|
|
2231
|
+
* Describes the message producerflow.producer.v1.NewProducerRequest.
|
|
2232
|
+
* Use `create(NewProducerRequestSchema)` to create a new message.
|
|
2233
|
+
*/
|
|
2234
|
+
export declare const NewProducerRequestSchema: GenMessage<NewProducerRequest>;
|
|
2235
|
+
/**
|
|
2236
|
+
* NewProducerResponse contains the ID of the created producer.
|
|
2237
|
+
*
|
|
2238
|
+
* @generated from message producerflow.producer.v1.NewProducerResponse
|
|
2239
|
+
*/
|
|
2240
|
+
export type NewProducerResponse = Message<"producerflow.producer.v1.NewProducerResponse"> & {
|
|
2241
|
+
/**
|
|
2242
|
+
* The UUID of the created producer.
|
|
2243
|
+
* Must be a valid UUID format.
|
|
2244
|
+
*
|
|
2245
|
+
* @generated from field: string producer_id = 1;
|
|
2246
|
+
*/
|
|
2247
|
+
producerId: string;
|
|
2248
|
+
};
|
|
2249
|
+
/**
|
|
2250
|
+
* Describes the message producerflow.producer.v1.NewProducerResponse.
|
|
2251
|
+
* Use `create(NewProducerResponseSchema)` to create a new message.
|
|
2252
|
+
*/
|
|
2253
|
+
export declare const NewProducerResponseSchema: GenMessage<NewProducerResponse>;
|
|
2254
|
+
/**
|
|
2255
|
+
* NewProducersRequest is used to create multiple producers in a single request.
|
|
2256
|
+
* All producers will be associated with the specified agency.
|
|
2257
|
+
*
|
|
2258
|
+
* @generated from message producerflow.producer.v1.NewProducersRequest
|
|
2259
|
+
*/
|
|
2260
|
+
export type NewProducersRequest = Message<"producerflow.producer.v1.NewProducersRequest"> & {
|
|
2261
|
+
/**
|
|
2262
|
+
* The UUID of the agency to associate the producers with.
|
|
2263
|
+
* Must be a valid UUID format.
|
|
2264
|
+
*
|
|
2265
|
+
* @generated from field: string agency_id = 1;
|
|
2266
|
+
*/
|
|
2267
|
+
agencyId: string;
|
|
2268
|
+
/**
|
|
2269
|
+
* List of producers to create.
|
|
2270
|
+
* This field is required and must contain at least one producer.
|
|
2271
|
+
*
|
|
2272
|
+
* @generated from field: repeated producerflow.producer.v1.NewProducer producers = 2;
|
|
2273
|
+
*/
|
|
2274
|
+
producers: NewProducer[];
|
|
2275
|
+
};
|
|
2276
|
+
/**
|
|
2277
|
+
* Describes the message producerflow.producer.v1.NewProducersRequest.
|
|
2278
|
+
* Use `create(NewProducersRequestSchema)` to create a new message.
|
|
2279
|
+
*/
|
|
2280
|
+
export declare const NewProducersRequestSchema: GenMessage<NewProducersRequest>;
|
|
2281
|
+
/**
|
|
2282
|
+
* NewProducersResponse contains the IDs of all created producers.
|
|
2283
|
+
*
|
|
2284
|
+
* @generated from message producerflow.producer.v1.NewProducersResponse
|
|
2285
|
+
*/
|
|
2286
|
+
export type NewProducersResponse = Message<"producerflow.producer.v1.NewProducersResponse"> & {
|
|
2287
|
+
/**
|
|
2288
|
+
* List of UUIDs for the newly created producers.
|
|
2289
|
+
* The order matches the order of producers in the request.
|
|
2290
|
+
*
|
|
2291
|
+
* @generated from field: repeated string producer_ids = 1;
|
|
2292
|
+
*/
|
|
2293
|
+
producerIds: string[];
|
|
2294
|
+
};
|
|
2295
|
+
/**
|
|
2296
|
+
* Describes the message producerflow.producer.v1.NewProducersResponse.
|
|
2297
|
+
* Use `create(NewProducersResponseSchema)` to create a new message.
|
|
2298
|
+
*/
|
|
2299
|
+
export declare const NewProducersResponseSchema: GenMessage<NewProducersResponse>;
|
|
2300
|
+
/**
|
|
2301
|
+
* NewContact represents the data needed to create a new contact in the system.
|
|
2302
|
+
* Contacts represent non-producer individuals associated with an agency.
|
|
2303
|
+
*
|
|
2304
|
+
* @generated from message producerflow.producer.v1.NewContact
|
|
2305
|
+
*/
|
|
2306
|
+
export type NewContact = Message<"producerflow.producer.v1.NewContact"> & {
|
|
2307
|
+
/**
|
|
2308
|
+
* First name of the contact.
|
|
2309
|
+
* Required and must be non-empty.
|
|
2310
|
+
*
|
|
2311
|
+
* @generated from field: string first_name = 1;
|
|
2312
|
+
*/
|
|
2313
|
+
firstName: string;
|
|
2314
|
+
/**
|
|
2315
|
+
* Last name of the contact.
|
|
2316
|
+
* Required and must be non-empty.
|
|
2317
|
+
*
|
|
2318
|
+
* @generated from field: string last_name = 2;
|
|
2319
|
+
*/
|
|
2320
|
+
lastName: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* Middle name of the contact.
|
|
2323
|
+
* Optional.
|
|
2324
|
+
*
|
|
2325
|
+
* @generated from field: string middle_name = 3;
|
|
2326
|
+
*/
|
|
2327
|
+
middleName: string;
|
|
2328
|
+
/**
|
|
2329
|
+
* Email address of the contact.
|
|
2330
|
+
* Required and must be a valid email format.
|
|
2331
|
+
* Must be unique within the tenant.
|
|
2332
|
+
*
|
|
2333
|
+
* @generated from field: string email = 4;
|
|
2334
|
+
*/
|
|
2335
|
+
email: string;
|
|
2336
|
+
/**
|
|
2337
|
+
* Phone number of the contact.
|
|
2338
|
+
* Optional if default value, but if provided must match the pattern of a valid phone number.
|
|
2339
|
+
*
|
|
2340
|
+
* @generated from field: string phone = 5;
|
|
2341
|
+
*/
|
|
2342
|
+
phone: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* Mailing address of the contact.
|
|
2345
|
+
*
|
|
2346
|
+
* @generated from field: producerflow.producer.v1.NewContact.Address address = 6;
|
|
2347
|
+
*/
|
|
2348
|
+
address?: NewContact_Address;
|
|
2349
|
+
/**
|
|
2350
|
+
* Role or position of the contact within the agency.
|
|
2351
|
+
* Required and must be non-empty.
|
|
2352
|
+
*
|
|
2353
|
+
* @generated from field: string role = 7;
|
|
2354
|
+
*/
|
|
2355
|
+
role: string;
|
|
2356
|
+
/**
|
|
2357
|
+
* External tenant identifier for the contact.
|
|
2358
|
+
* Used for integration with external systems.
|
|
2359
|
+
*
|
|
2360
|
+
* @generated from field: string tenant_id = 8;
|
|
2361
|
+
*/
|
|
2362
|
+
tenantId: string;
|
|
2363
|
+
/**
|
|
2364
|
+
* National Producer Number (NPN) of the contact.
|
|
2365
|
+
*
|
|
2366
|
+
* @generated from field: string npn = 9;
|
|
2367
|
+
*/
|
|
2368
|
+
npn: string;
|
|
2369
|
+
};
|
|
2370
|
+
/**
|
|
2371
|
+
* Describes the message producerflow.producer.v1.NewContact.
|
|
2372
|
+
* Use `create(NewContactSchema)` to create a new message.
|
|
2373
|
+
*/
|
|
2374
|
+
export declare const NewContactSchema: GenMessage<NewContact>;
|
|
2375
|
+
/**
|
|
2376
|
+
* Address represents a mailing address for the contact.
|
|
2377
|
+
*
|
|
2378
|
+
* @generated from message producerflow.producer.v1.NewContact.Address
|
|
2379
|
+
*/
|
|
2380
|
+
export type NewContact_Address = Message<"producerflow.producer.v1.NewContact.Address"> & {
|
|
2381
|
+
/**
|
|
2382
|
+
* Street address of the contact.
|
|
2383
|
+
* Required and must be non-empty.
|
|
2384
|
+
*
|
|
2385
|
+
* @generated from field: string street = 1;
|
|
2386
|
+
*/
|
|
2387
|
+
street: string;
|
|
2388
|
+
/**
|
|
2389
|
+
* City of the contact.
|
|
2390
|
+
* Required and must be non-empty.
|
|
2391
|
+
*
|
|
2392
|
+
* @generated from field: string city = 2;
|
|
2393
|
+
*/
|
|
2394
|
+
city: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* State of the contact's address.
|
|
2397
|
+
* Required and must be exactly 2 characters (state code).
|
|
2398
|
+
*
|
|
2399
|
+
* @generated from field: string state = 3;
|
|
2400
|
+
*/
|
|
2401
|
+
state: string;
|
|
2402
|
+
/**
|
|
2403
|
+
* Zip code of the contact's address.
|
|
2404
|
+
* Required and must be between 1 and 10 characters.
|
|
2405
|
+
*
|
|
2406
|
+
* @generated from field: string zip = 4;
|
|
2407
|
+
*/
|
|
2408
|
+
zip: string;
|
|
2409
|
+
};
|
|
2410
|
+
/**
|
|
2411
|
+
* Describes the message producerflow.producer.v1.NewContact.Address.
|
|
2412
|
+
* Use `create(NewContact_AddressSchema)` to create a new message.
|
|
2413
|
+
*/
|
|
2414
|
+
export declare const NewContact_AddressSchema: GenMessage<NewContact_Address>;
|
|
2415
|
+
/**
|
|
2416
|
+
* NewContactRequest is used to create a new contact and associate it with an agency.
|
|
2417
|
+
*
|
|
2418
|
+
* @generated from message producerflow.producer.v1.NewContactRequest
|
|
2419
|
+
*/
|
|
2420
|
+
export type NewContactRequest = Message<"producerflow.producer.v1.NewContactRequest"> & {
|
|
2421
|
+
/**
|
|
2422
|
+
* The UUID of the agency to associate the contact with.
|
|
2423
|
+
* Must be a valid UUID format.
|
|
2424
|
+
*
|
|
2425
|
+
* @generated from field: string agency_id = 1;
|
|
2426
|
+
*/
|
|
2427
|
+
agencyId: string;
|
|
2428
|
+
/**
|
|
2429
|
+
* Information about the contact to create.
|
|
2430
|
+
*
|
|
2431
|
+
* @generated from field: producerflow.producer.v1.NewContact contact = 2;
|
|
2432
|
+
*/
|
|
2433
|
+
contact?: NewContact;
|
|
2434
|
+
};
|
|
2435
|
+
/**
|
|
2436
|
+
* Describes the message producerflow.producer.v1.NewContactRequest.
|
|
2437
|
+
* Use `create(NewContactRequestSchema)` to create a new message.
|
|
2438
|
+
*/
|
|
2439
|
+
export declare const NewContactRequestSchema: GenMessage<NewContactRequest>;
|
|
2440
|
+
/**
|
|
2441
|
+
* NewContactResponse contains the ID of the created contact.
|
|
2442
|
+
*
|
|
2443
|
+
* @generated from message producerflow.producer.v1.NewContactResponse
|
|
2444
|
+
*/
|
|
2445
|
+
export type NewContactResponse = Message<"producerflow.producer.v1.NewContactResponse"> & {
|
|
2446
|
+
/**
|
|
2447
|
+
* The UUID of the created contact.
|
|
2448
|
+
* Must be a valid UUID format.
|
|
2449
|
+
*
|
|
2450
|
+
* @generated from field: string contact_id = 1;
|
|
2451
|
+
*/
|
|
2452
|
+
contactId: string;
|
|
2453
|
+
};
|
|
2454
|
+
/**
|
|
2455
|
+
* Describes the message producerflow.producer.v1.NewContactResponse.
|
|
2456
|
+
* Use `create(NewContactResponseSchema)` to create a new message.
|
|
2457
|
+
*/
|
|
2458
|
+
export declare const NewContactResponseSchema: GenMessage<NewContactResponse>;
|
|
2459
|
+
/**
|
|
2460
|
+
* NewContactsRequest is used to create multiple contacts in a single request.
|
|
2461
|
+
* All contacts will be associated with the specified agency.
|
|
2462
|
+
*
|
|
2463
|
+
* @generated from message producerflow.producer.v1.NewContactsRequest
|
|
2464
|
+
*/
|
|
2465
|
+
export type NewContactsRequest = Message<"producerflow.producer.v1.NewContactsRequest"> & {
|
|
2466
|
+
/**
|
|
2467
|
+
* The UUID of the agency to associate the contacts with.
|
|
2468
|
+
* Must be a valid UUID format.
|
|
2469
|
+
*
|
|
2470
|
+
* @generated from field: string agency_id = 1;
|
|
2471
|
+
*/
|
|
2472
|
+
agencyId: string;
|
|
2473
|
+
/**
|
|
2474
|
+
* List of contacts to create.
|
|
2475
|
+
* This field is required and must contain at least one contact.
|
|
2476
|
+
*
|
|
2477
|
+
* @generated from field: repeated producerflow.producer.v1.NewContact contacts = 2;
|
|
2478
|
+
*/
|
|
2479
|
+
contacts: NewContact[];
|
|
2480
|
+
};
|
|
2481
|
+
/**
|
|
2482
|
+
* Describes the message producerflow.producer.v1.NewContactsRequest.
|
|
2483
|
+
* Use `create(NewContactsRequestSchema)` to create a new message.
|
|
2484
|
+
*/
|
|
2485
|
+
export declare const NewContactsRequestSchema: GenMessage<NewContactsRequest>;
|
|
2486
|
+
/**
|
|
2487
|
+
* NewContactsResponse contains the IDs of all created contacts.
|
|
2488
|
+
*
|
|
2489
|
+
* @generated from message producerflow.producer.v1.NewContactsResponse
|
|
2490
|
+
*/
|
|
2491
|
+
export type NewContactsResponse = Message<"producerflow.producer.v1.NewContactsResponse"> & {
|
|
2492
|
+
/**
|
|
2493
|
+
* List of UUIDs for the newly created contacts.
|
|
2494
|
+
* The order matches the order of contacts in the request.
|
|
2495
|
+
*
|
|
2496
|
+
* @generated from field: repeated string contact_ids = 1;
|
|
2497
|
+
*/
|
|
2498
|
+
contactIds: string[];
|
|
2499
|
+
};
|
|
2500
|
+
/**
|
|
2501
|
+
* Describes the message producerflow.producer.v1.NewContactsResponse.
|
|
2502
|
+
* Use `create(NewContactsResponseSchema)` to create a new message.
|
|
2503
|
+
*/
|
|
2504
|
+
export declare const NewContactsResponseSchema: GenMessage<NewContactsResponse>;
|
|
2505
|
+
/**
|
|
2506
|
+
* SetExternalIDRequest is used to associate an external identifier with a producer, agency, or contact.
|
|
2507
|
+
* This allows integration with external systems that use different ID schemes.
|
|
2508
|
+
*
|
|
2509
|
+
* Only one entity type can be specified.
|
|
2510
|
+
*
|
|
2511
|
+
* @generated from message producerflow.producer.v1.SetExternalIDRequest
|
|
2512
|
+
*/
|
|
2513
|
+
export type SetExternalIDRequest = Message<"producerflow.producer.v1.SetExternalIDRequest"> & {
|
|
2514
|
+
/**
|
|
2515
|
+
* @generated from oneof producerflow.producer.v1.SetExternalIDRequest.entity_id
|
|
2516
|
+
*/
|
|
2517
|
+
entityId: {
|
|
2518
|
+
/**
|
|
2519
|
+
* The UUID of the producer to set an external ID for.
|
|
2520
|
+
*
|
|
2521
|
+
* @generated from field: string producer_id = 1;
|
|
2522
|
+
*/
|
|
2523
|
+
value: string;
|
|
2524
|
+
case: "producerId";
|
|
2525
|
+
} | {
|
|
2526
|
+
/**
|
|
2527
|
+
* The UUID of the agency to set an external ID for.
|
|
2528
|
+
*
|
|
2529
|
+
* @generated from field: string agency_id = 2;
|
|
2530
|
+
*/
|
|
2531
|
+
value: string;
|
|
2532
|
+
case: "agencyId";
|
|
2533
|
+
} | {
|
|
2534
|
+
/**
|
|
2535
|
+
* The UUID of the contact to set an external ID for.
|
|
2536
|
+
*
|
|
2537
|
+
* @generated from field: string contact_id = 3;
|
|
2538
|
+
*/
|
|
2539
|
+
value: string;
|
|
2540
|
+
case: "contactId";
|
|
2541
|
+
} | {
|
|
2542
|
+
case: undefined;
|
|
2543
|
+
value?: undefined;
|
|
2544
|
+
};
|
|
2545
|
+
/**
|
|
2546
|
+
* The external tenant identifier to associate with the entity.
|
|
2547
|
+
* Required and must be non-empty.
|
|
2548
|
+
*
|
|
2549
|
+
* @generated from field: string tenant_id = 4;
|
|
2550
|
+
*/
|
|
2551
|
+
tenantId: string;
|
|
2552
|
+
};
|
|
2553
|
+
/**
|
|
2554
|
+
* Describes the message producerflow.producer.v1.SetExternalIDRequest.
|
|
2555
|
+
* Use `create(SetExternalIDRequestSchema)` to create a new message.
|
|
2556
|
+
*/
|
|
2557
|
+
export declare const SetExternalIDRequestSchema: GenMessage<SetExternalIDRequest>;
|
|
2558
|
+
/**
|
|
2559
|
+
* SetExternalIDResponse is the empty response returned after successfully setting an external ID.
|
|
2560
|
+
*
|
|
2561
|
+
* @generated from message producerflow.producer.v1.SetExternalIDResponse
|
|
2562
|
+
*/
|
|
2563
|
+
export type SetExternalIDResponse = Message<"producerflow.producer.v1.SetExternalIDResponse"> & {};
|
|
2564
|
+
/**
|
|
2565
|
+
* Describes the message producerflow.producer.v1.SetExternalIDResponse.
|
|
2566
|
+
* Use `create(SetExternalIDResponseSchema)` to create a new message.
|
|
2567
|
+
*/
|
|
2568
|
+
export declare const SetExternalIDResponseSchema: GenMessage<SetExternalIDResponse>;
|
|
2569
|
+
/**
|
|
2570
|
+
* ValidateProducerNPNRequest is used to validate a producer's National Producer Number.
|
|
2571
|
+
*
|
|
2572
|
+
* @generated from message producerflow.producer.v1.ValidateProducerNPNRequest
|
|
2573
|
+
*/
|
|
2574
|
+
export type ValidateProducerNPNRequest = Message<"producerflow.producer.v1.ValidateProducerNPNRequest"> & {
|
|
2575
|
+
/**
|
|
2576
|
+
* The National Producer Number (NPN) to validate.
|
|
2577
|
+
* Required and must be non-empty.
|
|
2578
|
+
*
|
|
2579
|
+
* @generated from field: string npn = 1;
|
|
2580
|
+
*/
|
|
2581
|
+
npn: string;
|
|
2582
|
+
/**
|
|
2583
|
+
* Optional name of the producer to validate.
|
|
2584
|
+
* If provided, the NPN will be validated against this name.
|
|
2585
|
+
*
|
|
2586
|
+
* @generated from field: optional string name = 2;
|
|
2587
|
+
*/
|
|
2588
|
+
name?: string;
|
|
2589
|
+
};
|
|
2590
|
+
/**
|
|
2591
|
+
* Describes the message producerflow.producer.v1.ValidateProducerNPNRequest.
|
|
2592
|
+
* Use `create(ValidateProducerNPNRequestSchema)` to create a new message.
|
|
2593
|
+
*/
|
|
2594
|
+
export declare const ValidateProducerNPNRequestSchema: GenMessage<ValidateProducerNPNRequest>;
|
|
2595
|
+
/**
|
|
2596
|
+
* ValidateProducerNPNResponse contains the result of validating a producer's NPN.
|
|
2597
|
+
*
|
|
2598
|
+
* @generated from message producerflow.producer.v1.ValidateProducerNPNResponse
|
|
2599
|
+
*/
|
|
2600
|
+
export type ValidateProducerNPNResponse = Message<"producerflow.producer.v1.ValidateProducerNPNResponse"> & {
|
|
2601
|
+
/**
|
|
2602
|
+
* Indicates whether the NPN is valid.
|
|
2603
|
+
* True if the NPN exists and is valid, false otherwise.
|
|
2604
|
+
*
|
|
2605
|
+
* @generated from field: bool valid = 1;
|
|
2606
|
+
*/
|
|
2607
|
+
valid: boolean;
|
|
2608
|
+
};
|
|
2609
|
+
/**
|
|
2610
|
+
* Describes the message producerflow.producer.v1.ValidateProducerNPNResponse.
|
|
2611
|
+
* Use `create(ValidateProducerNPNResponseSchema)` to create a new message.
|
|
2612
|
+
*/
|
|
2613
|
+
export declare const ValidateProducerNPNResponseSchema: GenMessage<ValidateProducerNPNResponse>;
|
|
2614
|
+
/**
|
|
2615
|
+
* ValidateAgencyNPNRequest is used to validate an agency's National Producer Number.
|
|
2616
|
+
*
|
|
2617
|
+
* @generated from message producerflow.producer.v1.ValidateAgencyNPNRequest
|
|
2618
|
+
*/
|
|
2619
|
+
export type ValidateAgencyNPNRequest = Message<"producerflow.producer.v1.ValidateAgencyNPNRequest"> & {
|
|
2620
|
+
/**
|
|
2621
|
+
* The National Producer Number (NPN) to validate.
|
|
2622
|
+
* Required and must be non-empty.
|
|
2623
|
+
*
|
|
2624
|
+
* @generated from field: string npn = 1;
|
|
2625
|
+
*/
|
|
2626
|
+
npn: string;
|
|
2627
|
+
};
|
|
2628
|
+
/**
|
|
2629
|
+
* Describes the message producerflow.producer.v1.ValidateAgencyNPNRequest.
|
|
2630
|
+
* Use `create(ValidateAgencyNPNRequestSchema)` to create a new message.
|
|
2631
|
+
*/
|
|
2632
|
+
export declare const ValidateAgencyNPNRequestSchema: GenMessage<ValidateAgencyNPNRequest>;
|
|
2633
|
+
/**
|
|
2634
|
+
* ValidateAgencyNPNResponse contains the result of validating an agency's NPN.
|
|
2635
|
+
*
|
|
2636
|
+
* @generated from message producerflow.producer.v1.ValidateAgencyNPNResponse
|
|
2637
|
+
*/
|
|
2638
|
+
export type ValidateAgencyNPNResponse = Message<"producerflow.producer.v1.ValidateAgencyNPNResponse"> & {
|
|
2639
|
+
/**
|
|
2640
|
+
* Indicates whether the NPN is valid.
|
|
2641
|
+
* True if the NPN exists and is valid, false otherwise.
|
|
2642
|
+
*
|
|
2643
|
+
* @generated from field: bool valid = 1;
|
|
2644
|
+
*/
|
|
2645
|
+
valid: boolean;
|
|
2646
|
+
};
|
|
2647
|
+
/**
|
|
2648
|
+
* Describes the message producerflow.producer.v1.ValidateAgencyNPNResponse.
|
|
2649
|
+
* Use `create(ValidateAgencyNPNResponseSchema)` to create a new message.
|
|
2650
|
+
*/
|
|
2651
|
+
export declare const ValidateAgencyNPNResponseSchema: GenMessage<ValidateAgencyNPNResponse>;
|
|
2652
|
+
/**
|
|
2653
|
+
* LookupNPNByFEINRequest is used to look up a producer's National Producer Number by their Federal Employer Identification Number (FEIN).
|
|
2654
|
+
*
|
|
2655
|
+
* @generated from message producerflow.producer.v1.LookupNPNByFEINRequest
|
|
2656
|
+
*/
|
|
2657
|
+
export type LookupNPNByFEINRequest = Message<"producerflow.producer.v1.LookupNPNByFEINRequest"> & {
|
|
2658
|
+
/**
|
|
2659
|
+
* The Federal Employer Identification Number (FEIN) to look up.
|
|
2660
|
+
* Required and must be exactly 9 characters.
|
|
2661
|
+
*
|
|
2662
|
+
* @generated from field: string fein = 1;
|
|
2663
|
+
*/
|
|
2664
|
+
fein: string;
|
|
2665
|
+
};
|
|
2666
|
+
/**
|
|
2667
|
+
* Describes the message producerflow.producer.v1.LookupNPNByFEINRequest.
|
|
2668
|
+
* Use `create(LookupNPNByFEINRequestSchema)` to create a new message.
|
|
2669
|
+
*/
|
|
2670
|
+
export declare const LookupNPNByFEINRequestSchema: GenMessage<LookupNPNByFEINRequest>;
|
|
2671
|
+
/**
|
|
2672
|
+
* LookupNPNByFEINResponse contains the National Producer Number (NPN) for the producer associated with the given FEIN.
|
|
2673
|
+
*
|
|
2674
|
+
* @generated from message producerflow.producer.v1.LookupNPNByFEINResponse
|
|
2675
|
+
*/
|
|
2676
|
+
export type LookupNPNByFEINResponse = Message<"producerflow.producer.v1.LookupNPNByFEINResponse"> & {
|
|
2677
|
+
/**
|
|
2678
|
+
* The National Producer Number (NPN) for the producer.
|
|
2679
|
+
*
|
|
2680
|
+
* @generated from field: string npn = 1;
|
|
2681
|
+
*/
|
|
2682
|
+
npn: string;
|
|
2683
|
+
};
|
|
2684
|
+
/**
|
|
2685
|
+
* Describes the message producerflow.producer.v1.LookupNPNByFEINResponse.
|
|
2686
|
+
* Use `create(LookupNPNByFEINResponseSchema)` to create a new message.
|
|
2687
|
+
*/
|
|
2688
|
+
export declare const LookupNPNByFEINResponseSchema: GenMessage<LookupNPNByFEINResponse>;
|
|
2689
|
+
/**
|
|
2690
|
+
* ResyncAgencyRequest is used to trigger a manual resynchronization of agency data.
|
|
2691
|
+
* This will re-fetch all data from the NIPR API for the agency and all associated producers.
|
|
2692
|
+
*
|
|
2693
|
+
* @generated from message producerflow.producer.v1.ResyncAgencyRequest
|
|
2694
|
+
*/
|
|
2695
|
+
export type ResyncAgencyRequest = Message<"producerflow.producer.v1.ResyncAgencyRequest"> & {
|
|
2696
|
+
/**
|
|
2697
|
+
* The UUID of the agency to resynchronize.
|
|
2698
|
+
* Must be a valid UUID format.
|
|
2699
|
+
*
|
|
2700
|
+
* @generated from field: string agency_id = 1;
|
|
2701
|
+
*/
|
|
2702
|
+
agencyId: string;
|
|
2703
|
+
};
|
|
2704
|
+
/**
|
|
2705
|
+
* Describes the message producerflow.producer.v1.ResyncAgencyRequest.
|
|
2706
|
+
* Use `create(ResyncAgencyRequestSchema)` to create a new message.
|
|
2707
|
+
*/
|
|
2708
|
+
export declare const ResyncAgencyRequestSchema: GenMessage<ResyncAgencyRequest>;
|
|
2709
|
+
/**
|
|
2710
|
+
* ResyncAgencyResponse is the empty response returned after successfully triggering a resynchronization.
|
|
2711
|
+
*
|
|
2712
|
+
* @generated from message producerflow.producer.v1.ResyncAgencyResponse
|
|
2713
|
+
*/
|
|
2714
|
+
export type ResyncAgencyResponse = Message<"producerflow.producer.v1.ResyncAgencyResponse"> & {};
|
|
2715
|
+
/**
|
|
2716
|
+
* Describes the message producerflow.producer.v1.ResyncAgencyResponse.
|
|
2717
|
+
* Use `create(ResyncAgencyResponseSchema)` to create a new message.
|
|
2718
|
+
*/
|
|
2719
|
+
export declare const ResyncAgencyResponseSchema: GenMessage<ResyncAgencyResponse>;
|
|
2720
|
+
/**
|
|
2721
|
+
* ResyncProducerRequest is used to trigger a manual resynchronization of producer data.
|
|
2722
|
+
*
|
|
2723
|
+
* @generated from message producerflow.producer.v1.ResyncProducerRequest
|
|
2724
|
+
*/
|
|
2725
|
+
export type ResyncProducerRequest = Message<"producerflow.producer.v1.ResyncProducerRequest"> & {
|
|
2726
|
+
/**
|
|
2727
|
+
* The UUID of the producer to resynchronize.
|
|
2728
|
+
* Must be a valid UUID format.
|
|
2729
|
+
*
|
|
2730
|
+
* @generated from field: string producer_id = 1;
|
|
2731
|
+
*/
|
|
2732
|
+
producerId: string;
|
|
2733
|
+
};
|
|
2734
|
+
/**
|
|
2735
|
+
* Describes the message producerflow.producer.v1.ResyncProducerRequest.
|
|
2736
|
+
* Use `create(ResyncProducerRequestSchema)` to create a new message.
|
|
2737
|
+
*/
|
|
2738
|
+
export declare const ResyncProducerRequestSchema: GenMessage<ResyncProducerRequest>;
|
|
2739
|
+
/**
|
|
2740
|
+
* ResyncProducerResponse is the empty response returned after successfully triggering a resynchronization.
|
|
2741
|
+
*
|
|
2742
|
+
* @generated from message producerflow.producer.v1.ResyncProducerResponse
|
|
2743
|
+
*/
|
|
2744
|
+
export type ResyncProducerResponse = Message<"producerflow.producer.v1.ResyncProducerResponse"> & {};
|
|
2745
|
+
/**
|
|
2746
|
+
* Describes the message producerflow.producer.v1.ResyncProducerResponse.
|
|
2747
|
+
* Use `create(ResyncProducerResponseSchema)` to create a new message.
|
|
2748
|
+
*/
|
|
2749
|
+
export declare const ResyncProducerResponseSchema: GenMessage<ResyncProducerResponse>;
|
|
2750
|
+
/**
|
|
2751
|
+
* SyncProducerWithNIPRRequest is used to synchronize a producer's data with the NIPR API.
|
|
2752
|
+
*
|
|
2753
|
+
* @generated from message producerflow.producer.v1.SyncProducerWithNIPRRequest
|
|
2754
|
+
*/
|
|
2755
|
+
export type SyncProducerWithNIPRRequest = Message<"producerflow.producer.v1.SyncProducerWithNIPRRequest"> & {
|
|
2756
|
+
/**
|
|
2757
|
+
* The UUID of the producer to synchronize.
|
|
2758
|
+
* Must be a valid UUID format.
|
|
2759
|
+
*
|
|
2760
|
+
* @generated from field: string producer_id = 1;
|
|
2761
|
+
*/
|
|
2762
|
+
producerId: string;
|
|
2763
|
+
};
|
|
2764
|
+
/**
|
|
2765
|
+
* Describes the message producerflow.producer.v1.SyncProducerWithNIPRRequest.
|
|
2766
|
+
* Use `create(SyncProducerWithNIPRRequestSchema)` to create a new message.
|
|
2767
|
+
*/
|
|
2768
|
+
export declare const SyncProducerWithNIPRRequestSchema: GenMessage<SyncProducerWithNIPRRequest>;
|
|
2769
|
+
/**
|
|
2770
|
+
* SyncProducerWithNIPRResponse is the empty response returned after successfully synchronizing a producer's data with the NIPR API.
|
|
2771
|
+
*
|
|
2772
|
+
* @generated from message producerflow.producer.v1.SyncProducerWithNIPRResponse
|
|
2773
|
+
*/
|
|
2774
|
+
export type SyncProducerWithNIPRResponse = Message<"producerflow.producer.v1.SyncProducerWithNIPRResponse"> & {};
|
|
2775
|
+
/**
|
|
2776
|
+
* Describes the message producerflow.producer.v1.SyncProducerWithNIPRResponse.
|
|
2777
|
+
* Use `create(SyncProducerWithNIPRResponseSchema)` to create a new message.
|
|
2778
|
+
*/
|
|
2779
|
+
export declare const SyncProducerWithNIPRResponseSchema: GenMessage<SyncProducerWithNIPRResponse>;
|
|
2780
|
+
/**
|
|
2781
|
+
* SyncAgencyWithNIPRRequest is used to synchronize an agency's data with the NIPR API.
|
|
2782
|
+
*
|
|
2783
|
+
* @generated from message producerflow.producer.v1.SyncAgencyWithNIPRRequest
|
|
2784
|
+
*/
|
|
2785
|
+
export type SyncAgencyWithNIPRRequest = Message<"producerflow.producer.v1.SyncAgencyWithNIPRRequest"> & {
|
|
2786
|
+
/**
|
|
2787
|
+
* The UUID of the agency to synchronize.
|
|
2788
|
+
* Must be a valid UUID format.
|
|
2789
|
+
*
|
|
2790
|
+
* @generated from field: string agency_id = 1;
|
|
2791
|
+
*/
|
|
2792
|
+
agencyId: string;
|
|
2793
|
+
/**
|
|
2794
|
+
* If true, all producers associated with the agency will be synchronized.
|
|
2795
|
+
* If false, only the agency will be synchronized.
|
|
2796
|
+
*
|
|
2797
|
+
* @generated from field: bool sync_all_producers = 2;
|
|
2798
|
+
*/
|
|
2799
|
+
syncAllProducers: boolean;
|
|
2800
|
+
};
|
|
2801
|
+
/**
|
|
2802
|
+
* Describes the message producerflow.producer.v1.SyncAgencyWithNIPRRequest.
|
|
2803
|
+
* Use `create(SyncAgencyWithNIPRRequestSchema)` to create a new message.
|
|
2804
|
+
*/
|
|
2805
|
+
export declare const SyncAgencyWithNIPRRequestSchema: GenMessage<SyncAgencyWithNIPRRequest>;
|
|
2806
|
+
/**
|
|
2807
|
+
* SyncAgencyWithNIPRResponse is the empty response returned after successfully synchronizing an agency's data with the NIPR API.
|
|
2808
|
+
*
|
|
2809
|
+
* @generated from message producerflow.producer.v1.SyncAgencyWithNIPRResponse
|
|
2810
|
+
*/
|
|
2811
|
+
export type SyncAgencyWithNIPRResponse = Message<"producerflow.producer.v1.SyncAgencyWithNIPRResponse"> & {};
|
|
2812
|
+
/**
|
|
2813
|
+
* Describes the message producerflow.producer.v1.SyncAgencyWithNIPRResponse.
|
|
2814
|
+
* Use `create(SyncAgencyWithNIPRResponseSchema)` to create a new message.
|
|
2815
|
+
*/
|
|
2816
|
+
export declare const SyncAgencyWithNIPRResponseSchema: GenMessage<SyncAgencyWithNIPRResponse>;
|
|
2817
|
+
/**
|
|
2818
|
+
* StopSyncProducerWithNIPRRequest is used to stop synchronizing a producer's data with the NIPR API.
|
|
2819
|
+
*
|
|
2820
|
+
* @generated from message producerflow.producer.v1.StopSyncProducerWithNIPRRequest
|
|
2821
|
+
*/
|
|
2822
|
+
export type StopSyncProducerWithNIPRRequest = Message<"producerflow.producer.v1.StopSyncProducerWithNIPRRequest"> & {
|
|
2823
|
+
/**
|
|
2824
|
+
* The UUID of the producer to stop synchronizing.
|
|
2825
|
+
* Must be a valid UUID format.
|
|
2826
|
+
*
|
|
2827
|
+
* @generated from field: string producer_id = 1;
|
|
2828
|
+
*/
|
|
2829
|
+
producerId: string;
|
|
2830
|
+
};
|
|
2831
|
+
/**
|
|
2832
|
+
* Describes the message producerflow.producer.v1.StopSyncProducerWithNIPRRequest.
|
|
2833
|
+
* Use `create(StopSyncProducerWithNIPRRequestSchema)` to create a new message.
|
|
2834
|
+
*/
|
|
2835
|
+
export declare const StopSyncProducerWithNIPRRequestSchema: GenMessage<StopSyncProducerWithNIPRRequest>;
|
|
2836
|
+
/**
|
|
2837
|
+
* StopSyncProducerWithNIPRResponse is the empty response returned after successfully stopping the synchronization of a producer's data with the NIPR API.
|
|
2838
|
+
*
|
|
2839
|
+
* @generated from message producerflow.producer.v1.StopSyncProducerWithNIPRResponse
|
|
2840
|
+
*/
|
|
2841
|
+
export type StopSyncProducerWithNIPRResponse = Message<"producerflow.producer.v1.StopSyncProducerWithNIPRResponse"> & {};
|
|
2842
|
+
/**
|
|
2843
|
+
* Describes the message producerflow.producer.v1.StopSyncProducerWithNIPRResponse.
|
|
2844
|
+
* Use `create(StopSyncProducerWithNIPRResponseSchema)` to create a new message.
|
|
2845
|
+
*/
|
|
2846
|
+
export declare const StopSyncProducerWithNIPRResponseSchema: GenMessage<StopSyncProducerWithNIPRResponse>;
|
|
2847
|
+
/**
|
|
2848
|
+
* StopSyncAgencyWithNIPRRequest is used to stop synchronizing an agency's data with the NIPR API.
|
|
2849
|
+
*
|
|
2850
|
+
* @generated from message producerflow.producer.v1.StopSyncAgencyWithNIPRRequest
|
|
2851
|
+
*/
|
|
2852
|
+
export type StopSyncAgencyWithNIPRRequest = Message<"producerflow.producer.v1.StopSyncAgencyWithNIPRRequest"> & {
|
|
2853
|
+
/**
|
|
2854
|
+
* The UUID of the agency to stop synchronizing.
|
|
2855
|
+
* Must be a valid UUID format.
|
|
2856
|
+
*
|
|
2857
|
+
* @generated from field: string agency_id = 1;
|
|
2858
|
+
*/
|
|
2859
|
+
agencyId: string;
|
|
2860
|
+
/**
|
|
2861
|
+
* If true, all producers associated with the agency will be stopped from synchronizing.
|
|
2862
|
+
* If false, only the agency will be stopped from synchronizing.
|
|
2863
|
+
*
|
|
2864
|
+
* @generated from field: bool stop_all_producers = 2;
|
|
2865
|
+
*/
|
|
2866
|
+
stopAllProducers: boolean;
|
|
2867
|
+
};
|
|
2868
|
+
/**
|
|
2869
|
+
* Describes the message producerflow.producer.v1.StopSyncAgencyWithNIPRRequest.
|
|
2870
|
+
* Use `create(StopSyncAgencyWithNIPRRequestSchema)` to create a new message.
|
|
2871
|
+
*/
|
|
2872
|
+
export declare const StopSyncAgencyWithNIPRRequestSchema: GenMessage<StopSyncAgencyWithNIPRRequest>;
|
|
2873
|
+
/**
|
|
2874
|
+
* StopSyncAgencyWithNIPRResponse is the empty response returned after successfully stopping the synchronization of an agency's data with the NIPR API.
|
|
2875
|
+
*
|
|
2876
|
+
* @generated from message producerflow.producer.v1.StopSyncAgencyWithNIPRResponse
|
|
2877
|
+
*/
|
|
2878
|
+
export type StopSyncAgencyWithNIPRResponse = Message<"producerflow.producer.v1.StopSyncAgencyWithNIPRResponse"> & {};
|
|
2879
|
+
/**
|
|
2880
|
+
* Describes the message producerflow.producer.v1.StopSyncAgencyWithNIPRResponse.
|
|
2881
|
+
* Use `create(StopSyncAgencyWithNIPRResponseSchema)` to create a new message.
|
|
2882
|
+
*/
|
|
2883
|
+
export declare const StopSyncAgencyWithNIPRResponseSchema: GenMessage<StopSyncAgencyWithNIPRResponse>;
|
|
2884
|
+
/**
|
|
2885
|
+
* ListOrganizationsRequest requests a list of all organizations associated with the tenant.
|
|
2886
|
+
* This request requires no parameters and will return all organizations that
|
|
2887
|
+
* the authenticated tenant has access to.
|
|
2888
|
+
*
|
|
2889
|
+
* @generated from message producerflow.producer.v1.ListOrganizationsRequest
|
|
2890
|
+
*/
|
|
2891
|
+
export type ListOrganizationsRequest = Message<"producerflow.producer.v1.ListOrganizationsRequest"> & {};
|
|
2892
|
+
/**
|
|
2893
|
+
* Describes the message producerflow.producer.v1.ListOrganizationsRequest.
|
|
2894
|
+
* Use `create(ListOrganizationsRequestSchema)` to create a new message.
|
|
2895
|
+
*/
|
|
2896
|
+
export declare const ListOrganizationsRequestSchema: GenMessage<ListOrganizationsRequest>;
|
|
2897
|
+
/**
|
|
2898
|
+
* Organization represents a logical grouping or hierarchical structure within a tenant.
|
|
2899
|
+
* Organizations can be used to organize agencies into meaningful groups
|
|
2900
|
+
* such as agency networks, aggregators, or other business hierarchies.
|
|
2901
|
+
*
|
|
2902
|
+
* @generated from message producerflow.producer.v1.Organization
|
|
2903
|
+
*/
|
|
2904
|
+
export type Organization = Message<"producerflow.producer.v1.Organization"> & {
|
|
2905
|
+
/**
|
|
2906
|
+
* Unique identifier for the organization.
|
|
2907
|
+
* This is a UUID that can be used to reference the organization in other API calls.
|
|
2908
|
+
*
|
|
2909
|
+
* @generated from field: string id = 1;
|
|
2910
|
+
*/
|
|
2911
|
+
id: string;
|
|
2912
|
+
/**
|
|
2913
|
+
* Display name of the organization.
|
|
2914
|
+
* This is the human-readable name that identifies the organization to users.
|
|
2915
|
+
*
|
|
2916
|
+
* @generated from field: string name = 2;
|
|
2917
|
+
*/
|
|
2918
|
+
name: string;
|
|
2919
|
+
};
|
|
2920
|
+
/**
|
|
2921
|
+
* Describes the message producerflow.producer.v1.Organization.
|
|
2922
|
+
* Use `create(OrganizationSchema)` to create a new message.
|
|
2923
|
+
*/
|
|
2924
|
+
export declare const OrganizationSchema: GenMessage<Organization>;
|
|
2925
|
+
/**
|
|
2926
|
+
* ListOrganizationsResponse contains the list of organizations associated with the tenant.
|
|
2927
|
+
* The organizations are returned in no particular order. If the tenant has no organizations,
|
|
2928
|
+
* the organizations list will be empty.
|
|
2929
|
+
*
|
|
2930
|
+
* @generated from message producerflow.producer.v1.ListOrganizationsResponse
|
|
2931
|
+
*/
|
|
2932
|
+
export type ListOrganizationsResponse = Message<"producerflow.producer.v1.ListOrganizationsResponse"> & {
|
|
2933
|
+
/**
|
|
2934
|
+
* List of organizations associated with the tenant.
|
|
2935
|
+
* Each organization includes its unique identifier and display name.
|
|
2936
|
+
* The list may be empty if no organizations are associated with the tenant.
|
|
2937
|
+
*
|
|
2938
|
+
* @generated from field: repeated producerflow.producer.v1.Organization organizations = 1;
|
|
2939
|
+
*/
|
|
2940
|
+
organizations: Organization[];
|
|
2941
|
+
};
|
|
2942
|
+
/**
|
|
2943
|
+
* Describes the message producerflow.producer.v1.ListOrganizationsResponse.
|
|
2944
|
+
* Use `create(ListOrganizationsResponseSchema)` to create a new message.
|
|
2945
|
+
*/
|
|
2946
|
+
export declare const ListOrganizationsResponseSchema: GenMessage<ListOrganizationsResponse>;
|
|
2947
|
+
/**
|
|
2948
|
+
* EntityType defines the business entity type for an agency.
|
|
2949
|
+
*
|
|
2950
|
+
* @generated from enum producerflow.producer.v1.EntityType
|
|
2951
|
+
*/
|
|
2952
|
+
export declare enum EntityType {
|
|
2953
|
+
/**
|
|
2954
|
+
* Default unspecified value. Do not use.
|
|
2955
|
+
*
|
|
2956
|
+
* @generated from enum value: ENTITY_TYPE_UNSPECIFIED = 0;
|
|
2957
|
+
*/
|
|
2958
|
+
UNSPECIFIED = 0,
|
|
2959
|
+
/**
|
|
2960
|
+
* An individual producer operating as their own agency.
|
|
2961
|
+
* For this type, an agency NPN is not allowed, and additional producers are not supported.
|
|
2962
|
+
*
|
|
2963
|
+
* @generated from enum value: ENTITY_TYPE_SOLE_PROPRIETOR = 1;
|
|
2964
|
+
*/
|
|
2965
|
+
SOLE_PROPRIETOR = 1,
|
|
2966
|
+
/**
|
|
2967
|
+
* A standard insurance agency that can have multiple producers.
|
|
2968
|
+
* For this type, either NPN or FEIN is required.
|
|
2969
|
+
*
|
|
2970
|
+
* @generated from enum value: ENTITY_TYPE_AGENCY = 2;
|
|
2971
|
+
*/
|
|
2972
|
+
AGENCY = 2,
|
|
2973
|
+
/**
|
|
2974
|
+
* Ask during onboarding because the entity type is not known when the agency onboarding url is created.
|
|
2975
|
+
* The UI will ask the user to select the entity type.
|
|
2976
|
+
*
|
|
2977
|
+
* @generated from enum value: ENTITY_TYPE_ASK_DURING_ONBOARDING = 3;
|
|
2978
|
+
*/
|
|
2979
|
+
ASK_DURING_ONBOARDING = 3
|
|
2980
|
+
}
|
|
2981
|
+
/**
|
|
2982
|
+
* Describes the enum producerflow.producer.v1.EntityType.
|
|
2983
|
+
*/
|
|
2984
|
+
export declare const EntityTypeSchema: GenEnum<EntityType>;
|
|
2985
|
+
/**
|
|
2986
|
+
* ProducerOnboardingState defines the possible states in the producer onboarding workflow.
|
|
2987
|
+
* This enum is deprecated and should not be used in new code.
|
|
2988
|
+
*
|
|
2989
|
+
* @generated from enum producerflow.producer.v1.ProducerOnboardingState
|
|
2990
|
+
* @deprecated
|
|
2991
|
+
*/
|
|
2992
|
+
export declare enum ProducerOnboardingState {
|
|
2993
|
+
/**
|
|
2994
|
+
* @generated from enum value: PRODUCER_ONBOARDING_STATE_UNSPECIFIED = 0;
|
|
2995
|
+
*/
|
|
2996
|
+
UNSPECIFIED = 0,
|
|
2997
|
+
/**
|
|
2998
|
+
* The producer has been added to the agency and is awaiting approval from the tenant.
|
|
2999
|
+
*
|
|
3000
|
+
* @generated from enum value: PRODUCER_ONBOARDING_STATE_NEW = 1;
|
|
3001
|
+
*/
|
|
3002
|
+
NEW = 1,
|
|
3003
|
+
/**
|
|
3004
|
+
* The producer has been approved by the tenant.
|
|
3005
|
+
*
|
|
3006
|
+
* @generated from enum value: PRODUCER_ONBOARDING_STATE_APPROVED_BY_TENANT = 2;
|
|
3007
|
+
*/
|
|
3008
|
+
APPROVED_BY_TENANT = 2,
|
|
3009
|
+
/**
|
|
3010
|
+
* The producer has been rejected by the tenant.
|
|
3011
|
+
*
|
|
3012
|
+
* @generated from enum value: PRODUCER_ONBOARDING_STATE_REJECTED_BY_TENANT = 3;
|
|
3013
|
+
*/
|
|
3014
|
+
REJECTED_BY_TENANT = 3
|
|
3015
|
+
}
|
|
3016
|
+
/**
|
|
3017
|
+
* Describes the enum producerflow.producer.v1.ProducerOnboardingState.
|
|
3018
|
+
* @deprecated
|
|
3019
|
+
*/
|
|
3020
|
+
export declare const ProducerOnboardingStateSchema: GenEnum<ProducerOnboardingState>;
|
|
3021
|
+
/**
|
|
3022
|
+
* ProducerService provides a comprehensive API for managing insurance producers
|
|
3023
|
+
* and agencies, including onboarding, data synchronization, and integration with
|
|
3024
|
+
* external systems like NIPR for license verification.
|
|
3025
|
+
*
|
|
3026
|
+
* RPCs for starting the onboarding agency process.
|
|
3027
|
+
*
|
|
3028
|
+
* @generated from service producerflow.producer.v1.ProducerService
|
|
3029
|
+
*/
|
|
3030
|
+
export declare const ProducerService: GenService<{
|
|
3031
|
+
/**
|
|
3032
|
+
* CreateAgencyOnboardingURL generates a URL that can be used to onboard a new agency.
|
|
3033
|
+
* The URL contains encoded information about the agency defaults and tenant context.
|
|
3034
|
+
* All fields in the request are optional - you can provide as much or as little
|
|
3035
|
+
* information as available. Any missing information will be collected during
|
|
3036
|
+
* the onboarding process.
|
|
3037
|
+
* Returns a URL string that can be shared with the agency for self-onboarding.
|
|
3038
|
+
*
|
|
3039
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.CreateAgencyOnboardingURL
|
|
3040
|
+
*/
|
|
3041
|
+
createAgencyOnboardingURL: {
|
|
3042
|
+
methodKind: "unary";
|
|
3043
|
+
input: typeof CreateAgencyOnboardingURLRequestSchema;
|
|
3044
|
+
output: typeof CreateAgencyOnboardingURLResponseSchema;
|
|
3045
|
+
};
|
|
3046
|
+
/**
|
|
3047
|
+
* NewAgency creates a new agency, optionally with associated producers.
|
|
3048
|
+
* It performs the following validation checks:
|
|
3049
|
+
* - Ensures all required fields are present and valid
|
|
3050
|
+
* - Checks whether the NPN is already registered
|
|
3051
|
+
* - Verifies agency and principal information with NIPR
|
|
3052
|
+
*
|
|
3053
|
+
* Business rules:
|
|
3054
|
+
* - Sole proprietors can't have an agency NPN or additional producers
|
|
3055
|
+
* - Regular agencies must provide either an NPN or a FEIN
|
|
3056
|
+
*
|
|
3057
|
+
* If validation passes, it creates the agency, principal, and any producers.
|
|
3058
|
+
* Returns the IDs of the created agency, principal, and producers.
|
|
3059
|
+
*
|
|
3060
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.NewAgency
|
|
3061
|
+
*/
|
|
3062
|
+
newAgency: {
|
|
3063
|
+
methodKind: "unary";
|
|
3064
|
+
input: typeof NewAgencyRequestSchema;
|
|
3065
|
+
output: typeof NewAgencyResponseSchema;
|
|
3066
|
+
};
|
|
3067
|
+
/**
|
|
3068
|
+
* ListOrganizations returns a list of organizations associated with the tenant.
|
|
3069
|
+
* Organizations represent logical groupings or hierarchical structures within a tenant
|
|
3070
|
+
* that can be used to organize agencies and producers.
|
|
3071
|
+
*
|
|
3072
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.ListOrganizations
|
|
3073
|
+
*/
|
|
3074
|
+
listOrganizations: {
|
|
3075
|
+
methodKind: "unary";
|
|
3076
|
+
input: typeof ListOrganizationsRequestSchema;
|
|
3077
|
+
output: typeof ListOrganizationsResponseSchema;
|
|
3078
|
+
};
|
|
3079
|
+
/**
|
|
3080
|
+
* NewProducer creates a new producer and associates them with an existing agency.
|
|
3081
|
+
* It validates the producer's information and checks that the email is unique.
|
|
3082
|
+
* Returns the ID of the created producer.
|
|
3083
|
+
*
|
|
3084
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.NewProducer
|
|
3085
|
+
*/
|
|
3086
|
+
newProducer: {
|
|
3087
|
+
methodKind: "unary";
|
|
3088
|
+
input: typeof NewProducerRequestSchema;
|
|
3089
|
+
output: typeof NewProducerResponseSchema;
|
|
3090
|
+
};
|
|
3091
|
+
/**
|
|
3092
|
+
* NewProducers creates multiple producers and associates them with the specified agency.
|
|
3093
|
+
* It performs the same validations as NewProducer for each entry.
|
|
3094
|
+
* Returns the IDs of all created producers.
|
|
3095
|
+
*
|
|
3096
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.NewProducers
|
|
3097
|
+
*/
|
|
3098
|
+
newProducers: {
|
|
3099
|
+
methodKind: "unary";
|
|
3100
|
+
input: typeof NewProducersRequestSchema;
|
|
3101
|
+
output: typeof NewProducersResponseSchema;
|
|
3102
|
+
};
|
|
3103
|
+
/**
|
|
3104
|
+
* GetAgencyAndProducers retrieves details for an agency and all associated producers.
|
|
3105
|
+
* Returns the agency information and a list of producers.
|
|
3106
|
+
*
|
|
3107
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.GetAgencyAndProducers
|
|
3108
|
+
*/
|
|
3109
|
+
getAgencyAndProducers: {
|
|
3110
|
+
methodKind: "unary";
|
|
3111
|
+
input: typeof GetAgencyAndProducersRequestSchema;
|
|
3112
|
+
output: typeof GetAgencyAndProducersResponseSchema;
|
|
3113
|
+
};
|
|
3114
|
+
/**
|
|
3115
|
+
* GetProducer retrieves detailed information about a specific producer.
|
|
3116
|
+
* The producer can be found by ID, NPN, or email.
|
|
3117
|
+
* Returns the producer's information, including NIPR data and agency association.
|
|
3118
|
+
*
|
|
3119
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.GetProducer
|
|
3120
|
+
*/
|
|
3121
|
+
getProducer: {
|
|
3122
|
+
methodKind: "unary";
|
|
3123
|
+
input: typeof GetProducerRequestSchema;
|
|
3124
|
+
output: typeof GetProducerResponseSchema;
|
|
3125
|
+
};
|
|
3126
|
+
/**
|
|
3127
|
+
* GetAgencyFiles returns URLs for accessing files associated with an agency, such as contracts.
|
|
3128
|
+
*
|
|
3129
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.GetAgencyFiles
|
|
3130
|
+
*/
|
|
3131
|
+
getAgencyFiles: {
|
|
3132
|
+
methodKind: "unary";
|
|
3133
|
+
input: typeof GetAgencyFilesRequestSchema;
|
|
3134
|
+
output: typeof GetAgencyFilesResponseSchema;
|
|
3135
|
+
};
|
|
3136
|
+
/**
|
|
3137
|
+
* UpdateProducer updates information for an existing producer.
|
|
3138
|
+
* Supports updating contact details, background check responses,
|
|
3139
|
+
* employment history, and non-uniform licensing questions.
|
|
3140
|
+
* Information from NIPR and other third-party sources cannot be updated.
|
|
3141
|
+
* Validates email uniqueness if the email is changed.
|
|
3142
|
+
*
|
|
3143
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.UpdateProducer
|
|
3144
|
+
*/
|
|
3145
|
+
updateProducer: {
|
|
3146
|
+
methodKind: "unary";
|
|
3147
|
+
input: typeof UpdateProducerRequestSchema;
|
|
3148
|
+
output: typeof UpdateProducerResponseSchema;
|
|
3149
|
+
};
|
|
3150
|
+
/**
|
|
3151
|
+
* ApproveProducer changes a producer's onboarding state to APPROVED.
|
|
3152
|
+
* This typically happens after all verification steps are complete.
|
|
3153
|
+
* This method is deprecated. Use SyncProducerWithNIPR instead.
|
|
3154
|
+
*
|
|
3155
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.ApproveProducer
|
|
3156
|
+
* @deprecated
|
|
3157
|
+
*/
|
|
3158
|
+
approveProducer: {
|
|
3159
|
+
methodKind: "unary";
|
|
3160
|
+
input: typeof ApproveProducerRequestSchema;
|
|
3161
|
+
output: typeof ApproveProducerResponseSchema;
|
|
3162
|
+
};
|
|
3163
|
+
/**
|
|
3164
|
+
* RejectProducer changes a producer's onboarding state to REJECTED.
|
|
3165
|
+
* An optional reason for rejection can be provided.
|
|
3166
|
+
* This method is deprecated. Use StopSyncAgencyWithNIPR instead.
|
|
3167
|
+
*
|
|
3168
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.RejectProducer
|
|
3169
|
+
* @deprecated
|
|
3170
|
+
*/
|
|
3171
|
+
rejectProducer: {
|
|
3172
|
+
methodKind: "unary";
|
|
3173
|
+
input: typeof RejectProducerRequestSchema;
|
|
3174
|
+
output: typeof RejectProducerResponseSchema;
|
|
3175
|
+
};
|
|
3176
|
+
/**
|
|
3177
|
+
* NewContact creates a new contact associated with an agency.
|
|
3178
|
+
* Contacts represent non-producer individuals linked to the agency.
|
|
3179
|
+
* Returns the ID of the created contact.
|
|
3180
|
+
*
|
|
3181
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.NewContact
|
|
3182
|
+
*/
|
|
3183
|
+
newContact: {
|
|
3184
|
+
methodKind: "unary";
|
|
3185
|
+
input: typeof NewContactRequestSchema;
|
|
3186
|
+
output: typeof NewContactResponseSchema;
|
|
3187
|
+
};
|
|
3188
|
+
/**
|
|
3189
|
+
* NewContacts creates multiple contacts in a single request.
|
|
3190
|
+
* Each contact is associated with the specified agency.
|
|
3191
|
+
* Returns the IDs of all created contacts.
|
|
3192
|
+
*
|
|
3193
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.NewContacts
|
|
3194
|
+
*/
|
|
3195
|
+
newContacts: {
|
|
3196
|
+
methodKind: "unary";
|
|
3197
|
+
input: typeof NewContactsRequestSchema;
|
|
3198
|
+
output: typeof NewContactsResponseSchema;
|
|
3199
|
+
};
|
|
3200
|
+
/**
|
|
3201
|
+
* SetExternalID sets an external identifier for a producer or contact.
|
|
3202
|
+
* Useful for integrating with external systems that use different ID schemes.
|
|
3203
|
+
*
|
|
3204
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.SetExternalID
|
|
3205
|
+
*/
|
|
3206
|
+
setExternalID: {
|
|
3207
|
+
methodKind: "unary";
|
|
3208
|
+
input: typeof SetExternalIDRequestSchema;
|
|
3209
|
+
output: typeof SetExternalIDResponseSchema;
|
|
3210
|
+
};
|
|
3211
|
+
/**
|
|
3212
|
+
* ValidateProducerNPN checks whether a producer’s National Producer Number (NPN) is valid.
|
|
3213
|
+
* It performs a lookup against NIPR and applies internal validation rules.
|
|
3214
|
+
* Returns a validity flag and any associated error messages.
|
|
3215
|
+
*
|
|
3216
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.ValidateProducerNPN
|
|
3217
|
+
*/
|
|
3218
|
+
validateProducerNPN: {
|
|
3219
|
+
methodKind: "unary";
|
|
3220
|
+
input: typeof ValidateProducerNPNRequestSchema;
|
|
3221
|
+
output: typeof ValidateProducerNPNResponseSchema;
|
|
3222
|
+
};
|
|
3223
|
+
/**
|
|
3224
|
+
* ValidateAgencyNPN checks whether an agency’s National Producer Number (NPN) is valid.
|
|
3225
|
+
* It performs a lookup against NIPR and applies internal validation rules.
|
|
3226
|
+
* Returns a validity flag and any associated error messages.
|
|
3227
|
+
*
|
|
3228
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.ValidateAgencyNPN
|
|
3229
|
+
*/
|
|
3230
|
+
validateAgencyNPN: {
|
|
3231
|
+
methodKind: "unary";
|
|
3232
|
+
input: typeof ValidateAgencyNPNRequestSchema;
|
|
3233
|
+
output: typeof ValidateAgencyNPNResponseSchema;
|
|
3234
|
+
};
|
|
3235
|
+
/**
|
|
3236
|
+
* LookupNPNByFEIN finds an NPN using a Federal Employer Identification Number.
|
|
3237
|
+
* Used to help agencies that know their FEIN but not their NPN.
|
|
3238
|
+
* Returns the NPN if found or an error message.
|
|
3239
|
+
*
|
|
3240
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.LookupNPNByFEIN
|
|
3241
|
+
*/
|
|
3242
|
+
lookupNPNByFEIN: {
|
|
3243
|
+
methodKind: "unary";
|
|
3244
|
+
input: typeof LookupNPNByFEINRequestSchema;
|
|
3245
|
+
output: typeof LookupNPNByFEINResponseSchema;
|
|
3246
|
+
};
|
|
3247
|
+
/**
|
|
3248
|
+
* ResyncProducer triggers a manual resynchronization of a producer’s data.
|
|
3249
|
+
* This can be used to refresh data after external changes.
|
|
3250
|
+
*
|
|
3251
|
+
* WARNING: This call counts as an additional NPN lookup for billing purposes.
|
|
3252
|
+
* Most billing plans are based on unique NPNs per month, so using this
|
|
3253
|
+
* method may result in extra charges.
|
|
3254
|
+
*
|
|
3255
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.ResyncProducer
|
|
3256
|
+
*/
|
|
3257
|
+
resyncProducer: {
|
|
3258
|
+
methodKind: "unary";
|
|
3259
|
+
input: typeof ResyncProducerRequestSchema;
|
|
3260
|
+
output: typeof ResyncProducerResponseSchema;
|
|
3261
|
+
};
|
|
3262
|
+
/**
|
|
3263
|
+
* ResyncAgency triggers a manual resynchronization of an agency’s data.
|
|
3264
|
+
* Similar to ResyncProducer, this can be used to refresh data after external changes.
|
|
3265
|
+
*
|
|
3266
|
+
* WARNING: This call counts as an additional NPN lookup for billing purposes.
|
|
3267
|
+
* Most billing plans are based on unique NPNs per month, so using this
|
|
3268
|
+
* method may result in extra charges.
|
|
3269
|
+
*
|
|
3270
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.ResyncAgency
|
|
3271
|
+
*/
|
|
3272
|
+
resyncAgency: {
|
|
3273
|
+
methodKind: "unary";
|
|
3274
|
+
input: typeof ResyncAgencyRequestSchema;
|
|
3275
|
+
output: typeof ResyncAgencyResponseSchema;
|
|
3276
|
+
};
|
|
3277
|
+
/**
|
|
3278
|
+
* SyncAgencyWithNIPR synchronizes an producer’s data with the NIPR system.
|
|
3279
|
+
* Fetches the latest producer information and appointments.
|
|
3280
|
+
*
|
|
3281
|
+
* WARNING: This call counts as an extra NPN lookup against your billing.
|
|
3282
|
+
* Most billing plans are based on unique NPNs per month, so using this
|
|
3283
|
+
* method may result in additional charges.
|
|
3284
|
+
*
|
|
3285
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.SyncProducerWithNIPR
|
|
3286
|
+
*/
|
|
3287
|
+
syncProducerWithNIPR: {
|
|
3288
|
+
methodKind: "unary";
|
|
3289
|
+
input: typeof SyncProducerWithNIPRRequestSchema;
|
|
3290
|
+
output: typeof SyncProducerWithNIPRResponseSchema;
|
|
3291
|
+
};
|
|
3292
|
+
/**
|
|
3293
|
+
* SyncAgencyWithNIPR synchronizes an agency’s data with the NIPR system.
|
|
3294
|
+
* Fetches the latest agency information and appointments.
|
|
3295
|
+
*
|
|
3296
|
+
* WARNING: This call counts as an extra NPN lookup against your billing.
|
|
3297
|
+
* Most billing plans are based on unique NPNs per month, so using this
|
|
3298
|
+
* method may result in additional charges.
|
|
3299
|
+
*
|
|
3300
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.SyncAgencyWithNIPR
|
|
3301
|
+
*/
|
|
3302
|
+
syncAgencyWithNIPR: {
|
|
3303
|
+
methodKind: "unary";
|
|
3304
|
+
input: typeof SyncAgencyWithNIPRRequestSchema;
|
|
3305
|
+
output: typeof SyncAgencyWithNIPRResponseSchema;
|
|
3306
|
+
};
|
|
3307
|
+
/**
|
|
3308
|
+
* StopSyncProducerWithNIPR stops the synchronization process with NIPR for a producer.
|
|
3309
|
+
* Use this to prevent further automatic updates from NIPR.
|
|
3310
|
+
*
|
|
3311
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.StopSyncProducerWithNIPR
|
|
3312
|
+
*/
|
|
3313
|
+
stopSyncProducerWithNIPR: {
|
|
3314
|
+
methodKind: "unary";
|
|
3315
|
+
input: typeof StopSyncProducerWithNIPRRequestSchema;
|
|
3316
|
+
output: typeof StopSyncProducerWithNIPRResponseSchema;
|
|
3317
|
+
};
|
|
3318
|
+
/**
|
|
3319
|
+
* StopSyncAgencyWithNIPR stops the synchronization process with NIPR for an agency.
|
|
3320
|
+
* Use this to prevent further automatic updates from NIPR.
|
|
3321
|
+
*
|
|
3322
|
+
* @generated from rpc producerflow.producer.v1.ProducerService.StopSyncAgencyWithNIPR
|
|
3323
|
+
*/
|
|
3324
|
+
stopSyncAgencyWithNIPR: {
|
|
3325
|
+
methodKind: "unary";
|
|
3326
|
+
input: typeof StopSyncAgencyWithNIPRRequestSchema;
|
|
3327
|
+
output: typeof StopSyncAgencyWithNIPRResponseSchema;
|
|
3328
|
+
};
|
|
3329
|
+
}>;
|