@producerflow/producerflowapi 0.0.11 → 0.0.13

package/dist/producerflow/producer/v1/producer_pb.d.ts

@@ -7,6 +7,34 @@ import type { Message } from "@bufbuild/protobuf";
  * Describes the file producerflow/producer/v1/producer.proto.
  */
 export declare const file_producerflow_producer_v1_producer: GenFile;
+/**
+ * Pagination provides page token and page size for paginating list results.
+ *
+ * @generated from message producerflow.producer.v1.Pagination
+ */
+export type Pagination = Message<"producerflow.producer.v1.Pagination"> & {
+    /**
+     * The maximum number of items to return. The service may return fewer than this value.
+     * If unspecified, at most 50 items will be returned.
+     * The maximum value is 200; values above 200 will be rejected.
+     *
+     * @generated from field: int32 page_size = 1;
+     */
+    pageSize: number;
+    /**
+     * A page token, received from a previous list call.
+     * Provide this to retrieve the subsequent page.
+     * When paginating, all other parameters must match the call that provided the page token.
+     *
+     * @generated from field: string page_token = 2;
+     */
+    pageToken: string;
+};
+/**
+ * Describes the message producerflow.producer.v1.Pagination.
+ * Use `create(PaginationSchema)` to create a new message.
+ */
+export declare const PaginationSchema: GenMessage<Pagination>;
 /**
  * Address represents a physical location with standard address components.
  * Used for mailing, physical, and invoicing addresses throughout the API.
@@ -182,7 +210,18 @@ export declare const CreateAgencyOnboardingURLRequest_AgencySchema: GenMessage<C
  */
 export type CreateAgencyOnboardingURLRequest_Agency_Principal = Message<"producerflow.producer.v1.CreateAgencyOnboardingURLRequest.Agency.Principal"> & {
     /**
-     * Tenant ID of the principal
+     * Optional. External identifier for the principal in the tenant's system.
+     * This field allows tenants to maintain a reference to their own internal ID
+     * for this principal, enabling bi-directional synchronization between ProducerFlow
+     * and the tenant's system.
+     *
+     * Usage:
+     * - Provide this when you have an existing identifier for the principal in your system
+     * - Omit if you don't need to track a reference to your internal system
+     * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
+     *
+     * Format: Any string identifier that is meaningful in your system (e.g., "USR-12345", "uuid")
+     * Validation: Maximum length of 255 characters
      *
      * @generated from field: string tenant_id = 1;
      */
@@ -253,6 +292,124 @@ export type CreateAgencyOnboardingURLResponse = Message<"producerflow.producer.v
  * Use `create(CreateAgencyOnboardingURLResponseSchema)` to create a new message.
  */
 export declare const CreateAgencyOnboardingURLResponseSchema: GenMessage<CreateAgencyOnboardingURLResponse>;
+/**
+ * @generated from message producerflow.producer.v1.CreateProducerOnboardingURLRequest
+ */
+export type CreateProducerOnboardingURLRequest = Message<"producerflow.producer.v1.CreateProducerOnboardingURLRequest"> & {
+    /**
+     * Agency ID for which the producer will be onboarded
+     *
+     * @generated from field: string agency_id = 1;
+     */
+    agencyId: string;
+    /**
+     * Optional producer data to pre-fill in the onboarding form
+     *
+     * @generated from field: producerflow.producer.v1.ProducerData producer_data = 2;
+     */
+    producerData?: ProducerData;
+};
+/**
+ * Describes the message producerflow.producer.v1.CreateProducerOnboardingURLRequest.
+ * Use `create(CreateProducerOnboardingURLRequestSchema)` to create a new message.
+ */
+export declare const CreateProducerOnboardingURLRequestSchema: GenMessage<CreateProducerOnboardingURLRequest>;
+/**
+ * @generated from message producerflow.producer.v1.ProducerData
+ */
+export type ProducerData = Message<"producerflow.producer.v1.ProducerData"> & {
+    /**
+     * @generated from field: optional string npn = 1;
+     */
+    npn?: string;
+    /**
+     * First name of the producer
+     *
+     * @generated from field: optional string first_name = 2;
+     */
+    firstName?: string;
+    /**
+     * Last name of the producer
+     *
+     * @generated from field: optional string last_name = 3;
+     */
+    lastName?: string;
+    /**
+     * Middle name of the producer
+     *
+     * @generated from field: optional string middle_name = 4;
+     */
+    middleName?: string;
+    /**
+     * Email address of the producer
+     *
+     * @generated from field: optional string email = 5;
+     */
+    email?: string;
+    /**
+     * Phone number of the producer
+     *
+     * @generated from field: optional string phone = 6;
+     */
+    phone?: string;
+    /**
+     * Mailing address of the producer
+     *
+     * @generated from field: producerflow.producer.v1.ProducerData.Address mailing_address = 7;
+     */
+    mailingAddress?: ProducerData_Address;
+};
+/**
+ * Describes the message producerflow.producer.v1.ProducerData.
+ * Use `create(ProducerDataSchema)` to create a new message.
+ */
+export declare const ProducerDataSchema: GenMessage<ProducerData>;
+/**
+ * @generated from message producerflow.producer.v1.ProducerData.Address
+ */
+export type ProducerData_Address = Message<"producerflow.producer.v1.ProducerData.Address"> & {
+    /**
+     * @generated from field: string street = 1;
+     */
+    street: string;
+    /**
+     * @generated from field: string city = 2;
+     */
+    city: string;
+    /**
+     * @generated from field: string state = 3;
+     */
+    state: string;
+    /**
+     * @generated from field: string zip = 4;
+     */
+    zip: string;
+    /**
+     * @generated from field: string country = 5;
+     */
+    country: string;
+};
+/**
+ * Describes the message producerflow.producer.v1.ProducerData.Address.
+ * Use `create(ProducerData_AddressSchema)` to create a new message.
+ */
+export declare const ProducerData_AddressSchema: GenMessage<ProducerData_Address>;
+/**
+ * @generated from message producerflow.producer.v1.CreateProducerOnboardingURLResponse
+ */
+export type CreateProducerOnboardingURLResponse = Message<"producerflow.producer.v1.CreateProducerOnboardingURLResponse"> & {
+    /**
+     * The secure onboarding URL that can be shared with the producer
+     *
+     * @generated from field: string onboarding_url = 1;
+     */
+    onboardingUrl: string;
+};
+/**
+ * Describes the message producerflow.producer.v1.CreateProducerOnboardingURLResponse.
+ * Use `create(CreateProducerOnboardingURLResponseSchema)` to create a new message.
+ */
+export declare const CreateProducerOnboardingURLResponseSchema: GenMessage<CreateProducerOnboardingURLResponse>;
 /**
  * NewAgencyRequest contains complete information for creating a new agency
  *
@@ -463,9 +620,30 @@ export type NewAgencyRequest_Agency_Principal = Message<"producerflow.producer.v
      */
     npn: string;
     /**
+     * Optional. External identifier for the principal in the tenant's system.
+     * This field allows tenants to maintain a reference to their own internal ID
+     * for this principal, enabling bi-directional synchronization between ProducerFlow
+     * and the tenant's system.
+     *
+     * Usage:
+     * - Provide this when you have an existing identifier for the principal in your system
+     * - Omit if you don't need to track a reference to your internal system
+     * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
+     *
+     * Format: Any string identifier that is meaningful in your system (e.g., "USR-12345", "uuid")
+     * Validation: Maximum length of 255 characters
+     *
      * @generated from field: string tenant_id = 6;
      */
     tenantId: string;
+    /**
+     * Optional. Controls whether the principal should be validated and synced with NIPR.
+     * If set to false, the principal's NPN will not be validated against NIPR and the
+     * principal will not be synced with NIPR. Defaults to true if not specified.
+     *
+     * @generated from field: optional bool sync_with_nipr = 7;
+     */
+    syncWithNipr?: boolean;
 };
 /**
  * Describes the message producerflow.producer.v1.NewAgencyRequest.Agency.Principal.
@@ -2789,7 +2967,6 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
     email: string;
     /**
      * National Producer Number (NPN) of the producer.
-     * Optional, but recommended for license verification.
      *
      * @generated from field: string npn = 4;
      */
@@ -2809,8 +2986,24 @@ export type NewProducer = Message<"producerflow.producer.v1.NewProducer"> & {
      */
     mailingAddress?: NewProducer_Address;
     /**
-     * External tenant identifier for the producer.
-     * Used for integration with external systems.
+     * Optional. External identifier for the producer in the tenant's system.
+     * This field allows tenants to maintain a reference to their own internal ID
+     * for this producer, enabling bi-directional synchronization between ProducerFlow
+     * and the tenant's system.
+     *
+     * Usage:
+     * - Provide this when you have an existing identifier for the producer in your system
+     * - Omit if you don't need to track a reference to your internal system
+     * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
+     * - Can be used with SetExternalID RPC to update this value after creation
+     *
+     * Common use cases:
+     * - Linking to an existing CRM or AMS system producer ID
+     * - Maintaining synchronization with legacy systems
+     * - Enabling lookups from external systems back to ProducerFlow
+     *
+     * Format: Any string identifier that is meaningful in your system (e.g., "PROD-12345", "uuid")
+     * Validation: Maximum length of 255 characters
      *
      * @generated from field: string tenant_id = 8;
      */
@@ -3047,8 +3240,24 @@ export type NewContact = Message<"producerflow.producer.v1.NewContact"> & {
      */
     role: string;
     /**
-     * External tenant identifier for the contact.
-     * Used for integration with external systems.
+     * Optional. External identifier for the contact in the tenant's system.
+     * This field allows tenants to maintain a reference to their own internal ID
+     * for this contact, enabling bi-directional synchronization between ProducerFlow
+     * and the tenant's system.
+     *
+     * Usage:
+     * - Provide this when you have an existing identifier for the contact in your system
+     * - Omit if you don't need to track a reference to your internal system
+     * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
+     * - Can be used with SetExternalID RPC to update this value after creation
+     *
+     * Common use cases:
+     * - Linking to an existing CRM or AMS system contact ID
+     * - Maintaining synchronization with legacy systems
+     * - Enabling lookups from external systems back to ProducerFlow
+     *
+     * Format: Any string identifier that is meaningful in your system (e.g., "CONT-12345", "uuid")
+     * Validation: Maximum length of 255 characters
      *
      * @generated from field: string tenant_id = 8;
      */
@@ -3244,8 +3453,33 @@ export type SetExternalIDRequest = Message<"producerflow.producer.v1.SetExternal
         value?: undefined;
     };
     /**
-     * The external tenant identifier to associate with the entity.
-     * Required and must be non-empty.
+     * External identifier to associate with the entity in the tenant's system.
+     * This field allows tenants to maintain a reference to their own internal ID
+     * for the specified entity (producer, agency, contact, or organization), enabling
+     * bi-directional synchronization between ProducerFlow and the tenant's system.
+     *
+     * Purpose:
+     * - Links ProducerFlow entities to corresponding entities in external systems
+     * - Enables lookups and synchronization across systems
+     * - Maintains referential integrity with tenant's internal databases
+     *
+     * Usage:
+     * - Call this RPC after creating an entity if you need to add or update the external reference
+     * - This can also be provided during entity creation for producers and contacts
+     * - This is independent of ProducerFlow's internal IDs and the authentication tenant context
+     *
+     * Relationship to authentication:
+     * - The tenant context is determined by the API key used for authentication
+     * - This tenant_id field is purely for storing the tenant's own external identifier
+     * - Multiple tenants cannot share the same entity; each tenant has their own isolated data
+     *
+     * Common use cases:
+     * - Syncing with CRM systems (e.g., Salesforce IDs, HubSpot IDs)
+     * - Integrating with AMS platforms (e.g., Applied Epic, Vertafore)
+     * - Maintaining references to legacy system identifiers
+     *
+     * Format: Any string identifier that is meaningful in your system (e.g., "SF-001234", "LEGACY-9876")
+     * Validation: Must be non-empty, maximum length of 255 characters
      *
      * @generated from field: string tenant_id = 4;
      */
@@ -3582,6 +3816,166 @@ export type StopSyncAgencyWithNIPRResponse = Message<"producerflow.producer.v1.S
  * Use `create(StopSyncAgencyWithNIPRResponseSchema)` to create a new message.
  */
 export declare const StopSyncAgencyWithNIPRResponseSchema: GenMessage<StopSyncAgencyWithNIPRResponse>;
+/**
+ * AgencySummary contains a lightweight summary of an agency for list views.
+ * This message contains only the essential fields needed for displaying agencies in a list.
+ *
+ * @generated from message producerflow.producer.v1.AgencySummary
+ */
+export type AgencySummary = Message<"producerflow.producer.v1.AgencySummary"> & {
+    /**
+     * Unique identifier for the agency.
+     *
+     * @generated from field: string agency_id = 1;
+     */
+    agencyId: string;
+    /**
+     * Agency name.
+     *
+     * @generated from field: string name = 2;
+     */
+    name: string;
+    /**
+     * Agency email address.
+     *
+     * @generated from field: string email = 3;
+     */
+    email: string;
+    /**
+     * Agency phone number.
+     *
+     * @generated from field: string phone = 4;
+     */
+    phone: string;
+    /**
+     * Agency NPN (National Producer Number).
+     *
+     * @generated from field: string npn = 5;
+     */
+    npn: string;
+    /**
+     * Agency FEIN (Federal Employer Identification Number).
+     *
+     * @generated from field: string fein = 6;
+     */
+    fein: string;
+    /**
+     * Organization ID that the agency belongs to.
+     *
+     * @generated from field: optional string organization_id = 7;
+     */
+    organizationId?: string;
+    /**
+     * Whether this is an internal tenant agency.
+     *
+     * @generated from field: bool is_tenant_agency = 8;
+     */
+    isTenantAgency: boolean;
+    /**
+     * Whether this is a sole proprietor.
+     *
+     * @generated from field: bool is_sole_proprietor = 9;
+     */
+    isSoleProprietor: boolean;
+    /**
+     * When the agency was created.
+     *
+     * @generated from field: google.protobuf.Timestamp created_at = 10;
+     */
+    createdAt?: Timestamp;
+};
+/**
+ * Describes the message producerflow.producer.v1.AgencySummary.
+ * Use `create(AgencySummarySchema)` to create a new message.
+ */
+export declare const AgencySummarySchema: GenMessage<AgencySummary>;
+/**
+ * ListAgenciesRequest requests a list of agencies associated with the tenant.
+ * Supports optional filtering and pagination parameters.
+ *
+ * @generated from message producerflow.producer.v1.ListAgenciesRequest
+ */
+export type ListAgenciesRequest = Message<"producerflow.producer.v1.ListAgenciesRequest"> & {
+    /**
+     * Optional. Filter agencies by organization ID.
+     * If provided, only agencies belonging to this organization will be returned.
+     *
+     * @generated from field: optional string organization_id = 1;
+     */
+    organizationId?: string;
+    /**
+     * Optional. Search query to filter agencies by name, NPN, or email.
+     * If provided, only agencies matching the search query will be returned.
+     *
+     * @generated from field: optional string search_query = 2;
+     */
+    searchQuery?: string;
+    /**
+     * Optional. Pagination parameters.
+     * If not provided, defaults to page_size=50.
+     *
+     * @generated from field: producerflow.producer.v1.Pagination pagination = 3;
+     */
+    pagination?: Pagination;
+    /**
+     * Optional. Filter by agency type (internal vs external).
+     * If not provided, returns all agencies regardless of type.
+     *
+     * @generated from field: optional producerflow.producer.v1.AgencyType agency_type = 4;
+     */
+    agencyType?: AgencyType;
+    /**
+     * Optional. Filter by entity type (sole proprietor vs agency).
+     * If not provided, returns all agencies regardless of entity type.
+     *
+     * @generated from field: optional producerflow.producer.v1.EntityType entity_type = 5;
+     */
+    entityType?: EntityType;
+    /**
+     * Optional. Filter by NIPR sync status.
+     * If not provided, returns all agencies regardless of sync status.
+     *
+     * @generated from field: repeated producerflow.producer.v1.NIPRSyncState nipr_sync_statuses = 6;
+     */
+    niprSyncStatuses: NIPRSyncState[];
+};
+/**
+ * Describes the message producerflow.producer.v1.ListAgenciesRequest.
+ * Use `create(ListAgenciesRequestSchema)` to create a new message.
+ */
+export declare const ListAgenciesRequestSchema: GenMessage<ListAgenciesRequest>;
+/**
+ * ListAgenciesResponse contains the list of agencies matching the filter criteria.
+ *
+ * @generated from message producerflow.producer.v1.ListAgenciesResponse
+ */
+export type ListAgenciesResponse = Message<"producerflow.producer.v1.ListAgenciesResponse"> & {
+    /**
+     * List of agency summaries matching the filter criteria.
+     * The agencies are ordered by creation date, most recent first.
+     *
+     * @generated from field: repeated producerflow.producer.v1.AgencySummary agencies = 1;
+     */
+    agencies: AgencySummary[];
+    /**
+     * A token that can be sent as `page_token` to retrieve the next page.
+     * If this field is omitted, there are no subsequent pages.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken: string;
+    /**
+     * Total number of agencies matching the filter criteria.
+     *
+     * @generated from field: int32 total_count = 3;
+     */
+    totalCount: number;
+};
+/**
+ * Describes the message producerflow.producer.v1.ListAgenciesResponse.
+ * Use `create(ListAgenciesResponseSchema)` to create a new message.
+ */
+export declare const ListAgenciesResponseSchema: GenMessage<ListAgenciesResponse>;
 /**
  * ListOrganizationsRequest requests a list of all organizations associated with the tenant.
  * This request requires no parameters  and will return all organizations that
@@ -4097,6 +4491,76 @@ export declare enum EntityType {
  * Describes the enum producerflow.producer.v1.EntityType.
  */
 export declare const EntityTypeSchema: GenEnum<EntityType>;
+/**
+ * AgencyType defines whether an agency is internal (tenant agency) or external.
+ *
+ * @generated from enum producerflow.producer.v1.AgencyType
+ */
+export declare enum AgencyType {
+    /**
+     * Default unspecified value. Do not use.
+     *
+     * @generated from enum value: AGENCY_TYPE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Internal agencies are the agencies that are tenant agencies.
+     *
+     * @generated from enum value: AGENCY_TYPE_INTERNAL = 1;
+     */
+    INTERNAL = 1,
+    /**
+     * External agencies are the agencies that are not tenant agencies.
+     *
+     * @generated from enum value: AGENCY_TYPE_EXTERNAL = 2;
+     */
+    EXTERNAL = 2
+}
+/**
+ * Describes the enum producerflow.producer.v1.AgencyType.
+ */
+export declare const AgencyTypeSchema: GenEnum<AgencyType>;
+/**
+ * NIPRSyncState defines the synchronization state with the NIPR system.
+ *
+ * @generated from enum producerflow.producer.v1.NIPRSyncState
+ */
+export declare enum NIPRSyncState {
+    /**
+     * Default unspecified value. Do not use.
+     *
+     * @generated from enum value: NIPR_SYNC_STATE_UNSPECIFIED = 0;
+     */
+    NIPR_SYNC_STATE_UNSPECIFIED = 0,
+    /**
+     * Synchronization is active and working properly.
+     *
+     * @generated from enum value: NIPR_SYNC_STATE_ACTIVE = 1;
+     */
+    NIPR_SYNC_STATE_ACTIVE = 1,
+    /**
+     * Synchronization is failing due to errors.
+     *
+     * @generated from enum value: NIPR_SYNC_STATE_FAILING = 2;
+     */
+    NIPR_SYNC_STATE_FAILING = 2,
+    /**
+     * Synchronization is pending and has not started yet.
+     *
+     * @generated from enum value: NIPR_SYNC_STATE_PENDING = 3;
+     */
+    NIPR_SYNC_STATE_PENDING = 3,
+    /**
+     * Synchronization has been disabled.
+     *
+     * @generated from enum value: NIPR_SYNC_STATE_DISABLED = 4;
+     */
+    NIPR_SYNC_STATE_DISABLED = 4
+}
+/**
+ * Describes the enum producerflow.producer.v1.NIPRSyncState.
+ */
+export declare const NIPRSyncStateSchema: GenEnum<NIPRSyncState>;
 /**
  * ProducerOnboardingState defines the possible states in the producer onboarding workflow.
  * This enum is deprecated and should not be used in new code.
@@ -4158,6 +4622,19 @@ export declare const ProducerService: GenService<{
         input: typeof CreateAgencyOnboardingURLRequestSchema;
         output: typeof CreateAgencyOnboardingURLResponseSchema;
     };
+    /**
+     * CreateProducerOnboardingURL generates a secure, time-limited link for onboarding a new producer
+     * with optional pre-filled NPN. The URL can be shared directly with the producer.
+     * The generated URL will take the producer through the onboarding flow with the NPN field
+     * pre-populated if provided, reducing friction in the onboarding process.
+     *
+     * @generated from rpc producerflow.producer.v1.ProducerService.CreateProducerOnboardingURL
+     */
+    createProducerOnboardingURL: {
+        methodKind: "unary";
+        input: typeof CreateProducerOnboardingURLRequestSchema;
+        output: typeof CreateProducerOnboardingURLResponseSchema;
+    };
     /**
      * NewAgency creates a new agency, optionally with associated producers.
      * It performs the following validation checks:
@@ -4179,6 +4656,17 @@ export declare const ProducerService: GenService<{
         input: typeof NewAgencyRequestSchema;
         output: typeof NewAgencyResponseSchema;
     };
+    /**
+     * ListAgencies returns a list of agencies associated with the tenant.
+     * Supports optional filtering by organization ID and search queries.
+     *
+     * @generated from rpc producerflow.producer.v1.ProducerService.ListAgencies
+     */
+    listAgencies: {
+        methodKind: "unary";
+        input: typeof ListAgenciesRequestSchema;
+        output: typeof ListAgenciesResponseSchema;
+    };
     /**
      * ListOrganizations returns a list of organizations associated with the tenant.
      * Organizations represent logical groupings or hierarchical structures within a tenant