@reacon-io/sdk 0.1.0-beta.3

package/dist/apis/LeadsApi.d.ts

@@ -0,0 +1,391 @@
+/**
+ * Reacon API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import { type CreateLeadRequest } from '../models/CreateLeadRequest.js';
+import { type CreateLeadResponse } from '../models/CreateLeadResponse.js';
+import { type DeleteLeadResponse } from '../models/DeleteLeadResponse.js';
+import { type ExportLeadsRequest } from '../models/ExportLeadsRequest.js';
+import { type GetLeadResponse } from '../models/GetLeadResponse.js';
+import { type LeadExportInner } from '../models/LeadExportInner.js';
+import { type LeadPage } from '../models/LeadPage.js';
+import { type UpdateLeadRequest } from '../models/UpdateLeadRequest.js';
+import { type UpdateLeadResponse } from '../models/UpdateLeadResponse.js';
+export interface CreateLeadOperationRequest {
+    /**
+     *
+     */
+    teamId: string;
+    /**
+     *
+     */
+    createLeadRequest: CreateLeadRequest;
+}
+export interface DeleteLeadRequest {
+    /**
+     *
+     */
+    leadId: string;
+}
+export interface ExportLeadsOperationRequest {
+    /**
+     *
+     */
+    teamId: string;
+    /**
+     *
+     */
+    exportLeadsRequest: ExportLeadsRequest;
+}
+export interface GetLeadRequest {
+    /**
+     *
+     */
+    leadId: string;
+}
+export interface ListLeadsRequest {
+    /**
+     *
+     */
+    teamId: string;
+    /**
+     *
+     */
+    limit?: number;
+    /**
+     *
+     */
+    offset?: number;
+    /**
+     *
+     */
+    cursor?: string;
+    /**
+     *
+     */
+    domain?: string;
+    /**
+     *
+     */
+    search?: string;
+    /**
+     *
+     */
+    sort?: ListLeadsSortEnum;
+    /**
+     *
+     */
+    group?: ListLeadsGroupEnum;
+    /**
+     *
+     */
+    order?: ListLeadsOrderEnum;
+    /**
+     *
+     */
+    position?: string;
+    /**
+     *
+     */
+    filters?: string;
+}
+export interface UpdateLeadOperationRequest {
+    /**
+     *
+     */
+    leadId: string;
+    /**
+     *
+     */
+    updateLeadRequest?: UpdateLeadRequest;
+}
+/**
+ * LeadsApi - interface
+ *
+ * @export
+ * @interface LeadsApiInterface
+ */
+export interface LeadsApiInterface {
+    /**
+     * Creates request options for createLead without sending the request
+     * @param {string} teamId
+     * @param {CreateLeadRequest} createLeadRequest
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    createLeadRequestOpts(requestParameters: CreateLeadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a lead for the authenticated team. An API key cannot create leads for another team. Uses HTTP 200 with a lead envelope. No idempotency key is implemented; do not automatically retry.
+     * @summary Create a lead in a team
+     * @param {string} teamId
+     * @param {CreateLeadRequest} createLeadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    createLeadRaw(requestParameters: CreateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLeadResponse>>;
+    /**
+     * Creates a lead for the authenticated team. An API key cannot create leads for another team. Uses HTTP 200 with a lead envelope. No idempotency key is implemented; do not automatically retry.
+     * Create a lead in a team
+     */
+    createLead(requestParameters: CreateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<CreateLeadResponse>;
+    /**
+     * Creates request options for deleteLead without sending the request
+     * @param {string} leadId
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    deleteLeadRequestOpts(requestParameters: DeleteLeadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes a lead visible to the authenticated team and returns a success envelope. A repeated delete can return 404.
+     * @summary Delete a lead
+     * @param {string} leadId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    deleteLeadRaw(requestParameters: DeleteLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteLeadResponse>>;
+    /**
+     * Deletes a lead visible to the authenticated team and returns a success envelope. A repeated delete can return 404.
+     * Delete a lead
+     */
+    deleteLead(requestParameters: DeleteLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<DeleteLeadResponse>;
+    /**
+     * Creates request options for exportLeads without sending the request
+     * @param {string} teamId
+     * @param {ExportLeadsRequest} exportLeadsRequest
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    exportLeadsRequestOpts(requestParameters: ExportLeadsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Exports leads selected by inclusion/exclusion scopes and selected/deselected IDs. The body format field selects a JSON array (default) or text/csv attachment. Oversized selections return 413. Selection scopes must contain at least one item. No automatic replay.
+     * @summary Export selected leads
+     * @param {string} teamId
+     * @param {ExportLeadsRequest} exportLeadsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    exportLeadsRaw(requestParameters: ExportLeadsOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<LeadExportInner>>>;
+    /**
+     * Exports leads selected by inclusion/exclusion scopes and selected/deselected IDs. The body format field selects a JSON array (default) or text/csv attachment. Oversized selections return 413. Selection scopes must contain at least one item. No automatic replay.
+     * Export selected leads
+     */
+    exportLeads(requestParameters: ExportLeadsOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<Array<LeadExportInner>>;
+    /**
+     * Creates request options for getLead without sending the request
+     * @param {string} leadId
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    getLeadRequestOpts(requestParameters: GetLeadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a lead visible to the authenticated team. A missing or inaccessible lead can return 404.
+     * @summary Retrieve a lead
+     * @param {string} leadId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    getLeadRaw(requestParameters: GetLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLeadResponse>>;
+    /**
+     * Retrieves a lead visible to the authenticated team. A missing or inaccessible lead can return 404.
+     * Retrieve a lead
+     */
+    getLead(requestParameters: GetLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<GetLeadResponse>;
+    /**
+     * Creates request options for listLeads without sending the request
+     * @param {string} teamId
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {string} [domain]
+     * @param {string} [search]
+     * @param {'company' | 'position' | 'tag' | 'name' | 'phone' | 'location' | 'created_at' | 'updated_at'} [sort]
+     * @param {'company' | 'position' | 'tag'} [group]
+     * @param {'asc' | 'desc'} [order]
+     * @param {string} [position]
+     * @param {string} [filters]
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    listLeadsRequestOpts(requestParameters: ListLeadsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Lists leads belonging to the authenticated team, with filters, optional grouping and opaque cursors. filters is a JSON-encoded object. nextCursor, nextGroupCursor and lastGroupCursor are null when absent. The handler always returns JSON; use exportLeads for CSV.
+     * @summary List team leads
+     * @param {string} teamId
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {string} [domain]
+     * @param {string} [search]
+     * @param {'company' | 'position' | 'tag' | 'name' | 'phone' | 'location' | 'created_at' | 'updated_at'} [sort]
+     * @param {'company' | 'position' | 'tag'} [group]
+     * @param {'asc' | 'desc'} [order]
+     * @param {string} [position]
+     * @param {string} [filters]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    listLeadsRaw(requestParameters: ListLeadsRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LeadPage>>;
+    /**
+     * Lists leads belonging to the authenticated team, with filters, optional grouping and opaque cursors. filters is a JSON-encoded object. nextCursor, nextGroupCursor and lastGroupCursor are null when absent. The handler always returns JSON; use exportLeads for CSV.
+     * List team leads
+     */
+    listLeads(requestParameters: ListLeadsRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<LeadPage>;
+    /**
+     * Creates request options for updateLead without sending the request
+     * @param {string} leadId
+     * @param {UpdateLeadRequest} [updateLeadRequest]
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    updateLeadRequestOpts(requestParameters: UpdateLeadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates a lead visible to the authenticated team and returns the updated lead envelope. This endpoint uses POST. Missing leads or an update with no changes can return 404; do not automatically replay.
+     * @summary Update a lead
+     * @param {string} leadId
+     * @param {UpdateLeadRequest} [updateLeadRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApiInterface
+     */
+    updateLeadRaw(requestParameters: UpdateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateLeadResponse>>;
+    /**
+     * Updates a lead visible to the authenticated team and returns the updated lead envelope. This endpoint uses POST. Missing leads or an update with no changes can return 404; do not automatically replay.
+     * Update a lead
+     */
+    updateLead(requestParameters: UpdateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<UpdateLeadResponse>;
+}
+/**
+ *
+ */
+export declare class LeadsApi extends runtime.BaseAPI implements LeadsApiInterface {
+    /**
+     * Creates request options for createLead without sending the request
+     */
+    createLeadRequestOpts(requestParameters: CreateLeadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a lead for the authenticated team. An API key cannot create leads for another team. Uses HTTP 200 with a lead envelope. No idempotency key is implemented; do not automatically retry.
+     * Create a lead in a team
+     */
+    createLeadRaw(requestParameters: CreateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLeadResponse>>;
+    /**
+     * Creates a lead for the authenticated team. An API key cannot create leads for another team. Uses HTTP 200 with a lead envelope. No idempotency key is implemented; do not automatically retry.
+     * Create a lead in a team
+     */
+    createLead(requestParameters: CreateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<CreateLeadResponse>;
+    /**
+     * Creates request options for deleteLead without sending the request
+     */
+    deleteLeadRequestOpts(requestParameters: DeleteLeadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes a lead visible to the authenticated team and returns a success envelope. A repeated delete can return 404.
+     * Delete a lead
+     */
+    deleteLeadRaw(requestParameters: DeleteLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteLeadResponse>>;
+    /**
+     * Deletes a lead visible to the authenticated team and returns a success envelope. A repeated delete can return 404.
+     * Delete a lead
+     */
+    deleteLead(requestParameters: DeleteLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<DeleteLeadResponse>;
+    /**
+     * Creates request options for exportLeads without sending the request
+     */
+    exportLeadsRequestOpts(requestParameters: ExportLeadsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Exports leads selected by inclusion/exclusion scopes and selected/deselected IDs. The body format field selects a JSON array (default) or text/csv attachment. Oversized selections return 413. Selection scopes must contain at least one item. No automatic replay.
+     * Export selected leads
+     */
+    /** Download a CSV export as text. Uses one request; never retries accepted work. */
+    exportLeadsCsv(requestParameters: ExportLeadsOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<string>;
+    exportLeadsRaw(requestParameters: ExportLeadsOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<LeadExportInner>>>;
+    /**
+     * Exports leads selected by inclusion/exclusion scopes and selected/deselected IDs. The body format field selects a JSON array (default) or text/csv attachment. Oversized selections return 413. Selection scopes must contain at least one item. No automatic replay.
+     * Export selected leads
+     */
+    exportLeads(requestParameters: ExportLeadsOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<Array<LeadExportInner>>;
+    /**
+     * Creates request options for getLead without sending the request
+     */
+    getLeadRequestOpts(requestParameters: GetLeadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a lead visible to the authenticated team. A missing or inaccessible lead can return 404.
+     * Retrieve a lead
+     */
+    getLeadRaw(requestParameters: GetLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLeadResponse>>;
+    /**
+     * Retrieves a lead visible to the authenticated team. A missing or inaccessible lead can return 404.
+     * Retrieve a lead
+     */
+    getLead(requestParameters: GetLeadRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<GetLeadResponse>;
+    /**
+     * Creates request options for listLeads without sending the request
+     */
+    listLeadsRequestOpts(requestParameters: ListLeadsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Lists leads belonging to the authenticated team, with filters, optional grouping and opaque cursors. filters is a JSON-encoded object. nextCursor, nextGroupCursor and lastGroupCursor are null when absent. The handler always returns JSON; use exportLeads for CSV.
+     * List team leads
+     */
+    listLeadsRaw(requestParameters: ListLeadsRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LeadPage>>;
+    /**
+     * Lists leads belonging to the authenticated team, with filters, optional grouping and opaque cursors. filters is a JSON-encoded object. nextCursor, nextGroupCursor and lastGroupCursor are null when absent. The handler always returns JSON; use exportLeads for CSV.
+     * List team leads
+     */
+    listLeads(requestParameters: ListLeadsRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<LeadPage>;
+    /**
+     * Creates request options for updateLead without sending the request
+     */
+    updateLeadRequestOpts(requestParameters: UpdateLeadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates a lead visible to the authenticated team and returns the updated lead envelope. This endpoint uses POST. Missing leads or an update with no changes can return 404; do not automatically replay.
+     * Update a lead
+     */
+    updateLeadRaw(requestParameters: UpdateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateLeadResponse>>;
+    /**
+     * Updates a lead visible to the authenticated team and returns the updated lead envelope. This endpoint uses POST. Missing leads or an update with no changes can return 404; do not automatically replay.
+     * Update a lead
+     */
+    updateLead(requestParameters: UpdateLeadOperationRequest, initOverrides?: runtime.RequestOptions | runtime.InitOverrideFunction): Promise<UpdateLeadResponse>;
+}
+/**
+ * @export
+ */
+export declare const ListLeadsSortEnum: {
+    readonly Company: "company";
+    readonly Position: "position";
+    readonly Tag: "tag";
+    readonly Name: "name";
+    readonly Phone: "phone";
+    readonly Location: "location";
+    readonly CreatedAt: "created_at";
+    readonly UpdatedAt: "updated_at";
+};
+export type ListLeadsSortEnum = typeof ListLeadsSortEnum[keyof typeof ListLeadsSortEnum];
+/**
+ * @export
+ */
+export declare const ListLeadsGroupEnum: {
+    readonly Company: "company";
+    readonly Position: "position";
+    readonly Tag: "tag";
+};
+export type ListLeadsGroupEnum = typeof ListLeadsGroupEnum[keyof typeof ListLeadsGroupEnum];
+/**
+ * @export
+ */
+export declare const ListLeadsOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListLeadsOrderEnum = typeof ListLeadsOrderEnum[keyof typeof ListLeadsOrderEnum];