openapi

package
v4.0.0-rc.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 24, 2024 License: MIT Imports: 6 Imported by: 0

README

Go API client for

The Twilio SendGrid Legacy Marketing Campaigns Contacts API allows you to manage your marketing contacts programmatically. This API is operational, but we recommend using the current version of Marketing Campaigns' Contacts API, Lists API, and Segments API to manage your contacts.

See Migrating from Legacy Marketing Campaigns for more information.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/sendgrid-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version:
  • Build date: 2024-10-24T13:26:02.549192Z[Etc/UTC]
  • Build package: com.sendgrid.oai.go.SendgridGoGenerator For more information, please visit https://support.sendgrid.com/hc/en-us

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./"

Documentation for API Endpoints

All URIs are relative to https://api.sendgrid.com

Class Method HTTP request Description
AddRecipient AddRecipient Post /v3/contactdb/recipients Add recipients
AddRecipientToContactDbList AddRecipientToContactDbList Post /v3/contactdb/lists/{ListId}/recipients/{RecipientId} Add a Single Recipient to a List
AddRecipientsToContactDbList AddRecipientsToContactDbList Post /v3/contactdb/lists/{ListId}/recipients Add Multiple Recipients to a List
CreateContactDbList CreateContactDbList Post /v3/contactdb/lists Create a List
CreateCustomField CreateCustomField Post /v3/contactdb/custom_fields Create a Custom Field
CreateSegment CreateSegment Post /v3/contactdb/segments Create a Segment
DeleteContactDbList DeleteContactDbList Delete /v3/contactdb/lists/{ListId} Delete a List
DeleteContactDbLists DeleteContactDbLists Delete /v3/contactdb/lists Delete Multiple lists
DeleteCustomField DeleteCustomField Delete /v3/contactdb/custom_fields/{CustomFieldId} Delete a Custom Field
DeleteRecipient DeleteRecipient Delete /v3/contactdb/recipients/{RecipientId} Delete a Recipient
DeleteRecipientFromContactDbList DeleteRecipientFromContactDbList Delete /v3/contactdb/lists/{ListId}/recipients/{RecipientId} Delete a Single Recipient from a Single List
DeleteRecipients DeleteRecipients Delete /v3/contactdb/recipients Delete Recipients
DeleteSegment DeleteSegment Delete /v3/contactdb/segments/{SegmentId} Delete a segment
GetBillable GetBillable Get /v3/contactdb/recipients/billable_count Retrieve the count of billable recipients
GetContactDbList GetContactDbList Get /v3/contactdb/lists/{ListId} Retrieve a single list
GetCustomField GetCustomField Get /v3/contactdb/custom_fields/{CustomFieldId} Retrieve a Custom Field
GetRecipient GetRecipient Get /v3/contactdb/recipients/{RecipientId} Retrieve a single recipient
GetRecipientList GetRecipientList Get /v3/contactdb/recipients/{RecipientId}/lists Retrieve the lists that a recipient is on
GetSegment GetSegment Get /v3/contactdb/segments/{SegmentId} Retrieve a segment
ListContactDbList ListContactDbList Get /v3/contactdb/lists Retrieve all lists
ListCustomField ListCustomField Get /v3/contactdb/custom_fields Retrieve all custom fields
ListRecipient ListRecipient Get /v3/contactdb/recipients Retrieve recipients
ListRecipientCount ListRecipientCount Get /v3/contactdb/recipients/count Retrieve a Count of Recipients
ListRecipientForSegment ListRecipientForSegment Get /v3/contactdb/segments/{SegmentId}/recipients Retrieve recipients on a segment
ListRecipientsFromContactDbList ListRecipientsFromContactDbList Get /v3/contactdb/lists/{ListId}/recipients Retrieve all recipients on a List
ListReservedField ListReservedField Get /v3/contactdb/reserved_fields Retrieve reserved fields
ListSearchRecipient ListSearchRecipient Get /v3/contactdb/recipients/search Search recipients
ListSegment ListSegment Get /v3/contactdb/segments Retrieve all segments
ListStatus ListStatus Get /v3/contactdb/status Get Recipient Upload Status
SearchRecipient SearchRecipient Post /v3/contactdb/recipients/search Search recipients
UpdateContactDbList UpdateContactDbList Patch /v3/contactdb/lists/{ListId} Update a List
UpdateRecipient UpdateRecipient Patch /v3/contactdb/recipients Update Recipient
UpdateSegment UpdateSegment Patch /v3/contactdb/segments/{SegmentId} Update a segment

Documentation For Models

Documentation For Authorization

BearerAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddRecipientParam 

type AddRecipientParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	AddRecipientRequestInner *[]AddRecipientRequestInner `json:"AddRecipientRequestInner,omitempty"`
}

func (*AddRecipientParam) SetAddRecipientRequestInner 

func (params *AddRecipientParam) SetAddRecipientRequestInner(AddRecipientRequestInner []AddRecipientRequestInner) *AddRecipientParam

func (*AddRecipientParam) SetOnbehalfof 

func (params *AddRecipientParam) SetOnbehalfof(Onbehalfof string) *AddRecipientParam

type AddRecipientRequestInner 

type AddRecipientRequestInner struct {
	// The email address of the recipient.
	Email string `json:"email"`
	// The first name of the recipient.
	FirstName *string `json:"first_name,omitempty"`
	// The last name of the recipient.
	LastName *string `json:"last_name,omitempty"`
	Age      *int32  `json:"age,omitempty"`
}

AddRecipientRequestInner struct for AddRecipientRequestInner

type AddRecipientToContactDbListParam 

type AddRecipientToContactDbListParam struct {
	// The ID of the list that you want to add the recipient to.
	ListId *int32 `json:"list_id"`
	// The ID of the recipient you are adding to the list.
	RecipientId *string `json:"recipient_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*AddRecipientToContactDbListParam) SetListId 

func (params *AddRecipientToContactDbListParam) SetListId(ListId int32) *AddRecipientToContactDbListParam

func (*AddRecipientToContactDbListParam) SetOnbehalfof 

func (params *AddRecipientToContactDbListParam) SetOnbehalfof(Onbehalfof string) *AddRecipientToContactDbListParam

func (*AddRecipientToContactDbListParam) SetRecipientId 

func (params *AddRecipientToContactDbListParam) SetRecipientId(RecipientId string) *AddRecipientToContactDbListParam

type AddRecipientsToContactDbListParam 

type AddRecipientsToContactDbListParam struct {
	// The id of the list of recipients you want to retrieve.
	ListId *int32 `json:"list_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	RequestBody *[]string `json:"request_body,omitempty"`
}

func (*AddRecipientsToContactDbListParam) SetListId 

func (params *AddRecipientsToContactDbListParam) SetListId(ListId int32) *AddRecipientsToContactDbListParam

func (*AddRecipientsToContactDbListParam) SetOnbehalfof 

func (params *AddRecipientsToContactDbListParam) SetOnbehalfof(Onbehalfof string) *AddRecipientsToContactDbListParam

func (*AddRecipientsToContactDbListParam) SetRequestBody 

func (params *AddRecipientsToContactDbListParam) SetRequestBody(RequestBody []string) *AddRecipientsToContactDbListParam

type AndOr 

type AndOr string

AndOr the model 'AndOr' 

const (
	ANDOR_AND   AndOr = "and"
	ANDOR_OR    AndOr = "or"
	ANDOR_EMPTY AndOr = ""
)

List of AndOr

type ApiService 

type ApiService struct {
	// contains filtered or unexported fields
}

func NewApiService 

func NewApiService(requestHandler *sendgrid.RequestHandler) *ApiService

func NewApiServiceWithClient 

func NewApiServiceWithClient(client sendgrid.BaseClient) *ApiService

func (*ApiService) AddRecipient 

func (c *ApiService) AddRecipient(params *AddRecipientParam) (interface{}, error)

**This endpoint allows you to add a Marketing Campaigns recipient.** You can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields SendGrid provides. The rate limit is three requests every 2 seconds. You can upload 1000 contacts per request. So the maximum upload rate is 1500 recipients per second.

func (*ApiService) AddRecipientToContactDbList 

func (c *ApiService) AddRecipientToContactDbList(params *AddRecipientToContactDbListParam) (interface{}, error)

**This endpoint allows you to add a single recipient to a list.**

func (*ApiService) AddRecipientsToContactDbList 

func (c *ApiService) AddRecipientsToContactDbList(params *AddRecipientsToContactDbListParam) (interface{}, error)

**This endpoint allows you to add multiple recipients to a list.** Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs (base64-encoded email addresses) should be passed exactly as they are returned from recipient endpoints.

func (*ApiService) CreateContactDbList 

func (c *ApiService) CreateContactDbList(params *CreateContactDbListParam) (interface{}, error)

**This endpoint allows you to create a list for your recipients.**

func (*ApiService) CreateCustomField 

func (c *ApiService) CreateCustomField(params *CreateCustomFieldParam) (interface{}, error)

**This endpoint allows you to create a custom field.** **You can create up to 120 custom fields.**

func (*ApiService) CreateSegment 

func (c *ApiService) CreateSegment(params *CreateSegmentParam) (interface{}, error)

**This endpoint allows you to create a new segment.** Valid operators for create and update depend on the type of the field for which you are searching. **Dates** - \"eq\", \"ne\", \"lt\" (before), \"gt\" (after) - You may use MM/DD/YYYY for day granularity or an epoch for second granularity. - \"empty\", \"not_empty\" - \"is within\" - You may use an [ISO 8601 date format](https://en.wikipedia.org/wiki/ISO_8601) or the # of days. **Text** - \"contains\" - \"eq\" (is/equals - matches the full field) - \"ne\" (is not/not equals - matches any field where the entire field is not the condition value) - \"empty\" - \"not_empty\" **Numbers** - \"eq\" (is/equals) - \"lt\" (is less than) - \"gt\" (is greater than) - \"empty\" - \"not_empty\" **Email Clicks and Opens** - \"eq\" (opened) - \"ne\" (not opened) All field values must be a string. Conditions using \"eq\" or \"ne\" for email clicks and opens should provide a \"field\" of either `clicks.campaign_identifier` or `opens.campaign_identifier`. The condition value should be a string containing the id of a completed campaign. The conditions list may contain multiple conditions, joined by an \"and\" or \"or\" in the \"and_or\" field. The first condition in the conditions list must have an empty \"and_or\", and subsequent conditions must all specify an \"and_or\".

func (*ApiService) DeleteContactDbList 

func (c *ApiService) DeleteContactDbList(params *DeleteContactDbListParam) (interface{}, error)

**This endpoint allows you to delete a specific recipient list with the given ID.**

func (*ApiService) DeleteContactDbLists 

func (c *ApiService) DeleteContactDbLists(params *DeleteContactDbListsParam) (interface{}, error)

**This endpoint allows you to delete multiple recipient lists.**

func (*ApiService) DeleteCustomField 

func (c *ApiService) DeleteCustomField(params *DeleteCustomFieldParam) (interface{}, error)

**This endpoint allows you to delete a custom field by ID.**

func (*ApiService) DeleteRecipient 

func (c *ApiService) DeleteRecipient(params *DeleteRecipientParam) (interface{}, error)

**This endpoint allows you to delete a single recipient with the given ID from your contact database.** > Use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law.

func (*ApiService) DeleteRecipientFromContactDbList 

func (c *ApiService) DeleteRecipientFromContactDbList(params *DeleteRecipientFromContactDbListParam) (interface{}, error)

**This endpoint allows you to delete a single recipient from a list.**

func (*ApiService) DeleteRecipients 

func (c *ApiService) DeleteRecipients(params *DeleteRecipientsParam) (interface{}, error)

**This endpoint allows you to deletes one or more recipients.** The body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete.

func (*ApiService) DeleteSegment 

func (c *ApiService) DeleteSegment(params *DeleteSegmentParam) (interface{}, error)

**This endpoint allows you to delete a segment from your recipients database.** You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.

func (*ApiService) GetBillable 

func (c *ApiService) GetBillable(params *GetBillableParam) (interface{}, error)

**This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for.** You are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable count value.

func (*ApiService) GetContactDbList 

func (c *ApiService) GetContactDbList(params *GetContactDbListParam) (interface{}, error)

**This endpoint allows you to retrieve a single recipient list.**

func (*ApiService) GetCustomField 

func (c *ApiService) GetCustomField(params *GetCustomFieldParam) (interface{}, error)

**This endpoint allows you to retrieve a custom field by ID.**

func (*ApiService) GetRecipient 

func (c *ApiService) GetRecipient(params *GetRecipientParam) (interface{}, error)

**This endpoint allows you to retrieve a single recipient by ID from your contact database.**

func (*ApiService) GetRecipientList 

func (c *ApiService) GetRecipientList(params *GetRecipientListParam) (interface{}, error)

**This endpoint allows you to retrieve the lists that a given recipient belongs to.** Each recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to.

func (*ApiService) GetSegment 

func (c *ApiService) GetSegment(params *GetSegmentParam) (interface{}, error)

**This endpoint allows you to retrieve a single segment with the given ID.**

func (*ApiService) ListContactDbList 

func (c *ApiService) ListContactDbList(params *ListContactDbListParam) (interface{}, error)

**This endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned.**

func (*ApiService) ListCustomField 

func (c *ApiService) ListCustomField(params *ListCustomFieldParam) (interface{}, error)

**This endpoint allows you to retrieve all custom fields.**

func (*ApiService) ListRecipient 

func (c *ApiService) ListRecipient(params *ListRecipientParam) (interface{}, error)

**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.** Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved.

func (*ApiService) ListRecipientCount 

func (c *ApiService) ListRecipientCount(params *ListRecipientCountParam) (interface{}, error)

**This endpoint allows you to retrieve the total number of Marketing Campaigns recipients.**

func (*ApiService) ListRecipientForSegment 

func (c *ApiService) ListRecipientForSegment(params *ListRecipientForSegmentParam) (interface{}, error)

**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.**

func (*ApiService) ListRecipientsFromContactDbList 

func (c *ApiService) ListRecipientsFromContactDbList(params *ListRecipientsFromContactDbListParam) (interface{}, error)

**This endpoint allows you to retrieve all recipients on the list with the given ID.**

func (*ApiService) ListReservedField 

func (c *ApiService) ListReservedField(params *ListReservedFieldParam) (interface{}, error)

**This endpoint allows you to list all fields that are reserved and can't be used for custom field names.**

func (*ApiService) ListSearchRecipient 

func (c *ApiService) ListSearchRecipient(params *ListSearchRecipientParam) (interface{}, error)

**This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.** field_name: * is a variable that is substituted for your actual custom field name from your recipient. * Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/2015 becomes 1422835200) * If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert your epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to Mon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through Mon, 02 Feb 2015 23:59:59 GMT.

func (*ApiService) ListSegment 

func (c *ApiService) ListSegment(params *ListSegmentParam) (interface{}, error)

**This endpoint allows you to retrieve all of your segments.**

func (*ApiService) ListStatus 

func (c *ApiService) ListStatus(params *ListStatusParam) (interface{}, error)

**This endpoint allows you to check the upload status of a Marketing Campaigns recipient.**

func (*ApiService) SearchRecipient 

func (c *ApiService) SearchRecipient(params *SearchRecipientParam) (interface{}, error)

Search using segment conditions without actually creating a segment. Body contains a JSON object with `conditions`, a list of conditions as described below, and an optional `list_id`, which is a valid list ID for a list to limit the search on. Valid operators for create and update depend on the type of the field for which you are searching. - Dates: - `\"eq\"`, `\"ne\"`, `\"lt\"` (before), `\"gt\"` (after) - You may use MM/DD/YYYY for day granularity or an epoch for second granularity. - `\"empty\"`, `\"not_empty\"` - `\"is within\"` - You may use an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format or the # of days. - Text: `\"contains\"`, `\"eq\"` (is - matches the full field), `\"ne\"` (is not - matches any field where the entire field is not the condition value), `\"empty\"`, `\"not_empty\"` - Numbers: `\"eq\"`, `\"lt\"`, `\"gt\"`, `\"empty\"`, `\"not_empty\"` - Email Clicks and Opens: `\"eq\"` (opened), `\"ne\"` (not opened) Field values must all be a string. Search conditions using `\"eq\"` or `\"ne\"` for email clicks and opens should provide a \"field\" of either `clicks.campaign_identifier` or `opens.campaign_identifier`. The condition value should be a string containing the id of a completed campaign. Search conditions list may contain multiple conditions, joined by an `\"and\"` or `\"or\"` in the `\"and_or\"` field. The first condition in the conditions list must have an empty `\"and_or\"`, and subsequent conditions must all specify an `\"and_or\"`.

func (*ApiService) UpdateContactDbList 

func (c *ApiService) UpdateContactDbList(params *UpdateContactDbListParam) (interface{}, error)

**This endpoint allows you to update the name of one of your recipient lists.**

func (*ApiService) UpdateRecipient 

func (c *ApiService) UpdateRecipient(params *UpdateRecipientParam) (interface{}, error)

**This endpoint allows you to update one or more recipients.** The body of an API call to this endpoint must include an array of one or more recipient objects. It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides.

func (*ApiService) UpdateSegment 

func (c *ApiService) UpdateSegment(params *UpdateSegmentParam) (interface{}, error)

**This endpoint allows you to update a segment.**

type ContactdbCustomField 

type ContactdbCustomField struct {
	// The name of the field
	Name *string `json:"name,omitempty"`
	// The type of the field.
	Type *Type `json:"type,omitempty"`
}

ContactdbCustomField struct for ContactdbCustomField

type ContactdbCustomFieldId2xx 

type ContactdbCustomFieldId2xx struct {
	// The name of the field
	Name *string `json:"name,omitempty"`
	// The type of the field.
	Type *Type `json:"type,omitempty"`
	// The ID of the custom field.
	Id *float32 `json:"id,omitempty"`
}

ContactdbCustomFieldId2xx struct for ContactdbCustomFieldId2xx

type ContactdbCustomFieldIdValue 

type ContactdbCustomFieldIdValue struct {
	// The name of the field
	Name *string `json:"name,omitempty"`
	// The type of the field.
	Type *Type `json:"type,omitempty"`
	// The ID of the custom field.
	Id *float32 `json:"id,omitempty"`
	// The value of this recipient's custom field
	Value *string `json:"value,omitempty"`
}

ContactdbCustomFieldIdValue struct for ContactdbCustomFieldIdValue

type ContactdbList2xx 

type ContactdbList2xx struct {
	// The reference ID of your list.
	Id int32 `json:"id"`
	// The name of your list. Must be unique against all other list and segment names.
	Name string `json:"name"`
	// The count of recipients currently in the list.
	RecipientCount int32 `json:"recipient_count"`
}

ContactdbList2xx struct for ContactdbList2xx

type ContactdbRecipient200 

type ContactdbRecipient200 struct {
	Recipients *[]ContactdbRecipient200RecipientsInner `json:"recipients,omitempty"`
}

ContactdbRecipient200 struct for ContactdbRecipient200

type ContactdbRecipient200RecipientsInner 

type ContactdbRecipient200RecipientsInner struct {
	// The ID of this recipient.
	Id *string `json:"id,omitempty"`
	// The time this record was created in your contactdb, in unixtime.
	CreatedAt *float32 `json:"created_at,omitempty"`
	// The custom fields assigned to this recipient and their values.
	CustomFields *[]ContactdbCustomFieldIdValue `json:"custom_fields,omitempty"`
	// The email address of this recipient. This is a default custom field that SendGrid provides.
	Email string `json:"email"`
	// The first name of this recipient. This is a default custom field that SendGrid provides.
	FirstName *string `json:"first_name,omitempty"`
	// The last name of the recipient.
	LastName *string `json:"last_name,omitempty"`
	// The last time this recipient clicked a link from one of your campaigns, in unixtime.
	LastClicked *float32 `json:"last_clicked,omitempty"`
	// The last time this user was emailed by one of your campaigns, in unixtime.
	LastEmailed *float32 `json:"last_emailed,omitempty"`
	// The last time this recipient opened an email from you, in unixtime.
	LastOpened *float32 `json:"last_opened,omitempty"`
	// The last update date for this recipient's record.
	UpdatedAt *float32 `json:"updated_at,omitempty"`
}

ContactdbRecipient200RecipientsInner struct for ContactdbRecipient200RecipientsInner

type ContactdbRecipientCount200 

type ContactdbRecipientCount200 struct {
	// The count of recipients.
	RecipientCount float32 `json:"recipient_count"`
}

ContactdbRecipientCount200 struct for ContactdbRecipientCount200

type ContactdbRecipientResponse201 

type ContactdbRecipientResponse201 struct {
	// The number of errors found while adding recipients.
	ErrorCount float32 `json:"error_count"`
	// The indices of the recipient(s) sent that caused the error.
	ErrorIndices *[]float32 `json:"error_indices,omitempty"`
	// The count of new recipients added to the contactdb.
	NewCount float32 `json:"new_count"`
	// The recipient IDs of the recipients that already existed from this request.
	PersistedRecipients []string `json:"persisted_recipients"`
	// The recipients who were updated from this request.
	UpdatedCount float32                                     `json:"updated_count"`
	Errors       *[]ContactdbRecipientResponse201ErrorsInner `json:"errors,omitempty"`
}

ContactdbRecipientResponse201 struct for ContactdbRecipientResponse201

type ContactdbRecipientResponse201ErrorsInner 

type ContactdbRecipientResponse201ErrorsInner struct {
	Message      *string    `json:"message,omitempty"`
	ErrorIndices *[]float32 `json:"error_indices,omitempty"`
}

ContactdbRecipientResponse201ErrorsInner struct for ContactdbRecipientResponse201ErrorsInner

type ContactdbSegments 

type ContactdbSegments struct {
	// The name of this segment.
	Name string `json:"name"`
	// 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.
	ListId *int32 `json:"list_id,omitempty"`
	// The conditions for a recipient to be included in this segment.
	Conditions []ContactdbSegmentsConditions `json:"conditions"`
	// The count of recipients in this list. This is not included on creation of segments.
	RecipientCount *float32 `json:"recipient_count,omitempty"`
}

ContactdbSegments struct for ContactdbSegments

type ContactdbSegmentsConditions 

type ContactdbSegmentsConditions struct {
	Field    string   `json:"field"`
	Value    string   `json:"value"`
	Operator Operator `json:"operator"`
	AndOr    *AndOr   `json:"and_or,omitempty"`
}

ContactdbSegmentsConditions struct for ContactdbSegmentsConditions

type ContactdbSegmentsId200 

type ContactdbSegmentsId200 struct {
	// The ID of the segment.
	Id float32 `json:"id"`
	// The name of this segment.
	Name string `json:"name"`
	// 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.
	ListId *int32 `json:"list_id,omitempty"`
	// The conditions for a recipient to be included in this segment.
	Conditions []ContactdbSegmentsConditions `json:"conditions"`
	// The count of recipients in this list. This is not included on creation of segments.
	RecipientCount *float32 `json:"recipient_count,omitempty"`
}

ContactdbSegmentsId200 struct for ContactdbSegmentsId200

type CreateAListRequest 

type CreateAListRequest struct {
	Name string `json:"name"`
}

CreateAListRequest struct for CreateAListRequest

type CreateContactDbListParam 

type CreateContactDbListParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	CreateAListRequest *CreateAListRequest `json:"CreateAListRequest,omitempty"`
}

func (*CreateContactDbListParam) SetCreateAListRequest 

func (params *CreateContactDbListParam) SetCreateAListRequest(CreateAListRequest CreateAListRequest) *CreateContactDbListParam

func (*CreateContactDbListParam) SetOnbehalfof 

func (params *CreateContactDbListParam) SetOnbehalfof(Onbehalfof string) *CreateContactDbListParam

type CreateCustomFieldParam 

type CreateCustomFieldParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	CreateCustomFieldRequest *CreateCustomFieldRequest `json:"CreateCustomFieldRequest,omitempty"`
}

func (*CreateCustomFieldParam) SetCreateCustomFieldRequest 

func (params *CreateCustomFieldParam) SetCreateCustomFieldRequest(CreateCustomFieldRequest CreateCustomFieldRequest) *CreateCustomFieldParam

func (*CreateCustomFieldParam) SetOnbehalfof 

func (params *CreateCustomFieldParam) SetOnbehalfof(Onbehalfof string) *CreateCustomFieldParam

type CreateCustomFieldRequest 

type CreateCustomFieldRequest struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

CreateCustomFieldRequest struct for CreateCustomFieldRequest

type CreateSegmentParam 

type CreateSegmentParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	ContactdbSegments *ContactdbSegments `json:"ContactdbSegments,omitempty"`
}

func (*CreateSegmentParam) SetContactdbSegments 

func (params *CreateSegmentParam) SetContactdbSegments(ContactdbSegments ContactdbSegments) *CreateSegmentParam

func (*CreateSegmentParam) SetOnbehalfof 

func (params *CreateSegmentParam) SetOnbehalfof(Onbehalfof string) *CreateSegmentParam

type DeleteContactDbListParam 

type DeleteContactDbListParam struct {
	//
	ListId *int32 `json:"list_id"`
	// Adds the ability to delete all contacts on the list in addition to deleting the list.
	DeleteContacts *DeleteContacts `json:"delete_contacts,omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	Body *interface{} `json:"body,omitempty"`
}

func (*DeleteContactDbListParam) SetBody 

func (params *DeleteContactDbListParam) SetBody(Body interface{}) *DeleteContactDbListParam

func (*DeleteContactDbListParam) SetDeleteContacts 

func (params *DeleteContactDbListParam) SetDeleteContacts(DeleteContacts DeleteContacts) *DeleteContactDbListParam

func (*DeleteContactDbListParam) SetListId 

func (params *DeleteContactDbListParam) SetListId(ListId int32) *DeleteContactDbListParam

func (*DeleteContactDbListParam) SetOnbehalfof 

func (params *DeleteContactDbListParam) SetOnbehalfof(Onbehalfof string) *DeleteContactDbListParam

type DeleteContactDbListsParam 

type DeleteContactDbListsParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	RequestBody *[]int32 `json:"request_body,omitempty"`
}

func (*DeleteContactDbListsParam) SetOnbehalfof 

func (params *DeleteContactDbListsParam) SetOnbehalfof(Onbehalfof string) *DeleteContactDbListsParam

func (*DeleteContactDbListsParam) SetRequestBody 

func (params *DeleteContactDbListsParam) SetRequestBody(RequestBody []int32) *DeleteContactDbListsParam

type DeleteContacts 

type DeleteContacts bool

DeleteContacts the model 'DeleteContacts' 

const (
	DELETECONTACTS_TRUE  DeleteContacts = true
	DELETECONTACTS_FALSE DeleteContacts = false
)

List of DeleteContacts

type DeleteCustomFieldParam 

type DeleteCustomFieldParam struct {
	// The ID of the custom field that you want to retrieve.
	CustomFieldId *int32 `json:"custom_field_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*DeleteCustomFieldParam) SetCustomFieldId 

func (params *DeleteCustomFieldParam) SetCustomFieldId(CustomFieldId int32) *DeleteCustomFieldParam

func (*DeleteCustomFieldParam) SetOnbehalfof 

func (params *DeleteCustomFieldParam) SetOnbehalfof(Onbehalfof string) *DeleteCustomFieldParam

type DeleteRecipientFromContactDbListParam 

type DeleteRecipientFromContactDbListParam struct {
	// The ID of the list that you want to add the recipient to.
	ListId *int32 `json:"list_id"`
	// The ID of the recipient you are adding to the list.
	RecipientId *string `json:"recipient_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	Body *interface{} `json:"body,omitempty"`
}

func (*DeleteRecipientFromContactDbListParam) SetBody 

func (params *DeleteRecipientFromContactDbListParam) SetBody(Body interface{}) *DeleteRecipientFromContactDbListParam

func (*DeleteRecipientFromContactDbListParam) SetListId 

func (params *DeleteRecipientFromContactDbListParam) SetListId(ListId int32) *DeleteRecipientFromContactDbListParam

func (*DeleteRecipientFromContactDbListParam) SetOnbehalfof 

func (params *DeleteRecipientFromContactDbListParam) SetOnbehalfof(Onbehalfof string) *DeleteRecipientFromContactDbListParam

func (*DeleteRecipientFromContactDbListParam) SetRecipientId 

func (params *DeleteRecipientFromContactDbListParam) SetRecipientId(RecipientId string) *DeleteRecipientFromContactDbListParam

type DeleteRecipientParam 

type DeleteRecipientParam struct {
	// The ID of the recipient that you want to retrieve.
	RecipientId *string `json:"recipient_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*DeleteRecipientParam) SetOnbehalfof 

func (params *DeleteRecipientParam) SetOnbehalfof(Onbehalfof string) *DeleteRecipientParam

func (*DeleteRecipientParam) SetRecipientId 

func (params *DeleteRecipientParam) SetRecipientId(RecipientId string) *DeleteRecipientParam

type DeleteRecipientsParam 

type DeleteRecipientsParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	RequestBody *[]string `json:"request_body,omitempty"`
}

func (*DeleteRecipientsParam) SetOnbehalfof 

func (params *DeleteRecipientsParam) SetOnbehalfof(Onbehalfof string) *DeleteRecipientsParam

func (*DeleteRecipientsParam) SetRequestBody 

func (params *DeleteRecipientsParam) SetRequestBody(RequestBody []string) *DeleteRecipientsParam

type DeleteSegmentParam 

type DeleteSegmentParam struct {
	//
	SegmentId *int32 `json:"segment_id"`
	// True to delete all contacts matching the segment in addition to deleting the segment
	DeleteContacts *bool `json:"delete_contacts,omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	Body *interface{} `json:"body,omitempty"`
}

func (*DeleteSegmentParam) SetBody 

func (params *DeleteSegmentParam) SetBody(Body interface{}) *DeleteSegmentParam

func (*DeleteSegmentParam) SetDeleteContacts 

func (params *DeleteSegmentParam) SetDeleteContacts(DeleteContacts bool) *DeleteSegmentParam

func (*DeleteSegmentParam) SetOnbehalfof 

func (params *DeleteSegmentParam) SetOnbehalfof(Onbehalfof string) *DeleteSegmentParam

func (*DeleteSegmentParam) SetSegmentId 

func (params *DeleteSegmentParam) SetSegmentId(SegmentId int32) *DeleteSegmentParam

type ErrorResponse 

type ErrorResponse struct {
	Errors *[]ErrorResponseErrorsInner `json:"errors,omitempty"`
	// When applicable, this property value will be an error ID.
	Id *string `json:"id,omitempty"`
}

ErrorResponse struct for ErrorResponse

type ErrorResponseErrorsInner 

type ErrorResponseErrorsInner struct {
	// An error message.
	Message *string `json:"message,omitempty"`
	// When applicable, this property value will be the field that generated the error.
	Field *string `json:"field,omitempty"`
	// When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error.
	Help *map[string]interface{} `json:"help,omitempty"`
}

ErrorResponseErrorsInner struct for ErrorResponseErrorsInner

type GetBillableParam 

type GetBillableParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*GetBillableParam) SetOnbehalfof 

func (params *GetBillableParam) SetOnbehalfof(Onbehalfof string) *GetBillableParam

type GetContactDbListParam 

type GetContactDbListParam struct {
	//
	ListId *int32 `json:"list_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*GetContactDbListParam) SetListId 

func (params *GetContactDbListParam) SetListId(ListId int32) *GetContactDbListParam

func (*GetContactDbListParam) SetOnbehalfof 

func (params *GetContactDbListParam) SetOnbehalfof(Onbehalfof string) *GetContactDbListParam

type GetCustomFieldParam 

type GetCustomFieldParam struct {
	// The ID of the custom field that you want to retrieve.
	CustomFieldId *int32 `json:"custom_field_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*GetCustomFieldParam) SetCustomFieldId 

func (params *GetCustomFieldParam) SetCustomFieldId(CustomFieldId int32) *GetCustomFieldParam

func (*GetCustomFieldParam) SetOnbehalfof 

func (params *GetCustomFieldParam) SetOnbehalfof(Onbehalfof string) *GetCustomFieldParam

type GetRecipientList200Response 

type GetRecipientList200Response struct {
	Lists *[]ContactdbList2xx `json:"lists,omitempty"`
}

GetRecipientList200Response struct for GetRecipientList200Response

type GetRecipientListParam 

type GetRecipientListParam struct {
	// The ID of the recipient for whom you are retrieving lists.
	RecipientId *string `json:"recipient_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*GetRecipientListParam) SetOnbehalfof 

func (params *GetRecipientListParam) SetOnbehalfof(Onbehalfof string) *GetRecipientListParam

func (*GetRecipientListParam) SetRecipientId 

func (params *GetRecipientListParam) SetRecipientId(RecipientId string) *GetRecipientListParam

type GetRecipientParam 

type GetRecipientParam struct {
	// The ID of the recipient that you want to retrieve.
	RecipientId *string `json:"recipient_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*GetRecipientParam) SetOnbehalfof 

func (params *GetRecipientParam) SetOnbehalfof(Onbehalfof string) *GetRecipientParam

func (*GetRecipientParam) SetRecipientId 

func (params *GetRecipientParam) SetRecipientId(RecipientId string) *GetRecipientParam

type GetSegmentParam 

type GetSegmentParam struct {
	//
	SegmentId *int32 `json:"segment_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*GetSegmentParam) SetOnbehalfof 

func (params *GetSegmentParam) SetOnbehalfof(Onbehalfof string) *GetSegmentParam

func (*GetSegmentParam) SetSegmentId 

func (params *GetSegmentParam) SetSegmentId(SegmentId int32) *GetSegmentParam

type ListAllCustomFieldsResponse 

type ListAllCustomFieldsResponse struct {
	CustomFields []ContactdbCustomFieldId2xx `json:"custom_fields"`
}

ListAllCustomFieldsResponse struct for ListAllCustomFieldsResponse

type ListAllListsResponse 

type ListAllListsResponse struct {
	Lists []ContactdbList2xx `json:"lists"`
}

ListAllListsResponse struct for ListAllListsResponse

type ListAllSegmentsResponse 

type ListAllSegmentsResponse struct {
	Segments []ContactdbSegments `json:"segments"`
}

ListAllSegmentsResponse struct for ListAllSegmentsResponse

type ListContactDbListParam 

type ListContactDbListParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListContactDbListParam) SetOnbehalfof 

func (params *ListContactDbListParam) SetOnbehalfof(Onbehalfof string) *ListContactDbListParam

type ListCustomFieldParam 

type ListCustomFieldParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListCustomFieldParam) SetOnbehalfof 

func (params *ListCustomFieldParam) SetOnbehalfof(Onbehalfof string) *ListCustomFieldParam

type ListRecipientCountParam 

type ListRecipientCountParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListRecipientCountParam) SetOnbehalfof 

func (params *ListRecipientCountParam) SetOnbehalfof(Onbehalfof string) *ListRecipientCountParam

type ListRecipientForSegmentParam 

type ListRecipientForSegmentParam struct {
	// The ID of the segment from which you want to retrieve recipients.
	SegmentId *int32 `json:"segment_id"`
	//
	Page *int32 `json:"page,omitempty"`
	//
	PageSize *int32 `json:"page_size,omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListRecipientForSegmentParam) SetOnbehalfof 

func (params *ListRecipientForSegmentParam) SetOnbehalfof(Onbehalfof string) *ListRecipientForSegmentParam

func (*ListRecipientForSegmentParam) SetPage 

func (params *ListRecipientForSegmentParam) SetPage(Page int32) *ListRecipientForSegmentParam

func (*ListRecipientForSegmentParam) SetPageSize 

func (params *ListRecipientForSegmentParam) SetPageSize(PageSize int32) *ListRecipientForSegmentParam

func (*ListRecipientForSegmentParam) SetSegmentId 

func (params *ListRecipientForSegmentParam) SetSegmentId(SegmentId int32) *ListRecipientForSegmentParam

type ListRecipientParam 

type ListRecipientParam struct {
	// Page index of first recipients to return (must be a positive integer)
	Page *int32 `json:"page,omitempty"`
	// Number of recipients to return at a time (must be a positive integer between 1 and 1000)
	PageSize *int32 `json:"page_size,omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListRecipientParam) SetOnbehalfof 

func (params *ListRecipientParam) SetOnbehalfof(Onbehalfof string) *ListRecipientParam

func (*ListRecipientParam) SetPage 

func (params *ListRecipientParam) SetPage(Page int32) *ListRecipientParam

func (*ListRecipientParam) SetPageSize 

func (params *ListRecipientParam) SetPageSize(PageSize int32) *ListRecipientParam

type ListRecipientsFromContactDbList200Response 

type ListRecipientsFromContactDbList200Response struct {
	Recipients *[]ContactdbRecipient200 `json:"recipients,omitempty"`
}

ListRecipientsFromContactDbList200Response struct for ListRecipientsFromContactDbList200Response

type ListRecipientsFromContactDbListParam 

type ListRecipientsFromContactDbListParam struct {
	// The id of the list of recipients you want to retrieve.
	ListId *int32 `json:"list_id"`
	// Page index of first recipient to return (must be a positive integer)
	Page *int32 `json:"page,omitempty"`
	// Number of recipients to return at a time (must be a positive integer between 1 and 1000)
	PageSize *int32 `json:"page_size,omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListRecipientsFromContactDbListParam) SetListId 

func (params *ListRecipientsFromContactDbListParam) SetListId(ListId int32) *ListRecipientsFromContactDbListParam

func (*ListRecipientsFromContactDbListParam) SetOnbehalfof 

func (params *ListRecipientsFromContactDbListParam) SetOnbehalfof(Onbehalfof string) *ListRecipientsFromContactDbListParam

func (*ListRecipientsFromContactDbListParam) SetPage 

func (params *ListRecipientsFromContactDbListParam) SetPage(Page int32) *ListRecipientsFromContactDbListParam

func (*ListRecipientsFromContactDbListParam) SetPageSize 

func (params *ListRecipientsFromContactDbListParam) SetPageSize(PageSize int32) *ListRecipientsFromContactDbListParam

type ListRecipientsOnASegmentResponse 

type ListRecipientsOnASegmentResponse struct {
	Recipients []ContactdbRecipient200 `json:"recipients"`
}

ListRecipientsOnASegmentResponse struct for ListRecipientsOnASegmentResponse

type ListRecipientsResponse 

type ListRecipientsResponse struct {
	Recipients []map[string]interface{} `json:"recipients"`
}

ListRecipientsResponse struct for ListRecipientsResponse

type ListReservedField200Response 

type ListReservedField200Response struct {
	ReservedFields *[]ListReservedField200ResponseReservedFieldsInner `json:"reserved_fields,omitempty"`
}

ListReservedField200Response struct for ListReservedField200Response

type ListReservedField200ResponseReservedFieldsInner 

type ListReservedField200ResponseReservedFieldsInner struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

ListReservedField200ResponseReservedFieldsInner struct for ListReservedField200ResponseReservedFieldsInner

type ListReservedFieldParam 

type ListReservedFieldParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListReservedFieldParam) SetOnbehalfof 

func (params *ListReservedFieldParam) SetOnbehalfof(Onbehalfof string) *ListReservedFieldParam

type ListSearchRecipientParam 

type ListSearchRecipientParam struct {
	//
	FieldName *string `json:"{field_name},omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListSearchRecipientParam) SetFieldName 

func (params *ListSearchRecipientParam) SetFieldName(FieldName string) *ListSearchRecipientParam

func (*ListSearchRecipientParam) SetOnbehalfof 

func (params *ListSearchRecipientParam) SetOnbehalfof(Onbehalfof string) *ListSearchRecipientParam

type ListSegmentParam 

type ListSegmentParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListSegmentParam) SetOnbehalfof 

func (params *ListSegmentParam) SetOnbehalfof(Onbehalfof string) *ListSegmentParam

type ListStatus200Response 

type ListStatus200Response struct {
	Status *[]ListStatus200ResponseStatusInner `json:"status,omitempty"`
}

ListStatus200Response struct for ListStatus200Response

type ListStatus200ResponseStatusInner 

type ListStatus200ResponseStatusInner struct {
	// Valid values are \"worker_delay\" and \"worker_delay_seconds\" (the second value appears only if \"worker_delay\" has a value of \"delayed\").
	Id *string `json:"id,omitempty"`
	// Valid values for the ID \"worker_delay\" are \"OK\" or \"Delayed\". Valid values for the ID \"worker_delay_seconds\" is the time of delay to upload.
	Value *string `json:"value,omitempty"`
}

ListStatus200ResponseStatusInner struct for ListStatus200ResponseStatusInner

type ListStatusParam 

type ListStatusParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListStatusParam) SetOnbehalfof 

func (params *ListStatusParam) SetOnbehalfof(Onbehalfof string) *ListStatusParam

type Operator 

type Operator string

Operator the model 'Operator' 

const (
	OPERATOR_EQ       Operator = "eq"
	OPERATOR_NE       Operator = "ne"
	OPERATOR_LT       Operator = "lt"
	OPERATOR_GT       Operator = "gt"
	OPERATOR_CONTAINS Operator = "contains"
)

List of Operator

type SearchRecipient200Response 

type SearchRecipient200Response struct {
	Recipients     *[]SearchRecipient200ResponseRecipientsInner `json:"recipients,omitempty"`
	RecipientCount *int32                                       `json:"recipient_count,omitempty"`
}

SearchRecipient200Response struct for SearchRecipient200Response

type SearchRecipient200ResponseRecipientsInner 

type SearchRecipient200ResponseRecipientsInner struct {
	CreatedAt    *int32                                                        `json:"created_at,omitempty"`
	Email        *string                                                       `json:"email,omitempty"`
	Id           *string                                                       `json:"id,omitempty"`
	LastEmailed  *int32                                                        `json:"last_emailed,omitempty"`
	LastClicked  *int32                                                        `json:"last_clicked,omitempty"`
	LastOpened   *int32                                                        `json:"last_opened,omitempty"`
	CustomFields *[]SearchRecipient200ResponseRecipientsInnerCustomFieldsInner `json:"custom_fields,omitempty"`
	UpdatedAt    *int32                                                        `json:"updated_at,omitempty"`
	FirstName    *string                                                       `json:"first_name,omitempty"`
}

SearchRecipient200ResponseRecipientsInner struct for SearchRecipient200ResponseRecipientsInner

type SearchRecipient200ResponseRecipientsInnerCustomFieldsInner 

type SearchRecipient200ResponseRecipientsInnerCustomFieldsInner struct {
	Id    *int32                                                           `json:"id,omitempty"`
	Name  *string                                                          `json:"name,omitempty"`
	Value *SearchRecipient200ResponseRecipientsInnerCustomFieldsInnerValue `json:"value,omitempty"`
	Type  *string                                                          `json:"type,omitempty"`
}

SearchRecipient200ResponseRecipientsInnerCustomFieldsInner struct for SearchRecipient200ResponseRecipientsInnerCustomFieldsInner

type SearchRecipient200ResponseRecipientsInnerCustomFieldsInnerValue 

type SearchRecipient200ResponseRecipientsInnerCustomFieldsInnerValue struct {
}

SearchRecipient200ResponseRecipientsInnerCustomFieldsInnerValue struct for SearchRecipient200ResponseRecipientsInnerCustomFieldsInnerValue

type SearchRecipientParam 

type SearchRecipientParam struct {
	//
	SearchRecipientRequest *SearchRecipientRequest `json:"SearchRecipientRequest,omitempty"`
}

func (*SearchRecipientParam) SetSearchRecipientRequest 

func (params *SearchRecipientParam) SetSearchRecipientRequest(SearchRecipientRequest SearchRecipientRequest) *SearchRecipientParam

type SearchRecipientRequest 

type SearchRecipientRequest struct {
	ListId int32 `json:"list_id"`
	// The conditions by which this segment should be created.
	Conditions []ContactdbSegmentsConditions `json:"conditions"`
}

SearchRecipientRequest struct for SearchRecipientRequest

type Type 

type Type string

Type the model 'Type' 

const (
	TYPE_DATE   Type = "date"
	TYPE_TEXT   Type = "text"
	TYPE_NUMBER Type = "number"
)

List of Type

type UpdateAListRequest 

type UpdateAListRequest struct {
	// The new name for your list.
	Name string `json:"name"`
}

UpdateAListRequest struct for UpdateAListRequest

type UpdateContactDbList200Response 

type UpdateContactDbList200Response struct {
	// The ID of the list
	Id *int32 `json:"id,omitempty"`
	// The new name for the list
	Name *string `json:"name,omitempty"`
	// The number of recipients on the list
	RecipientCount *int32 `json:"recipient_count,omitempty"`
}

UpdateContactDbList200Response struct for UpdateContactDbList200Response

type UpdateContactDbListParam 

type UpdateContactDbListParam struct {
	//
	ListId *int32 `json:"list_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	UpdateAListRequest *UpdateAListRequest `json:"UpdateAListRequest,omitempty"`
}

func (*UpdateContactDbListParam) SetListId 

func (params *UpdateContactDbListParam) SetListId(ListId int32) *UpdateContactDbListParam

func (*UpdateContactDbListParam) SetOnbehalfof 

func (params *UpdateContactDbListParam) SetOnbehalfof(Onbehalfof string) *UpdateContactDbListParam

func (*UpdateContactDbListParam) SetUpdateAListRequest 

func (params *UpdateContactDbListParam) SetUpdateAListRequest(UpdateAListRequest UpdateAListRequest) *UpdateContactDbListParam

type UpdateRecipientParam 

type UpdateRecipientParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	UpdateRecipientRequestInner *[]UpdateRecipientRequestInner `json:"UpdateRecipientRequestInner,omitempty"`
}

func (*UpdateRecipientParam) SetOnbehalfof 

func (params *UpdateRecipientParam) SetOnbehalfof(Onbehalfof string) *UpdateRecipientParam

func (*UpdateRecipientParam) SetUpdateRecipientRequestInner 

func (params *UpdateRecipientParam) SetUpdateRecipientRequestInner(UpdateRecipientRequestInner []UpdateRecipientRequestInner) *UpdateRecipientParam

type UpdateRecipientRequestInner 

type UpdateRecipientRequestInner struct {
	Email string `json:"email"`
	// The last name of the recipient. This is one of the default custom fields.
	LastName *string `json:"last_name,omitempty"`
	// The first name of the recipient. This is one of the default custom fields.
	FirstName *string `json:"first_name,omitempty"`
}

UpdateRecipientRequestInner struct for UpdateRecipientRequestInner

type UpdateSegmentParam 

type UpdateSegmentParam struct {
	//
	SegmentId *int32 `json:"segment_id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	UpdateSegmentRequest *UpdateSegmentRequest `json:"UpdateSegmentRequest,omitempty"`
}

func (*UpdateSegmentParam) SetOnbehalfof 

func (params *UpdateSegmentParam) SetOnbehalfof(Onbehalfof string) *UpdateSegmentParam

func (*UpdateSegmentParam) SetSegmentId 

func (params *UpdateSegmentParam) SetSegmentId(SegmentId int32) *UpdateSegmentParam

func (*UpdateSegmentParam) SetUpdateSegmentRequest 

func (params *UpdateSegmentParam) SetUpdateSegmentRequest(UpdateSegmentRequest UpdateSegmentRequest) *UpdateSegmentParam

type UpdateSegmentRequest 

type UpdateSegmentRequest struct {
	Name string `json:"name"`
	// The list ID you would like this segment to be built from.
	ListId *float32 `json:"list_id,omitempty"`
	// The conditions by which this segment should be created.
	Conditions *[]ContactdbSegmentsConditions `json:"conditions,omitempty"`
}

UpdateSegmentRequest struct for UpdateSegmentRequest

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.