Check out our summer line!
"; readonly id: 986724; readonly ip_pool: "marketing"; readonly list_ids: readonly [110, 124]; readonly plain_content: "Check out our summer line!"; readonly segment_ids: readonly [110]; readonly sender_id: 124451; readonly status: "Draft"; readonly subject: "New Products for Summer!"; readonly suppression_group_id: 42; readonly title: "May Newsletter"; }; readonly properties: { readonly categories: { readonly description: "The categories you would like associated to this campaign."; readonly items: { readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly custom_unsubscribe_url: { readonly description: "This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups."; readonly nullable: true; readonly type: "string"; }; readonly editor: { readonly description: "The editor used in the UI."; readonly enum: readonly ["code", "design"]; readonly type: "string"; }; readonly html_content: { readonly description: "The HTML of your marketing email."; readonly nullable: true; readonly type: "string"; }; readonly ip_pool: { readonly description: "The pool of IPs that you would like to send this email from."; readonly nullable: true; readonly type: "string"; }; readonly list_ids: { readonly description: "The IDs of the lists you are sending this campaign to. You can have both segment IDs and list IDs"; readonly items: { readonly type: "integer"; }; readonly nullable: true; readonly type: "array"; }; readonly plain_content: { readonly description: "The plain text content of your emails."; readonly nullable: true; readonly type: "string"; }; readonly segment_ids: { readonly description: "The segment IDs that you are sending this list to. You can have both segment IDs and list IDs. Segments are limited to 10 segment IDs."; readonly items: { readonly type: "integer"; }; readonly nullable: true; readonly type: "array"; }; readonly sender_id: { readonly description: "The ID of the \"sender\" identity that you have created. Your recipients will see this as the \"from\" on your marketing emails."; readonly nullable: true; readonly type: "integer"; }; readonly subject: { readonly description: "The subject of your campaign that your recipients will see."; readonly nullable: true; readonly type: "string"; }; readonly suppression_group_id: { readonly description: "The suppression group that this marketing email belongs to, allowing recipients to opt-out of emails of this type."; readonly nullable: true; readonly type: "integer"; }; readonly title: { readonly description: "The display title of your campaign. This will be viewable by you in the Marketing Campaigns UI."; readonly type: "string"; }; }; readonly required: readonly ["title"]; readonly title: "Campaigns Request"; readonly type: "object"; }; export declare const campaign_responseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/campaign_request"; }, { readonly properties: { readonly id: { readonly type: "integer"; }; readonly status: { readonly description: "The status of your campaign."; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly type: "object"; }]; readonly title: "Campaigns Response"; }; export declare const category_statsSchema: { readonly example: { readonly date: "2015-01-01"; readonly stats: readonly [{ readonly metrics: { readonly blocks: 0; readonly bounce_drops: 0; readonly bounces: 0; readonly clicks: 0; readonly deferred: 0; readonly delivered: 0; readonly invalid_emails: 0; readonly opens: 0; readonly processed: 0; readonly requests: 0; readonly spam_report_drops: 0; readonly spam_reports: 0; readonly unique_clicks: 0; readonly unique_opens: 0; readonly unsubscribe_drops: 0; readonly unsubscribes: 0; }; readonly name: "cat1"; readonly type: "category"; }, { readonly metrics: { readonly blocks: 0; readonly bounce_drops: 0; readonly bounces: 0; readonly clicks: 0; readonly deferred: 0; readonly delivered: 0; readonly invalid_emails: 0; readonly opens: 0; readonly processed: 0; readonly requests: 0; readonly spam_report_drops: 0; readonly spam_reports: 0; readonly unique_clicks: 0; readonly unique_opens: 0; readonly unsubscribe_drops: 0; readonly unsubscribes: 0; }; readonly name: "cat2"; readonly type: "category"; }]; }; readonly properties: { readonly date: { readonly description: "The date the statistics were gathered."; readonly type: "string"; }; readonly stats: { readonly items: { readonly properties: { readonly metrics: { readonly properties: { readonly blocks: { readonly description: "The number of emails that were not allowed to be delivered by ISPs."; readonly type: "integer"; }; readonly bounce_drops: { readonly description: "The number of emails that were dropped because of a bounce."; readonly type: "integer"; }; readonly bounces: { readonly description: "The number of emails that bounced instead of being delivered."; readonly type: "integer"; }; readonly clicks: { readonly description: "The number of links that were clicked."; readonly type: "integer"; }; readonly deferred: { readonly description: "The number of emails that temporarily could not be delivered."; readonly type: "integer"; }; readonly delivered: { readonly description: "The number of emails SendGrid was able to confirm were actually delivered to a recipient."; readonly type: "integer"; }; readonly invalid_emails: { readonly description: "The number of recipients who had malformed email addresses or whose mail provider reported the address as invalid."; readonly type: "integer"; }; readonly opens: { readonly description: "The total number of times your emails were opened by recipients."; readonly type: "integer"; }; readonly processed: { readonly description: "Requests from your website, application, or mail client via SMTP Relay or the API that SendGrid processed."; readonly type: "integer"; }; readonly requests: { readonly description: "The number of emails that were requested to be delivered."; readonly type: "integer"; }; readonly spam_report_drops: { readonly description: "The number of emails that were dropped due to a recipient previously marking your emails as spam."; readonly type: "integer"; }; readonly spam_reports: { readonly description: "The number of recipients who marked your email as spam."; readonly type: "integer"; }; readonly unique_clicks: { readonly description: "The number of unique recipients who clicked links in your emails."; readonly type: "integer"; }; readonly unique_opens: { readonly description: "The number of unique recipients who opened your emails."; readonly type: "integer"; }; readonly unsubscribe_drops: { readonly description: "The number of emails dropped due to a recipient unsubscribing from your emails."; readonly type: "integer"; }; readonly unsubscribes: { readonly description: "The number of recipients who unsubscribed from your emails."; readonly type: "integer"; }; }; readonly required: readonly ["blocks", "bounce_drops", "bounces", "clicks", "deferred", "delivered", "invalid_emails", "opens", "processed", "requests", "spam_report_drops", "spam_reports", "unique_clicks", "unique_opens", "unsubscribe_drops", "unsubscribes"]; readonly type: "object"; }; readonly name: { readonly description: "The name of the category."; readonly type: "string"; }; readonly type: { readonly description: "How you are segmenting your statistics."; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly type: "object"; }; readonly type: "array"; }; }; readonly required: readonly ["date"]; readonly title: "Stats: Category Stats"; readonly type: "object"; }; export declare const cc_bcc_email_objectSchema: { readonly example: { readonly email: "jane_doe@example.com"; readonly name: "Jane Doe"; }; readonly properties: { readonly email: { readonly description: "The intended recipient's email address."; readonly format: "email"; readonly type: "string"; }; readonly name: { readonly description: "The intended recipient's name."; readonly type: "string"; }; }; readonly required: readonly ["email"]; readonly title: "CC BCC Email Object"; readonly type: "object"; }; export declare const click_trackingSchema: { readonly example: { readonly enable_text: false; readonly enabled: false; }; readonly properties: { readonly enable_text: { readonly description: "Indicates if click tracking is enabled for plain text emails."; readonly type: "boolean"; }; readonly enabled: { readonly description: "Indicates if click tracking is enabled or disabled."; readonly type: "boolean"; }; }; readonly required: readonly ["enable_text", "enabled"]; readonly title: "Settings: Click Tracking"; readonly type: "object"; }; export declare const contact_detailsSchema: { readonly properties: { readonly _metadata: { readonly $ref: "#/components/schemas/selfmetadata"; }; readonly address_line_1: { readonly type: "string"; }; readonly address_line_2: { readonly type: "string"; }; readonly alternate_emails: { readonly items: { readonly type: "string"; }; readonly type: "array"; }; readonly city: { readonly type: "string"; }; readonly country: { readonly type: "string"; }; readonly created_at: { readonly description: "The ISO8601 timestamp when the contact was created."; readonly type: "string"; }; readonly custom_fields: { readonly $ref: "#/components/schemas/custom-fields-by-name"; }; readonly email: { readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly id: { readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; readonly list_ids: { readonly items: { readonly type: "string"; }; readonly type: "array"; }; readonly postal_code: { readonly type: "string"; }; readonly state_province_region: { readonly type: "string"; }; readonly updated_at: { readonly description: "The ISO8601 timestamp when the contact was updated."; readonly type: "string"; }; }; readonly required: readonly ["id", "list_ids", "created_at", "updated_at"]; readonly title: "contact-details"; readonly type: "object"; }; export declare const contact_details2Schema: { readonly properties: { readonly _metadata: { readonly $ref: "#/components/schemas/selfmetadata"; }; readonly address_line_1: { readonly type: "string"; }; readonly address_line_2: { readonly type: "string"; }; readonly alternate_emails: { readonly items: { readonly format: "email"; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly city: { readonly type: "string"; }; readonly country: { readonly type: "string"; }; readonly created_at: { readonly format: "date-time"; readonly type: "string"; }; readonly custom_fields: { readonly type: "object"; }; readonly email: { readonly format: "email"; readonly type: "string"; }; readonly facebook: { readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly id: { readonly format: "uuid"; readonly maxLength: 36; readonly minLength: 36; readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; readonly line: { readonly type: "string"; }; readonly list_ids: { readonly items: { readonly format: "uuid"; readonly type: "string"; }; readonly type: "array"; }; readonly phone_number: { readonly type: "string"; }; readonly postal_code: { readonly type: "string"; }; readonly segment_ids: { readonly items: { readonly format: "uuid"; readonly type: "string"; }; readonly type: "array"; }; readonly state_province_region: { readonly type: "string"; }; readonly unique_name: { readonly type: "string"; }; readonly updated_at: { readonly format: "date-time"; readonly type: "string"; }; readonly whatsapp: { readonly type: "string"; }; }; readonly required: readonly ["id", "list_ids", "created_at", "updated_at"]; readonly title: "contact-details2"; readonly type: "object"; }; export declare const contact_details3Schema: { readonly properties: { readonly _metadata: { readonly $ref: "#/components/schemas/selfmetadata"; }; readonly address_line_1: { readonly type: "string"; }; readonly address_line_2: { readonly type: "string"; }; readonly alternate_emails: { readonly items: { readonly type: "string"; }; readonly type: "array"; }; readonly city: { readonly type: "string"; }; readonly country: { readonly type: "string"; }; readonly created_at: { readonly type: "string"; }; readonly custom_fields: { readonly type: "object"; }; readonly email: { readonly type: "string"; }; readonly facebook: { readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly id: { readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; readonly line: { readonly type: "string"; }; readonly list_ids: { readonly items: { readonly type: "string"; }; readonly type: "array"; }; readonly phone_number: { readonly type: "string"; }; readonly postal_code: { readonly type: "string"; }; readonly segment_ids: { readonly items: { readonly type: "string"; }; readonly type: "array"; }; readonly state_province_region: { readonly type: "string"; }; readonly unique_name: { readonly type: "string"; }; readonly updated_at: { readonly type: "string"; }; readonly whatsapp: { readonly type: "string"; }; }; readonly required: readonly ["id", "list_ids", "segment_ids", "created_at", "updated_at"]; readonly title: "contact-details3"; readonly type: "object"; }; export declare const contact_exportSchema: { readonly properties: { readonly _metadata: { readonly $ref: "#/components/schemas/metadata"; }; readonly completed_at: { readonly description: "The ISO8601 timestamp when the export was completed."; readonly type: "string"; }; readonly contact_count: { readonly description: "The total number of exported contacts."; readonly type: "integer"; }; readonly created_at: { readonly description: "The ISO8601 timestamp when the export was begun."; readonly type: "string"; }; readonly expires_at: { readonly description: "The ISO8601 timestamp when the exported file on S3 will expire."; readonly type: "string"; }; readonly id: { readonly type: "string"; }; readonly message: { readonly description: "A human readable message if the status is `failure`."; readonly type: "string"; }; readonly status: { readonly description: "The export job's status. Allowed values: `pending`, `ready`, or `failure`."; readonly enum: readonly ["pending", "ready", "failure"]; readonly type: "string"; }; readonly updated_at: { readonly description: "The ISO8601 timestamp when the export was updated."; readonly type: "string"; }; readonly urls: { readonly description: "One or more download URLs for the contact file if the status is `ready`."; readonly items: { readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["id", "status", "created_at", "updated_at", "expires_at"]; readonly title: "contact-export"; readonly type: "object"; }; export declare const contact_importSchema: { readonly properties: { readonly finished_at: { readonly description: "The ISO8601 timestamp when the job was finished."; readonly type: "string"; }; readonly id: { readonly description: "The job ID."; readonly type: "string"; }; readonly job_type: { readonly description: "The job type. Allowed values: `upsert`, or `delete`."; readonly type: "string"; }; readonly results: { readonly description: "Result map of the import job."; readonly properties: { readonly created_count: { readonly description: "Created contact count from the import."; readonly type: "number"; }; readonly deleted_count: { readonly description: "Count of deleted contacts that resulted in error."; readonly type: "number"; }; readonly errored_count: { readonly description: "Count of imported contacts that resulted in error."; readonly type: "number"; }; readonly errors_url: { readonly description: "The download URL of the file which provides information about any errors."; readonly type: "string"; }; readonly requested_count: { readonly description: "Requested contact count from the import."; readonly type: "number"; }; readonly updated_count: { readonly description: "Updated contact count from the import."; readonly type: "number"; }; }; readonly type: "object"; }; readonly started_at: { readonly description: "The ISO8601 timestamp when the job was created."; readonly type: "string"; }; readonly status: { readonly description: "The job state. Allowed values: `pending`, `completed`, `errored`, or `failed`."; readonly type: "string"; }; }; readonly title: "contact-import"; readonly type: "object"; }; export declare const contact_requestSchema: { readonly properties: { readonly address_line_1: { readonly description: "The first line of the address."; readonly maxLength: 100; readonly type: "string"; }; readonly address_line_2: { readonly description: "An optional second line for the address."; readonly maxLength: 100; readonly type: "string"; }; readonly alternate_emails: { readonly description: "Additional emails associated with the contact."; readonly items: { readonly maxLength: 254; readonly type: "string"; }; readonly maxItems: 5; readonly minItems: 0; readonly type: "array"; }; readonly city: { readonly description: "The contact's city."; readonly maxLength: 60; readonly type: "string"; }; readonly country: { readonly description: "The contact's country. Can be a full name or an abbreviation."; readonly maxLength: 50; readonly type: "string"; }; readonly custom_fields: { readonly $ref: "#/components/schemas/custom-fields-by-id"; }; readonly email: { readonly description: "The contact's primary email. This is required to be a valid email."; readonly maxLength: 254; readonly type: "string"; }; readonly first_name: { readonly description: "The contact's personal name."; readonly maxLength: 50; readonly type: "string"; }; readonly last_name: { readonly description: "The contact's family name."; readonly maxLength: 50; readonly type: "string"; }; readonly postal_code: { readonly description: "The contact's ZIP code or other postal code."; readonly type: "string"; }; readonly state_province_region: { readonly description: "The contact's state, province, or region."; readonly maxLength: 50; readonly type: "string"; }; }; readonly required: readonly ["email"]; readonly title: "contact-request"; readonly type: "object"; }; export declare const contact_summarySchema: { readonly properties: { readonly _metadata: { readonly $ref: "#/components/schemas/selfmetadata"; }; readonly created_at: { readonly description: "Unix Epoch Timestamp."; readonly type: "number"; }; readonly email: { readonly description: "Primary email address."; readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly id: { readonly description: "Contact UUID."; readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; readonly list_ids: { readonly description: "List UUID linked with this contact."; readonly items: { readonly type: "string"; }; readonly type: "array"; }; readonly updated_at: { readonly description: "Unix Epoch Timestamp."; readonly type: "number"; }; }; readonly required: readonly ["id", "list_ids", "created_at", "updated_at"]; readonly title: "contact-summary"; readonly type: "object"; }; export declare const contact_responseSchema: { readonly example: { readonly address_line_1: "street address / P.O. box / CompanyName / c/o"; readonly address_line_2: "apartment, suite, unit, building, floor etc"; readonly alternate_emails: readonly ["abcd@yahoo.com", "abcd@hotmail.com"]; readonly city: "Redwood City"; readonly country: "USA"; readonly custom_fields: { readonly custom_field_name1: "custom_field_value1"; readonly custom_field_name2: "custom_field_value2"; }; readonly email: "abcd@gmail.com"; readonly first_name: "Ab"; readonly id: "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70"; readonly last_name: "Cd"; readonly postal_code: 94063; readonly state_province_region: "CA"; }; readonly properties: { readonly address_line_1: { readonly description: "First line of address of the contact. This is a reserved field."; readonly minLength: 0; readonly type: "string"; }; readonly address_line_2: { readonly description: "Second line of address of the contact. This is a reserved field."; readonly minLength: 0; readonly type: "string"; }; readonly alternate_emails: { readonly description: "Alternate emails of the contact. This is a reserved field."; readonly items: { readonly format: "email"; readonly maxLength: 254; readonly minLength: 3; readonly type: "string"; }; readonly minItems: 0; readonly type: "array"; readonly uniqueItems: true; }; readonly city: { readonly description: "City associated with the contact. This is a reserved field."; readonly minLength: 0; readonly pattern: "^[a-zA-Z-ɏs/-)(`.\"']+$"; readonly type: "string"; }; readonly country: { readonly description: "Country associated with the address of the contact. This is a reserved field."; readonly minLength: 0; readonly type: "string"; }; readonly custom_fields: { readonly description: "The user may choose to create up to 120 custom fields or none at all. This is not a reserved field."; readonly minProperties: 0; readonly properties: { readonly custom_field_name1: { readonly minLength: 0; readonly type: "string"; }; readonly custom_field_name2: { readonly minLength: 0; readonly type: "string"; }; }; readonly type: "object"; }; readonly email: { readonly description: "Email of the contact. This is a reserved field."; readonly format: "email"; readonly maxLength: 254; readonly minLength: 3; readonly type: "string"; }; readonly first_name: { readonly description: "First name of the contact. This is a reserved field."; readonly minLength: 1; readonly type: "string"; }; readonly id: { readonly description: "ID assigned to a contact when added to the system."; readonly format: "uuid"; readonly maxLength: 36; readonly pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"; readonly type: "string"; }; readonly last_name: { readonly description: "Last name of the contact. This is a reserved field."; readonly minLength: 1; readonly type: "string"; }; readonly list_ids: { readonly description: "IDs of all lists the contact is part of"; readonly items: { readonly format: "uuid"; readonly type: "string"; }; readonly type: "array"; readonly uniqueItems: true; }; readonly postal_code: { readonly description: "Zipcode associated with the address of the contact. This is a reserved field."; readonly type: "integer"; }; readonly segment_ids: { readonly description: "IDs of all segments the contact is part of"; readonly items: { readonly format: "uuid"; readonly type: "string"; }; readonly type: "array"; readonly uniqueItems: true; }; readonly state_province_region: { readonly description: "State associated with the contact. This is a reserved field."; readonly minLength: 0; readonly type: "string"; }; }; readonly required: readonly ["id", "email", "alternate_emails", "first_name", "last_name", "address_line_1", "address_line_2", "city", "state_province_region", "postal_code", "country", "custom_fields"]; readonly title: "contact_response"; readonly type: "object"; }; export declare const contactdb_custom_fieldSchema: { readonly example: { readonly name: "first_name"; readonly type: "text"; }; readonly properties: { readonly name: { readonly description: "The name of the field"; readonly type: "string"; }; readonly type: { readonly description: "The type of the field."; readonly enum: readonly ["date", "text", "number"]; readonly type: "string"; }; }; readonly title: "ContactDB Custom field schema."; readonly type: "object"; }; export declare const contactdb_custom_field_with_idSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/contactdb_custom_field"; }, { readonly properties: { readonly id: { readonly description: "The ID of the custom field."; readonly type: "number"; }; }; readonly type: "object"; }]; readonly title: "ContactDB Custom field schema with ID."; }; export declare const contactdb_custom_field_with_id_valueSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/contactdb_custom_field_with_id"; }, { readonly properties: { readonly value: { readonly description: "The value of this recipient's custom field"; readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }]; readonly title: "ContactDB Custom field schema."; }; export declare const contactdb_listSchema: { readonly example: { readonly id: 1; readonly name: "listname"; readonly recipient_count: 0; }; readonly properties: { readonly id: { readonly description: "The reference ID of your list."; readonly type: "integer"; }; readonly name: { readonly description: "The name of your list. Must be unique against all other list and segment names."; readonly type: "string"; }; readonly recipient_count: { readonly description: "The count of recipients currently in the list."; readonly type: "integer"; }; }; readonly required: readonly ["id", "name", "recipient_count"]; readonly title: "ContactDB lists"; readonly type: "object"; }; export declare const contactdb_recipientSchema: { readonly properties: { readonly recipients: { readonly items: { readonly properties: { readonly created_at: { readonly description: "The time this record was created in your contactdb, in unixtime."; readonly type: "number"; }; readonly custom_fields: { readonly description: "The custom fields assigned to this recipient and their values."; readonly items: { readonly $ref: "#/components/schemas/contactdb_custom_field_with_id_value"; }; readonly type: "array"; }; readonly email: { readonly description: "The email address of this recipient. This is a default custom field that SendGrid provides."; readonly format: "email"; readonly type: "string"; }; readonly first_name: { readonly description: "The first name of this recipient. This is a default custom field that SendGrid provides."; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "The ID of this recipient."; readonly type: "string"; }; readonly last_clicked: { readonly description: "The last time this recipient clicked a link from one of your campaigns, in unixtime."; readonly nullable: true; readonly type: "number"; }; readonly last_emailed: { readonly description: "The last time this user was emailed by one of your campaigns, in unixtime."; readonly nullable: true; readonly type: "number"; }; readonly last_name: { readonly description: "The last name of the recipient."; readonly nullable: true; readonly type: "string"; }; readonly last_opened: { readonly description: "The last time this recipient opened an email from you, in unixtime."; readonly nullable: true; readonly type: "number"; }; readonly updated_at: { readonly description: "The last update date for this recipient's record."; readonly type: "number"; }; }; readonly required: readonly ["email"]; readonly type: "object"; }; readonly type: "array"; }; }; readonly title: "ContactDB: Recipient"; readonly type: "object"; }; export declare const contactdb_recipient_countSchema: { readonly example: { readonly recipient_count: 1234; }; readonly properties: { readonly recipient_count: { readonly description: "The count of recipients."; readonly type: "number"; }; }; readonly required: readonly ["recipient_count"]; readonly title: "ContactDB: Recipient Count"; readonly type: "object"; }; export declare const contactdb_recipient_responseSchema: { readonly example: { readonly error_count: 1; readonly error_indices: readonly [2]; readonly errors: readonly [{ readonly error_indices: readonly [2]; readonly message: "Invalid email."; }]; readonly new_count: 2; readonly persisted_recipients: readonly ["YUBh", "bWlsbGVyQG1pbGxlci50ZXN0"]; readonly updated_count: 0; }; readonly properties: { readonly error_count: { readonly default: 0; readonly description: "The number of errors found while adding recipients."; readonly type: "number"; }; readonly error_indices: { readonly default: readonly []; readonly description: "The indices of the recipient(s) sent that caused the error. "; readonly items: { readonly type: "number"; }; readonly type: "array"; }; readonly errors: { readonly items: { readonly properties: { readonly error_indices: { readonly items: { readonly type: "number"; }; readonly type: "array"; }; readonly message: { readonly type: "string"; }; }; readonly type: "object"; }; readonly type: "array"; }; readonly new_count: { readonly default: 0; readonly description: "The count of new recipients added to the contactdb."; readonly type: "number"; }; readonly persisted_recipients: { readonly default: readonly []; readonly description: "The recipient IDs of the recipients that already existed from this request."; readonly items: { readonly type: "string"; }; readonly type: "array"; }; readonly updated_count: { readonly default: 0; readonly description: "The recipients who were updated from this request."; readonly type: "number"; }; }; readonly required: readonly ["error_count", "new_count", "persisted_recipients", "updated_count"]; readonly title: "ContactDB: Recipient response"; readonly type: "object"; }; export declare const contactdb_segmentsSchema: { readonly example: { readonly conditions: readonly [{ readonly and_or: ""; readonly field: "last_name"; readonly operator: "eq"; readonly value: "Miller"; }, { readonly and_or: "and"; readonly field: "last_clicked"; readonly operator: "gt"; readonly value: "01/02/2015"; }, { readonly and_or: "or"; readonly field: "clicks.campaign_identifier"; readonly operator: "eq"; readonly value: "513"; }]; readonly list_id: 4; readonly name: "Last Name Miller"; readonly recipient_count: 1234; }; readonly properties: { readonly conditions: { readonly description: "The conditions for a recipient to be included in this segment."; readonly items: { readonly $ref: "#/components/schemas/contactdb_segments_conditions"; }; readonly type: "array"; }; readonly list_id: { readonly description: "The list id from which to make this segment. Not including this ID will mean your segment is created from the main contactdb rather than a list."; readonly type: "integer"; }; readonly name: { readonly description: "The name of this segment."; readonly type: "string"; }; readonly recipient_count: { readonly description: "The count of recipients in this list. This is not included on creation of segments."; readonly type: "number"; }; }; readonly required: readonly ["name", "conditions"]; readonly title: "Create a Segment request"; readonly type: "object"; }; export declare const contactdb_segments_conditionsSchema: { readonly properties: { readonly and_or: { readonly enum: readonly ["and", "or", ""]; readonly type: "string"; }; readonly field: { readonly type: "string"; }; readonly operator: { readonly enum: readonly ["eq", "ne", "lt", "gt", "contains"]; readonly type: "string"; }; readonly value: { readonly type: "string"; }; }; readonly required: readonly ["field", "value", "operator"]; readonly title: "ContactDB: Segments: Conditions"; readonly type: "object"; }; export declare const contactdb_segments_with_idSchema: { readonly allOf: readonly [{ readonly properties: { readonly id: { readonly description: "The ID of the segment."; readonly type: "number"; }; }; readonly required: readonly ["id"]; readonly type: "object"; }, { readonly $ref: "#/components/schemas/contactdb_segments"; }]; readonly title: "ContactDB:: Segments with ID"; }; export declare const contactsSchema: { readonly properties: { readonly address: { readonly type: "string"; }; readonly address2: { readonly type: "object"; }; readonly city: { readonly type: "string"; }; readonly company: { readonly type: "string"; }; readonly country: { readonly type: "string"; }; readonly email: { readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; readonly phone: { readonly type: "string"; }; readonly state: { readonly type: "string"; }; readonly zip: { readonly type: "string"; }; }; readonly title: "Contacts"; readonly type: "object"; }; export declare const create_integration_requestSchema: { readonly properties: { readonly completed_integration: { readonly description: "Indicates if the integration is complete."; readonly type: "boolean"; }; readonly enabled: { readonly description: "Indicates if the integration is enabled."; readonly type: "boolean"; }; readonly entity_id: { readonly description: "An identifier provided by your IdP to identify Twilio SendGrid in the SAML interaction. This is called the \"SAML Issuer ID\" in the Twilio SendGrid UI."; readonly type: "string"; }; readonly name: { readonly description: "The name of your integration. This name can be anything that makes sense for your organization (eg. Twilio SendGrid)"; readonly type: "string"; }; readonly signin_url: { readonly description: "The IdP's SAML POST endpoint. This endpoint should receive requests and initiate an SSO login flow. This is called the \"Embed Link\" in the Twilio SendGrid UI."; readonly type: "string"; }; readonly signout_url: { readonly description: "This URL is relevant only for an IdP-initiated authentication flow. If a user authenticates from their IdP, this URL will return them to their IdP when logging out."; readonly type: "string"; }; }; readonly required: readonly ["name", "enabled", "signin_url", "signout_url", "entity_id"]; readonly title: "Create Integration Request"; readonly type: "object"; }; export declare const credentialsSchema: { readonly example: { readonly address: "1234 example street"; readonly address2: null; readonly city: "Denver"; readonly company: "Company name"; readonly country: "US"; readonly email: "example@example.com"; readonly first_name: "Example"; readonly last_name: "User"; readonly phone: "(555) 555-5555"; readonly state: "CO"; readonly zip: "55555"; }; readonly properties: { readonly permissions: { readonly properties: { readonly api: { readonly type: "string"; }; readonly mail: { readonly type: "string"; }; readonly web: { readonly type: "string"; }; }; readonly type: "object"; }; readonly username: { readonly type: "string"; }; }; readonly title: "Credentials"; readonly type: "object"; }; export declare const custom_fields_by_idSchema: { readonly example: { readonly e2: "Coffee is a beverage that puts one to sleep when not drank."; readonly w1: "2002-10-02T15:00:00Z"; readonly w33: 9.5; }; readonly title: "custom-fields-by-id"; readonly type: "object"; }; export declare const custom_fields_by_nameSchema: { readonly example: { readonly birthday: "2002-10-02T15:00:00Z"; readonly favoriteQuote: "Coffee is a beverage that puts one to sleep when not drank."; readonly shoe_size: 9.5; }; readonly title: "custom-fields-by-name"; readonly type: "object"; }; export declare const custom_field_definitions_responseSchema: { readonly example: { readonly field_type: "Date"; readonly id: "a1_D"; readonly name: "custom_field_name"; }; readonly properties: { readonly field_type: { readonly enum: readonly ["Text", "Number", "Date"]; readonly type: "string"; }; readonly id: { readonly type: "string"; }; readonly name: { readonly maxLength: 100; readonly minLength: 1; readonly type: "string"; }; }; readonly required: readonly ["id", "name", "field_type"]; readonly title: "custom_field_definitions_response"; readonly type: "object"; }; export declare const design_common_fieldsSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/design-duplicate-input"; }, { readonly properties: { readonly categories: { readonly description: "The list of categories applied to the design"; readonly items: { readonly maxLength: 255; readonly type: "string"; }; readonly maxItems: 10; readonly type: "array"; readonly uniqueItems: true; }; readonly generate_plain_content: { readonly default: true; readonly description: "If true, plain_content is always generated from html_content. If false, plain_content is not altered."; readonly type: "boolean"; }; readonly subject: { readonly description: "Subject of the Design."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly type: "object"; }]; readonly title: "Design Common Fields"; }; export declare const design_duplicate_inputSchema: { readonly example: { readonly editor: "design"; readonly name: "Ahoy, Cake or Pie Cafe!"; }; readonly properties: { readonly editor: { readonly description: "The editor used in the UI."; readonly enum: readonly ["code", "design"]; readonly type: "string"; }; readonly name: { readonly default: "Duplicate:\n
| \n
<% body %>Example
\n"; }; readonly properties: { readonly enabled: { readonly description: "Indicates if the legacy email template setting is enabled."; readonly type: "boolean"; }; readonly html_content: { readonly description: "The HTML content that you want to use for your legacy email template."; readonly type: "string"; }; }; readonly title: "Mail Settings: Template"; readonly type: "object"; }; export declare const mako_eventSchema: { readonly example: { readonly bounce_type: "blocked"; readonly event_name: "bounced"; readonly http_user_agent: "in tempor ex dolore est"; readonly mx_server: "quis proident"; readonly processed: "2017-10-13T18:56:21Z"; readonly reason: "some reason"; readonly url: "http://3LX,MU}N=B8'd,K}>bEma{l~!ad%peIF}y>qHfLPWQ$l9b!6.1H?$Z9H\"il-_gZD>/JPYsGqH4x4_3v090TCtnFalXGFiAdooDxgrDAYNXShUywSxwYr8gKeyc/4sal4VJ3IxEWsG74V5MYQ0mz27jhy7n5DHsUtApQ6zXHS13uO5vYBlJHpJRfuT6/F5nIpkHre2w3eTtN7M6pg9V5stjnnsavKkzQxyTv15CMSDLFwR_BTZwofhWpyBU7B9ypYL79vT97N3LDZyoaM/fNsOLPIqfGBer_Mx9_StergbQYANyOmOSjR6pZof01ky/ZcNDhpu3CkSl4MTtQ3NMCX780pOKQ5SYIPigyvz9IC9WtrCNcOkTxdOPdY0_4MJU4EuTTPmGvO/14KaJCDjIjgrbIqpzuUEL5mET0t2VeVlwvtnOnlHaBE8sic20ze2E0Xt3ETqXyzVJRjLDKh/LWkW8OVp_xkLBCCW7LQngRukKcOiWjMXeCEhYI9HoZ0RsMEWZC8KzRaHc4OI0uXPD4M9pav1LGrI/_0t_RnBnfnqGKsBJr0kdQi/Y6QN_aeawIqX5hDNIU3MF/wWKVWLS0ZFbDfK6KVv5oAid83EpwKoazAMA8MTfEXvHQLO7k7XYWX1Il3eGXL6/wCA96I1SOabzJkZHo2HsFpIC/VBk52Lnpp0xtDH/OCdlQ5e4PpxXQeklp70LPOndr7QKSYEQNUc48n36ixvTjhgpgO8wHsFFYqGcuBMHg9oaCARppQomiQDWYuVPVDynJHdsM1_gWl4/NSs8Y9PL7DrQXOu0UiFRRE0TUsvgqyUgJzlGjUnRziyYeROO75D0K_3aTtbGbCmhaxecos40a1w0PDCNkFp1W/iHwY7922drhsoM6ShwqqwGpAh5HLuU6Q5gqyckeai6YN7HCh9DdHPhhJcatgtMHZDKfQUBVt9ecUlDgiCFF_OnRX/GpzttcsL8E2FoXL9_eAWvSqjodROqx7MZCA/ORdnR/IssPCYP1kTHTIL5mZxv4UGEpyNjUzt4GdSJJTm0nztltWDYX8_Ezl2JvpLVnGVTJxobb4yQIJhe3n64khbOFyFLKHWEniIolm/AxpZQYmseWlVqrIz3YXU59XaSbTTrdCHNhvwF1ogXiiggN6TZ2B3QY_mBEtAp/SD0ONPVqEUkTNAFWTgnnlv6ZIMdMbTw5uZwtFRlB7qDvQouml9kujGmRu6k7zZMTOwWowRNtpboLUcL2NzkVgK6N1Zi2vq/Nt4NJvM5_l1dpIIbwJv_CIcZQZOqPtRWULa2iVxfmJJQaqgLQPwSHQH1zuRJMhraEsPjqVQRC0pZpSt/24VBDN8y31Ye/y_ekWxMdZCvr978C/WrdcTi29kxjJLyT9BII7BsgT5vLuI2l7ntqRAhAUWMs/h9JR0i8RbX5OfB46q41/TfmSdgi97bCR2HfgflyypXwKhRfKYU2MVpu2Dd90WQUlm7hZV8dSfGusuMj/nPMpRVWcbnvlAdsehJCPbLv6n4qdLSPeoMBo32acAGgu1BwBG8JsBgbH43yYi5X7UdGRWKqm_ZbqaDEKH3ncU/uA8EOJb41VfGho4LUeOi1IeYwVAhFEyO6YbteYZecEubrNFZrWWjZUqhzouzY95TeWU8E4StCXVPKlYPiFiwUSX20kG0lVtDbAy/7u4f4x0cYlFOvI1UN1qoOExmNxnxzQQFeM5exWfW2JrRXq5e0UdAJr4q2o9Y_0WaGfhL/nP6Ei06YajDKr11dK5H0LX/9CGTC37HFZeopyopzP_7fvGFkqIRoGTS48pLaIFz3gwpQNlWXUFCsd/PnRlsqJ3SBQSgp_AQe2cP6iBNy2bJI8lkxwY5YVDDdjxusuCcafdjfs2aUa/4tr_iMnNBnd27GxjQI28_JGJlfbOaajVJOxuPMT4ELpYCfPiFjdSbJyE0/gCwtj0rgDKSLWJnOPJ5TAJ935gCqeIsBhOhfcZX413GdilBZRRYEjCVKfOuWzHZ3GW/8yjyk5e_WMNv5F6xggl07w90DBwpx/Q/iWfncqMuSfoeFeqHQkDL9F5W19j1cGuAcyfIYMAXztHXpgTKh9vZcsLYC7LcgKr4FQj3JjEvtnDG2PjcMjGF/MnbCRCz22Ho410_vE9M1Hpq0wdk_i5DbZKNoSwlPgey9URkpuX146TcDdsx_VWDenCepY5HwMr9CPOY9hzUs/c5AWeUMXk/gvsI81Jkv5rHpEnNBUZXYzfqkwQfffhmrc/StLCtzRRlja8dpsEWdkzoKR9Kdxq1qAs5f0sdrGjVRLTT_s1Q2P59zhA/QmS4bubi64cYot3gSIgdNnkjA2GjCp1ETVa548_U9B6boTKDVmaKJlVIDvqL84RC3WI7Er/8opi2lZ48W83Ur47BRh38oOnI0agrCyZz8bp1w_gfVRlSO8PS0i/l_/qxq5xpLbhPkdxVoyZVsNAZchfnmkIHyIk5IK6EUDXdMR21y6OvKW50ZbooAtk9ymynBj4dAYMsd25RV7FE1I1vRTsiDw52/.E5WC0Ymo2zn.qelSbhzr-4laArYiWP.dwJB6qm_6rs0Rm5UXYaYtUNbh76_jJp_X1xQUCDSgbr2KOkDU0\"Q/-4dV\"Yk3QGg[(O86=Pf\"e17K4'r{)kicofHSXcMmP@>VF^`~4j4F*L/1]tD+Lw!WI!@]*OZm6C`M$u96}*O