add-person-request.ts

/* tslint:disable */
/* eslint-disable */
/**
 * Pipedrive API v2
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 2.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


// May contain unused imports in some cases
// @ts-ignore
import { GetPersonsResponseAllOfDataInnerEmailsInner } from './get-persons-response-all-of-data-inner-emails-inner';
// May contain unused imports in some cases
// @ts-ignore
import { GetPersonsResponseAllOfDataInnerPhonesInner } from './get-persons-response-all-of-data-inner-phones-inner';

/**
* 
* @export
* @interface AddPersonRequest
*/
export interface AddPersonRequest {
    /**
    * The name of the person
    * @type {string}
    */
    'name'?: string;
    /**
    * The ID of the user who owns the person
    * @type {number}
    */
    'owner_id'?: number;
    /**
    * The ID of the organization linked to the person
    * @type {number}
    */
    'org_id'?: number;
    /**
    * The creation date and time of the person
    * @type {string}
    */
    'add_time'?: string;
    /**
    * The last updated date and time of the person
    * @type {string}
    */
    'update_time'?: string;
    /**
    * The emails of the person
    * @type {Array<GetPersonsResponseAllOfDataInnerEmailsInner>}
    */
    'emails'?: Array<GetPersonsResponseAllOfDataInnerEmailsInner>;
    /**
    * The phones of the person
    * @type {Array<GetPersonsResponseAllOfDataInnerPhonesInner>}
    */
    'phones'?: Array<GetPersonsResponseAllOfDataInnerPhonesInner>;
    /**
    * The visibility of the person
    * @type {number}
    */
    'visible_to'?: number;
    /**
    * The IDs of labels assigned to the person
    * @type {Array<number>}
    */
    'label_ids'?: Array<number>;
    /**
    * If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>
    * @type {string}
    */
    'marketing_status'?: AddPersonRequestMarketingStatusConst;
    /**
    * An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes
    * @type {{ [key: string]: any | undefined; }}
    */
    'custom_fields'?: { [key: string]: any | undefined; };
}

                export const AddPersonRequestMarketingStatusConst = {
                        no_consent: 'no_consent',
                        unsubscribed: 'unsubscribed',
                        subscribed: 'subscribed',
                        archived: 'archived'
                } as const;

                export type AddPersonRequestMarketingStatusConst = typeof AddPersonRequestMarketingStatusConst[keyof typeof AddPersonRequestMarketingStatusConst];