lob

package module
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2024 License: MIT Imports: 22 Imported by: 0

README

lob-go

Go SDK for the Lob.com API. See the full Lob.com API documentation here.

Getting Started

Registration

First, you will need to first create an account at Lob.com and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the Settings Panel.

Installation

lob-go can be installed through the go package manager:

$ go install github.com/lob/lob-go@latest

Examples

First API Calls
import (
  "context"
  "os"
  lob "github.com/lob/lob-go"
)
ctx := context.Background()
ctx = context.WithValue(ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv("LOB_API_TEST_KEY")})

config := *lob.NewConfiguration()

apiClient := *lob.NewAPIClient(&config)

address := *lob.AddressEditable
address.SetName("Harry Zhang")
address.SetAddressLine1("2261 Market Street")
address.SetAddressCity("San Francisco")
address.SetAddressState("CA")
address.SetAddressZip("94114")

myAddress, _, createErr := apiClient.AddressesApi.Create(ctx).AddressEditable(address).Execute()

if createErr != nil {
    log.Fatal(createErr)
}

myAddressFromApi, _, getErr := apiClient.AddressesApi.Get(ctx, *myAddress.Id).Execute()

if getErr != nil {
    log.Fatal(getErr)
}

resp, _, deleteErr := suite.apiClient.AddressesApi.Delete(suite.ctx, *myAddress.Id).Execute()

if deleteErr != nil {
    log.Fatal(deleteErr)
}

API Documentation

The full and comprehensive documentation of Lob's APIs is available here.

Supported Go Versions

Our client libraries follow the Go release schedule. This package is compatible with all current stable versions of Go. If you are using a version that is not listed as an stable version we recommend that you switch to an actively supported LTS version.

Any support or compatability with versions of Go not listed as stable is on a best-efforts basis.

Testing

Integration Tests

Integration tests run against a live deployment of the Lob API and require multiple valid API keys with access to specific features. As such, it is not expected that these tests will pass for every user in every environment.

To run integration tests:

go test -v ./__tests__

=======================

Copyright © 2022 Lob.com

Released under the MIT License, which can be found in the repository in LICENSE.txt.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var AllowedBankTypeEnumEnumValues = []BankTypeEnum{
	"company",
	"individual",
}

All allowed values of BankTypeEnum enum

View Source 
var AllowedChkUseTypeEnumValues = []ChkUseType{
	"marketing",
	"operational",
	"null",
}

All allowed values of ChkUseType enum

View Source 
var AllowedCmpScheduleTypeEnumValues = []CmpScheduleType{
	"immediate",
}

All allowed values of CmpScheduleType enum

View Source 
var AllowedCmpUseTypeEnumValues = []CmpUseType{
	"marketing",
	"operational",
	"null",
}

All allowed values of CmpUseType enum

View Source 
var AllowedCountryExtendedEnumValues = []CountryExtended{}/* 219 elements not displayed */

All allowed values of CountryExtended enum

View Source 
var AllowedCountryExtendedExpandedEnumValues = []CountryExtendedExpanded{}/* 220 elements not displayed */

All allowed values of CountryExtendedExpanded enum

View Source 
var AllowedDpvFootnoteEnumValues = []DpvFootnote{
	"AA",
	"A1",
	"BB",
	"CC",
	"C1",
	"F1",
	"G1",
	"IA",
	"M1",
	"M3",
	"N1",
	"PB",
	"P1",
	"P3",
	"R1",
	"R7",
	"RR",
	"TA",
	"U1",
}

All allowed values of DpvFootnote enum

View Source 
var AllowedEngineHtmlEnumValues = []EngineHtml{
	"legacy",
	"handlebars",
}

All allowed values of EngineHtml enum

View Source 
var AllowedLtrUseTypeEnumValues = []LtrUseType{
	"marketing",
	"operational",
	"null",
}

All allowed values of LtrUseType enum

View Source 
var AllowedMailTypeEnumValues = []MailType{
	"usps_first_class",
	"usps_standard",
}

All allowed values of MailType enum

View Source 
var AllowedPostcardSizeEnumValues = []PostcardSize{
	"4x6",
	"6x9",
	"6x11",
}

All allowed values of PostcardSize enum

View Source 
var AllowedPscUseTypeEnumValues = []PscUseType{
	"marketing",
	"operational",
	"null",
}

All allowed values of PscUseType enum

View Source 
var AllowedSelfMailerSizeEnumValues = []SelfMailerSize{
	"6x18_bifold",
	"11x9_bifold",
	"12x9_bifold",
}

All allowed values of SelfMailerSize enum

View Source 
var AllowedSfmUseTypeEnumValues = []SfmUseType{
	"marketing",
	"operational",
	"null",
}

All allowed values of SfmUseType enum

View Source 
var AllowedUploadStateEnumValues = []UploadState{
	"Preprocessing",
	"Draft",
	"Ready for Validation",
	"Validating",
	"Scheduled",
	"Cancelled",
	"Errored",
}

All allowed values of UploadState enum

View Source 
var AllowedZipCodeTypeEnumValues = []ZipCodeType{
	"standard",
	"po_box",
	"unique",
	"military",
	"",
}

All allowed values of ZipCodeType enum

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	AddressesApi *AddressesApiService

	BankAccountsApi *BankAccountsApiService

	BillingGroupsApi *BillingGroupsApiService

	BuckslipOrdersApi *BuckslipOrdersApiService

	BuckslipsApi *BuckslipsApiService

	CampaignsApi *CampaignsApiService

	CardOrdersApi *CardOrdersApiService

	CardsApi *CardsApiService

	ChecksApi *ChecksApiService

	CreativesApi *CreativesApiService

	DefaultApi *DefaultApiService

	IdentityValidationApi *IdentityValidationApiService

	IntlAutocompletionsApi *IntlAutocompletionsApiService

	IntlVerificationsApi *IntlVerificationsApiService

	LettersApi *LettersApiService

	PostcardsApi *PostcardsApiService

	ReverseGeocodeLookupsApi *ReverseGeocodeLookupsApiService

	SelfMailersApi *SelfMailersApiService

	TemplateVersionsApi *TemplateVersionsApiService

	TemplatesApi *TemplatesApiService

	UsAutocompletionsApi *UsAutocompletionsApiService

	UsVerificationsApi *UsVerificationsApiService

	ZipLookupsApi *ZipLookupsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Lob API v1.3.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type Address 

type Address struct {
	// Unique identifier prefixed with `adr_`.
	Id *string `json:"id,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// name associated with address
	Name NullableString `json:"name,omitempty"`
	// Either `name` or `company` is required, you may also add both.
	Company NullableString `json:"company,omitempty"`
	// Must be no longer than 40 characters.
	Phone NullableString `json:"phone,omitempty"`
	// Must be no longer than 100 characters.
	Email NullableString `json:"email,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata     *map[string]string `json:"metadata,omitempty"`
	AddressLine1 *string            `json:"address_line1,omitempty"`
	AddressLine2 NullableString     `json:"address_line2,omitempty"`
	AddressCity  *string            `json:"address_city,omitempty"`
	// 2 letter state short-name code
	AddressState *string `json:"address_state,omitempty"`
	// Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`.
	AddressZip     *string                  `json:"address_zip,omitempty"`
	AddressCountry *CountryExtendedExpanded `json:"address_country,omitempty"`
	Object         *string                  `json:"object,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified *time.Time `json:"date_modified,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account.
	RecipientMoved NullableBool `json:"recipient_moved,omitempty"`
}

Address struct for Address

func NewAddress 

func NewAddress() *Address

NewAddress instantiates a new Address object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddressWithDefaults 

func NewAddressWithDefaults() *Address

NewAddressWithDefaults instantiates a new Address object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Address) GetAddressCity 

func (o *Address) GetAddressCity() string

GetAddressCity returns the AddressCity field value if set, zero value otherwise.

func (*Address) GetAddressCityOk 

func (o *Address) GetAddressCityOk() (*string, bool)

GetAddressCityOk returns a tuple with the AddressCity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetAddressCountry 

func (o *Address) GetAddressCountry() CountryExtendedExpanded

GetAddressCountry returns the AddressCountry field value if set, zero value otherwise.

func (*Address) GetAddressCountryOk 

func (o *Address) GetAddressCountryOk() (*CountryExtendedExpanded, bool)

GetAddressCountryOk returns a tuple with the AddressCountry field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetAddressLine1 

func (o *Address) GetAddressLine1() string

GetAddressLine1 returns the AddressLine1 field value if set, zero value otherwise.

func (*Address) GetAddressLine1Ok 

func (o *Address) GetAddressLine1Ok() (*string, bool)

GetAddressLine1Ok returns a tuple with the AddressLine1 field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetAddressLine2 

func (o *Address) GetAddressLine2() string

GetAddressLine2 returns the AddressLine2 field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Address) GetAddressLine2Ok 

func (o *Address) GetAddressLine2Ok() (*string, bool)

GetAddressLine2Ok returns a tuple with the AddressLine2 field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Address) GetAddressState 

func (o *Address) GetAddressState() string

GetAddressState returns the AddressState field value if set, zero value otherwise.

func (*Address) GetAddressStateOk 

func (o *Address) GetAddressStateOk() (*string, bool)

GetAddressStateOk returns a tuple with the AddressState field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetAddressZip 

func (o *Address) GetAddressZip() string

GetAddressZip returns the AddressZip field value if set, zero value otherwise.

func (*Address) GetAddressZipOk 

func (o *Address) GetAddressZipOk() (*string, bool)

GetAddressZipOk returns a tuple with the AddressZip field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetCompany 

func (o *Address) GetCompany() string

GetCompany returns the Company field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Address) GetCompanyOk 

func (o *Address) GetCompanyOk() (*string, bool)

GetCompanyOk returns a tuple with the Company field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Address) GetDateCreated 

func (o *Address) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*Address) GetDateCreatedOk 

func (o *Address) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetDateModified 

func (o *Address) GetDateModified() time.Time

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*Address) GetDateModifiedOk 

func (o *Address) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetDeleted 

func (o *Address) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*Address) GetDeletedOk 

func (o *Address) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetDescription 

func (o *Address) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Address) GetDescriptionOk 

func (o *Address) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Address) GetEmail 

func (o *Address) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Address) GetEmailOk 

func (o *Address) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Address) GetId 

func (o *Address) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Address) GetIdOk 

func (o *Address) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetMetadata 

func (o *Address) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*Address) GetMetadataOk 

func (o *Address) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetName 

func (o *Address) GetName() string

GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Address) GetNameOk 

func (o *Address) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Address) GetObject 

func (o *Address) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*Address) GetObjectOk 

func (o *Address) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Address) GetPhone 

func (o *Address) GetPhone() string

GetPhone returns the Phone field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Address) GetPhoneOk 

func (o *Address) GetPhoneOk() (*string, bool)

GetPhoneOk returns a tuple with the Phone field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Address) GetRecipientMoved 

func (o *Address) GetRecipientMoved() bool

GetRecipientMoved returns the RecipientMoved field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Address) GetRecipientMovedOk 

func (o *Address) GetRecipientMovedOk() (*bool, bool)

GetRecipientMovedOk returns a tuple with the RecipientMoved field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Address) HasAddressCity 

func (o *Address) HasAddressCity() bool

HasAddressCity returns a boolean if a field has been set.

func (*Address) HasAddressCountry 

func (o *Address) HasAddressCountry() bool

HasAddressCountry returns a boolean if a field has been set.

func (*Address) HasAddressLine1 

func (o *Address) HasAddressLine1() bool

HasAddressLine1 returns a boolean if a field has been set.

func (*Address) HasAddressLine2 

func (o *Address) HasAddressLine2() bool

HasAddressLine2 returns a boolean if a field has been set.

func (*Address) HasAddressState 

func (o *Address) HasAddressState() bool

HasAddressState returns a boolean if a field has been set.

func (*Address) HasAddressZip 

func (o *Address) HasAddressZip() bool

HasAddressZip returns a boolean if a field has been set.

func (*Address) HasCompany 

func (o *Address) HasCompany() bool

HasCompany returns a boolean if a field has been set.

func (*Address) HasDateCreated 

func (o *Address) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*Address) HasDateModified 

func (o *Address) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (*Address) HasDeleted 

func (o *Address) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*Address) HasDescription 

func (o *Address) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Address) HasEmail 

func (o *Address) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (*Address) HasId 

func (o *Address) HasId() bool

HasId returns a boolean if a field has been set.

func (*Address) HasMetadata 

func (o *Address) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*Address) HasName 

func (o *Address) HasName() bool

HasName returns a boolean if a field has been set.

func (*Address) HasObject 

func (o *Address) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*Address) HasPhone 

func (o *Address) HasPhone() bool

HasPhone returns a boolean if a field has been set.

func (*Address) HasRecipientMoved 

func (o *Address) HasRecipientMoved() bool

HasRecipientMoved returns a boolean if a field has been set.

func (Address) MarshalJSON 

func (o Address) MarshalJSON() ([]byte, error)

func (*Address) SetAddressCity 

func (o *Address) SetAddressCity(v string)

SetAddressCity gets a reference to the given string and assigns it to the AddressCity field.

func (*Address) SetAddressCountry 

func (o *Address) SetAddressCountry(v CountryExtendedExpanded)

SetAddressCountry gets a reference to the given CountryExtendedExpanded and assigns it to the AddressCountry field.

func (*Address) SetAddressLine1 

func (o *Address) SetAddressLine1(v string)

SetAddressLine1 gets a reference to the given string and assigns it to the AddressLine1 field.

func (*Address) SetAddressLine2 

func (o *Address) SetAddressLine2(v string)

SetAddressLine2 gets a reference to the given NullableString and assigns it to the AddressLine2 field.

func (*Address) SetAddressLine2Nil 

func (o *Address) SetAddressLine2Nil()

SetAddressLine2Nil sets the value for AddressLine2 to be an explicit nil

func (*Address) SetAddressState 

func (o *Address) SetAddressState(v string)

SetAddressState gets a reference to the given string and assigns it to the AddressState field.

func (*Address) SetAddressZip 

func (o *Address) SetAddressZip(v string)

SetAddressZip gets a reference to the given string and assigns it to the AddressZip field.

func (*Address) SetCompany 

func (o *Address) SetCompany(v string)

SetCompany gets a reference to the given NullableString and assigns it to the Company field.

func (*Address) SetCompanyNil 

func (o *Address) SetCompanyNil()

SetCompanyNil sets the value for Company to be an explicit nil

func (*Address) SetDateCreated 

func (o *Address) SetDateCreated(v time.Time)

SetDateCreated gets a reference to the given time.Time and assigns it to the DateCreated field.

func (*Address) SetDateModified 

func (o *Address) SetDateModified(v time.Time)

SetDateModified gets a reference to the given time.Time and assigns it to the DateModified field.

func (*Address) SetDeleted 

func (o *Address) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*Address) SetDescription 

func (o *Address) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*Address) SetDescriptionNil 

func (o *Address) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*Address) SetEmail 

func (o *Address) SetEmail(v string)

SetEmail gets a reference to the given NullableString and assigns it to the Email field.

func (*Address) SetEmailNil 

func (o *Address) SetEmailNil()

SetEmailNil sets the value for Email to be an explicit nil

func (*Address) SetId 

func (o *Address) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Address) SetMetadata 

func (o *Address) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*Address) SetName 

func (o *Address) SetName(v string)

SetName gets a reference to the given NullableString and assigns it to the Name field.

func (*Address) SetNameNil 

func (o *Address) SetNameNil()

SetNameNil sets the value for Name to be an explicit nil

func (*Address) SetObject 

func (o *Address) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*Address) SetPhone 

func (o *Address) SetPhone(v string)

SetPhone gets a reference to the given NullableString and assigns it to the Phone field.

func (*Address) SetPhoneNil 

func (o *Address) SetPhoneNil()

SetPhoneNil sets the value for Phone to be an explicit nil

func (*Address) SetRecipientMoved 

func (o *Address) SetRecipientMoved(v bool)

SetRecipientMoved gets a reference to the given NullableBool and assigns it to the RecipientMoved field.

func (*Address) SetRecipientMovedNil 

func (o *Address) SetRecipientMovedNil()

SetRecipientMovedNil sets the value for RecipientMoved to be an explicit nil

func (*Address) UnsetAddressLine2 

func (o *Address) UnsetAddressLine2()

UnsetAddressLine2 ensures that no value is present for AddressLine2, not even an explicit nil

func (*Address) UnsetCompany 

func (o *Address) UnsetCompany()

UnsetCompany ensures that no value is present for Company, not even an explicit nil

func (*Address) UnsetDescription 

func (o *Address) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*Address) UnsetEmail 

func (o *Address) UnsetEmail()

UnsetEmail ensures that no value is present for Email, not even an explicit nil

func (*Address) UnsetName 

func (o *Address) UnsetName()

UnsetName ensures that no value is present for Name, not even an explicit nil

func (*Address) UnsetPhone 

func (o *Address) UnsetPhone()

UnsetPhone ensures that no value is present for Phone, not even an explicit nil

func (*Address) UnsetRecipientMoved 

func (o *Address) UnsetRecipientMoved()

UnsetRecipientMoved ensures that no value is present for RecipientMoved, not even an explicit nil

type AddressDeletion 

type AddressDeletion struct {
	// Unique identifier prefixed with `adr_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

AddressDeletion Object returned upon deleting an address

func NewAddressDeletion 

func NewAddressDeletion() *AddressDeletion

NewAddressDeletion instantiates a new AddressDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddressDeletionWithDefaults 

func NewAddressDeletionWithDefaults() *AddressDeletion

NewAddressDeletionWithDefaults instantiates a new AddressDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddressDeletion) GetDeleted 

func (o *AddressDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*AddressDeletion) GetDeletedOk 

func (o *AddressDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDeletion) GetId 

func (o *AddressDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*AddressDeletion) GetIdOk 

func (o *AddressDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDeletion) GetObject 

func (o *AddressDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*AddressDeletion) GetObjectOk 

func (o *AddressDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDeletion) HasDeleted 

func (o *AddressDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*AddressDeletion) HasId 

func (o *AddressDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*AddressDeletion) HasObject 

func (o *AddressDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (AddressDeletion) MarshalJSON 

func (o AddressDeletion) MarshalJSON() ([]byte, error)

func (*AddressDeletion) SetDeleted 

func (o *AddressDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*AddressDeletion) SetId 

func (o *AddressDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*AddressDeletion) SetObject 

func (o *AddressDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type AddressDomestic 

type AddressDomestic struct {
	// The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters.
	AddressLine1 *string `json:"address_line1,omitempty"`
	// The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters.
	AddressLine2 NullableString `json:"address_line2,omitempty"`
	AddressCity  NullableString `json:"address_city,omitempty"`
	AddressState NullableString `json:"address_state,omitempty"`
	// Optional postal code. For US addresses, must be either 5 or 9 digits.
	AddressZip NullableString `json:"address_zip,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address.
	Name NullableString `json:"name,omitempty"`
	// Either `name` or `company` is required, you may also add both.
	Company NullableString `json:"company,omitempty"`
	// Must be no longer than 40 characters.
	Phone NullableString `json:"phone,omitempty"`
	// Must be no longer than 100 characters.
	Email NullableString `json:"email,omitempty"`
	// The country associated with this address.
	AddressCountry NullableString `json:"address_country,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
}

AddressDomestic struct for AddressDomestic

func NewAddressDomestic 

func NewAddressDomestic() *AddressDomestic

NewAddressDomestic instantiates a new AddressDomestic object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddressDomesticWithDefaults 

func NewAddressDomesticWithDefaults() *AddressDomestic

NewAddressDomesticWithDefaults instantiates a new AddressDomestic object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddressDomestic) GetAddressCity 

func (o *AddressDomestic) GetAddressCity() string

GetAddressCity returns the AddressCity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetAddressCityOk 

func (o *AddressDomestic) GetAddressCityOk() (*string, bool)

GetAddressCityOk returns a tuple with the AddressCity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetAddressCountry 

func (o *AddressDomestic) GetAddressCountry() string

GetAddressCountry returns the AddressCountry field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetAddressCountryOk 

func (o *AddressDomestic) GetAddressCountryOk() (*string, bool)

GetAddressCountryOk returns a tuple with the AddressCountry field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetAddressLine1 

func (o *AddressDomestic) GetAddressLine1() string

GetAddressLine1 returns the AddressLine1 field value if set, zero value otherwise.

func (*AddressDomestic) GetAddressLine1Ok 

func (o *AddressDomestic) GetAddressLine1Ok() (*string, bool)

GetAddressLine1Ok returns a tuple with the AddressLine1 field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDomestic) GetAddressLine2 

func (o *AddressDomestic) GetAddressLine2() string

GetAddressLine2 returns the AddressLine2 field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetAddressLine2Ok 

func (o *AddressDomestic) GetAddressLine2Ok() (*string, bool)

GetAddressLine2Ok returns a tuple with the AddressLine2 field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetAddressState 

func (o *AddressDomestic) GetAddressState() string

GetAddressState returns the AddressState field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetAddressStateOk 

func (o *AddressDomestic) GetAddressStateOk() (*string, bool)

GetAddressStateOk returns a tuple with the AddressState field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetAddressZip 

func (o *AddressDomestic) GetAddressZip() string

GetAddressZip returns the AddressZip field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetAddressZipOk 

func (o *AddressDomestic) GetAddressZipOk() (*string, bool)

GetAddressZipOk returns a tuple with the AddressZip field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetCompany 

func (o *AddressDomestic) GetCompany() string

GetCompany returns the Company field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetCompanyOk 

func (o *AddressDomestic) GetCompanyOk() (*string, bool)

GetCompanyOk returns a tuple with the Company field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetDescription 

func (o *AddressDomestic) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetDescriptionOk 

func (o *AddressDomestic) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetEmail 

func (o *AddressDomestic) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetEmailOk 

func (o *AddressDomestic) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetMetadata 

func (o *AddressDomestic) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*AddressDomestic) GetMetadataOk 

func (o *AddressDomestic) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDomestic) GetName 

func (o *AddressDomestic) GetName() string

GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetNameOk 

func (o *AddressDomestic) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) GetPhone 

func (o *AddressDomestic) GetPhone() string

GetPhone returns the Phone field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomestic) GetPhoneOk 

func (o *AddressDomestic) GetPhoneOk() (*string, bool)

GetPhoneOk returns a tuple with the Phone field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomestic) HasAddressCity 

func (o *AddressDomestic) HasAddressCity() bool

HasAddressCity returns a boolean if a field has been set.

func (*AddressDomestic) HasAddressCountry 

func (o *AddressDomestic) HasAddressCountry() bool

HasAddressCountry returns a boolean if a field has been set.

func (*AddressDomestic) HasAddressLine1 

func (o *AddressDomestic) HasAddressLine1() bool

HasAddressLine1 returns a boolean if a field has been set.

func (*AddressDomestic) HasAddressLine2 

func (o *AddressDomestic) HasAddressLine2() bool

HasAddressLine2 returns a boolean if a field has been set.

func (*AddressDomestic) HasAddressState 

func (o *AddressDomestic) HasAddressState() bool

HasAddressState returns a boolean if a field has been set.

func (*AddressDomestic) HasAddressZip 

func (o *AddressDomestic) HasAddressZip() bool

HasAddressZip returns a boolean if a field has been set.

func (*AddressDomestic) HasCompany 

func (o *AddressDomestic) HasCompany() bool

HasCompany returns a boolean if a field has been set.

func (*AddressDomestic) HasDescription 

func (o *AddressDomestic) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*AddressDomestic) HasEmail 

func (o *AddressDomestic) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (*AddressDomestic) HasMetadata 

func (o *AddressDomestic) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*AddressDomestic) HasName 

func (o *AddressDomestic) HasName() bool

HasName returns a boolean if a field has been set.

func (*AddressDomestic) HasPhone 

func (o *AddressDomestic) HasPhone() bool

HasPhone returns a boolean if a field has been set.

func (AddressDomestic) MarshalJSON 

func (o AddressDomestic) MarshalJSON() ([]byte, error)

func (*AddressDomestic) SetAddressCity 

func (o *AddressDomestic) SetAddressCity(v string)

SetAddressCity gets a reference to the given NullableString and assigns it to the AddressCity field.

func (*AddressDomestic) SetAddressCityNil 

func (o *AddressDomestic) SetAddressCityNil()

SetAddressCityNil sets the value for AddressCity to be an explicit nil

func (*AddressDomestic) SetAddressCountry 

func (o *AddressDomestic) SetAddressCountry(v string)

SetAddressCountry gets a reference to the given NullableString and assigns it to the AddressCountry field.

func (*AddressDomestic) SetAddressCountryNil 

func (o *AddressDomestic) SetAddressCountryNil()

SetAddressCountryNil sets the value for AddressCountry to be an explicit nil

func (*AddressDomestic) SetAddressLine1 

func (o *AddressDomestic) SetAddressLine1(v string)

SetAddressLine1 gets a reference to the given string and assigns it to the AddressLine1 field.

func (*AddressDomestic) SetAddressLine2 

func (o *AddressDomestic) SetAddressLine2(v string)

SetAddressLine2 gets a reference to the given NullableString and assigns it to the AddressLine2 field.

func (*AddressDomestic) SetAddressLine2Nil 

func (o *AddressDomestic) SetAddressLine2Nil()

SetAddressLine2Nil sets the value for AddressLine2 to be an explicit nil

func (*AddressDomestic) SetAddressState 

func (o *AddressDomestic) SetAddressState(v string)

SetAddressState gets a reference to the given NullableString and assigns it to the AddressState field.

func (*AddressDomestic) SetAddressStateNil 

func (o *AddressDomestic) SetAddressStateNil()

SetAddressStateNil sets the value for AddressState to be an explicit nil

func (*AddressDomestic) SetAddressZip 

func (o *AddressDomestic) SetAddressZip(v string)

SetAddressZip gets a reference to the given NullableString and assigns it to the AddressZip field.

func (*AddressDomestic) SetAddressZipNil 

func (o *AddressDomestic) SetAddressZipNil()

SetAddressZipNil sets the value for AddressZip to be an explicit nil

func (*AddressDomestic) SetCompany 

func (o *AddressDomestic) SetCompany(v string)

SetCompany gets a reference to the given NullableString and assigns it to the Company field.

func (*AddressDomestic) SetCompanyNil 

func (o *AddressDomestic) SetCompanyNil()

SetCompanyNil sets the value for Company to be an explicit nil

func (*AddressDomestic) SetDescription 

func (o *AddressDomestic) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*AddressDomestic) SetDescriptionNil 

func (o *AddressDomestic) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*AddressDomestic) SetEmail 

func (o *AddressDomestic) SetEmail(v string)

SetEmail gets a reference to the given NullableString and assigns it to the Email field.

func (*AddressDomestic) SetEmailNil 

func (o *AddressDomestic) SetEmailNil()

SetEmailNil sets the value for Email to be an explicit nil

func (*AddressDomestic) SetMetadata 

func (o *AddressDomestic) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*AddressDomestic) SetName 

func (o *AddressDomestic) SetName(v string)

SetName gets a reference to the given NullableString and assigns it to the Name field.

func (*AddressDomestic) SetNameNil 

func (o *AddressDomestic) SetNameNil()

SetNameNil sets the value for Name to be an explicit nil

func (*AddressDomestic) SetPhone 

func (o *AddressDomestic) SetPhone(v string)

SetPhone gets a reference to the given NullableString and assigns it to the Phone field.

func (*AddressDomestic) SetPhoneNil 

func (o *AddressDomestic) SetPhoneNil()

SetPhoneNil sets the value for Phone to be an explicit nil

func (*AddressDomestic) UnsetAddressCity 

func (o *AddressDomestic) UnsetAddressCity()

UnsetAddressCity ensures that no value is present for AddressCity, not even an explicit nil

func (*AddressDomestic) UnsetAddressCountry 

func (o *AddressDomestic) UnsetAddressCountry()

UnsetAddressCountry ensures that no value is present for AddressCountry, not even an explicit nil

func (*AddressDomestic) UnsetAddressLine2 

func (o *AddressDomestic) UnsetAddressLine2()

UnsetAddressLine2 ensures that no value is present for AddressLine2, not even an explicit nil

func (*AddressDomestic) UnsetAddressState 

func (o *AddressDomestic) UnsetAddressState()

UnsetAddressState ensures that no value is present for AddressState, not even an explicit nil

func (*AddressDomestic) UnsetAddressZip 

func (o *AddressDomestic) UnsetAddressZip()

UnsetAddressZip ensures that no value is present for AddressZip, not even an explicit nil

func (*AddressDomestic) UnsetCompany 

func (o *AddressDomestic) UnsetCompany()

UnsetCompany ensures that no value is present for Company, not even an explicit nil

func (*AddressDomestic) UnsetDescription 

func (o *AddressDomestic) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*AddressDomestic) UnsetEmail 

func (o *AddressDomestic) UnsetEmail()

UnsetEmail ensures that no value is present for Email, not even an explicit nil

func (*AddressDomestic) UnsetName 

func (o *AddressDomestic) UnsetName()

UnsetName ensures that no value is present for Name, not even an explicit nil

func (*AddressDomestic) UnsetPhone 

func (o *AddressDomestic) UnsetPhone()

UnsetPhone ensures that no value is present for Phone, not even an explicit nil

type AddressDomesticExpanded 

type AddressDomesticExpanded struct {
	// The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters.
	AddressLine1 *string `json:"address_line1,omitempty"`
	// The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters.
	AddressLine2 NullableString `json:"address_line2,omitempty"`
	AddressCity  NullableString `json:"address_city,omitempty"`
	AddressState NullableString `json:"address_state,omitempty"`
	// Optional postal code. For US addresses, must be either 5 or 9 digits.
	AddressZip NullableString `json:"address_zip,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address.
	Name NullableString `json:"name,omitempty"`
	// Either `name` or `company` is required, you may also add both.
	Company NullableString `json:"company,omitempty"`
	// Must be no longer than 40 characters.
	Phone NullableString `json:"phone,omitempty"`
	// Must be no longer than 100 characters.
	Email NullableString `json:"email,omitempty"`
	// The country associated with this address.
	AddressCountry *string `json:"address_country,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
}

AddressDomesticExpanded struct for AddressDomesticExpanded

func NewAddressDomesticExpanded 

func NewAddressDomesticExpanded() *AddressDomesticExpanded

NewAddressDomesticExpanded instantiates a new AddressDomesticExpanded object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddressDomesticExpandedWithDefaults 

func NewAddressDomesticExpandedWithDefaults() *AddressDomesticExpanded

NewAddressDomesticExpandedWithDefaults instantiates a new AddressDomesticExpanded object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddressDomesticExpanded) GetAddressCity 

func (o *AddressDomesticExpanded) GetAddressCity() string

GetAddressCity returns the AddressCity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetAddressCityOk 

func (o *AddressDomesticExpanded) GetAddressCityOk() (*string, bool)

GetAddressCityOk returns a tuple with the AddressCity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetAddressCountry 

func (o *AddressDomesticExpanded) GetAddressCountry() string

GetAddressCountry returns the AddressCountry field value if set, zero value otherwise.

func (*AddressDomesticExpanded) GetAddressCountryOk 

func (o *AddressDomesticExpanded) GetAddressCountryOk() (*string, bool)

GetAddressCountryOk returns a tuple with the AddressCountry field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDomesticExpanded) GetAddressLine1 

func (o *AddressDomesticExpanded) GetAddressLine1() string

GetAddressLine1 returns the AddressLine1 field value if set, zero value otherwise.

func (*AddressDomesticExpanded) GetAddressLine1Ok 

func (o *AddressDomesticExpanded) GetAddressLine1Ok() (*string, bool)

GetAddressLine1Ok returns a tuple with the AddressLine1 field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDomesticExpanded) GetAddressLine2 

func (o *AddressDomesticExpanded) GetAddressLine2() string

GetAddressLine2 returns the AddressLine2 field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetAddressLine2Ok 

func (o *AddressDomesticExpanded) GetAddressLine2Ok() (*string, bool)

GetAddressLine2Ok returns a tuple with the AddressLine2 field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetAddressState 

func (o *AddressDomesticExpanded) GetAddressState() string

GetAddressState returns the AddressState field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetAddressStateOk 

func (o *AddressDomesticExpanded) GetAddressStateOk() (*string, bool)

GetAddressStateOk returns a tuple with the AddressState field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetAddressZip 

func (o *AddressDomesticExpanded) GetAddressZip() string

GetAddressZip returns the AddressZip field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetAddressZipOk 

func (o *AddressDomesticExpanded) GetAddressZipOk() (*string, bool)

GetAddressZipOk returns a tuple with the AddressZip field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetCompany 

func (o *AddressDomesticExpanded) GetCompany() string

GetCompany returns the Company field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetCompanyOk 

func (o *AddressDomesticExpanded) GetCompanyOk() (*string, bool)

GetCompanyOk returns a tuple with the Company field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetDescription 

func (o *AddressDomesticExpanded) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetDescriptionOk 

func (o *AddressDomesticExpanded) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetEmail 

func (o *AddressDomesticExpanded) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetEmailOk 

func (o *AddressDomesticExpanded) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetMetadata 

func (o *AddressDomesticExpanded) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*AddressDomesticExpanded) GetMetadataOk 

func (o *AddressDomesticExpanded) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressDomesticExpanded) GetName 

func (o *AddressDomesticExpanded) GetName() string

GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetNameOk 

func (o *AddressDomesticExpanded) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) GetPhone 

func (o *AddressDomesticExpanded) GetPhone() string

GetPhone returns the Phone field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressDomesticExpanded) GetPhoneOk 

func (o *AddressDomesticExpanded) GetPhoneOk() (*string, bool)

GetPhoneOk returns a tuple with the Phone field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressDomesticExpanded) HasAddressCity 

func (o *AddressDomesticExpanded) HasAddressCity() bool

HasAddressCity returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasAddressCountry 

func (o *AddressDomesticExpanded) HasAddressCountry() bool

HasAddressCountry returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasAddressLine1 

func (o *AddressDomesticExpanded) HasAddressLine1() bool

HasAddressLine1 returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasAddressLine2 

func (o *AddressDomesticExpanded) HasAddressLine2() bool

HasAddressLine2 returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasAddressState 

func (o *AddressDomesticExpanded) HasAddressState() bool

HasAddressState returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasAddressZip 

func (o *AddressDomesticExpanded) HasAddressZip() bool

HasAddressZip returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasCompany 

func (o *AddressDomesticExpanded) HasCompany() bool

HasCompany returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasDescription 

func (o *AddressDomesticExpanded) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasEmail 

func (o *AddressDomesticExpanded) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasMetadata 

func (o *AddressDomesticExpanded) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasName 

func (o *AddressDomesticExpanded) HasName() bool

HasName returns a boolean if a field has been set.

func (*AddressDomesticExpanded) HasPhone 

func (o *AddressDomesticExpanded) HasPhone() bool

HasPhone returns a boolean if a field has been set.

func (AddressDomesticExpanded) MarshalJSON 

func (o AddressDomesticExpanded) MarshalJSON() ([]byte, error)

func (*AddressDomesticExpanded) SetAddressCity 

func (o *AddressDomesticExpanded) SetAddressCity(v string)

SetAddressCity gets a reference to the given NullableString and assigns it to the AddressCity field.

func (*AddressDomesticExpanded) SetAddressCityNil 

func (o *AddressDomesticExpanded) SetAddressCityNil()

SetAddressCityNil sets the value for AddressCity to be an explicit nil

func (*AddressDomesticExpanded) SetAddressCountry 

func (o *AddressDomesticExpanded) SetAddressCountry(v string)

SetAddressCountry gets a reference to the given string and assigns it to the AddressCountry field.

func (*AddressDomesticExpanded) SetAddressLine1 

func (o *AddressDomesticExpanded) SetAddressLine1(v string)

SetAddressLine1 gets a reference to the given string and assigns it to the AddressLine1 field.

func (*AddressDomesticExpanded) SetAddressLine2 

func (o *AddressDomesticExpanded) SetAddressLine2(v string)

SetAddressLine2 gets a reference to the given NullableString and assigns it to the AddressLine2 field.

func (*AddressDomesticExpanded) SetAddressLine2Nil 

func (o *AddressDomesticExpanded) SetAddressLine2Nil()

SetAddressLine2Nil sets the value for AddressLine2 to be an explicit nil

func (*AddressDomesticExpanded) SetAddressState 

func (o *AddressDomesticExpanded) SetAddressState(v string)

SetAddressState gets a reference to the given NullableString and assigns it to the AddressState field.

func (*AddressDomesticExpanded) SetAddressStateNil 

func (o *AddressDomesticExpanded) SetAddressStateNil()

SetAddressStateNil sets the value for AddressState to be an explicit nil

func (*AddressDomesticExpanded) SetAddressZip 

func (o *AddressDomesticExpanded) SetAddressZip(v string)

SetAddressZip gets a reference to the given NullableString and assigns it to the AddressZip field.

func (*AddressDomesticExpanded) SetAddressZipNil 

func (o *AddressDomesticExpanded) SetAddressZipNil()

SetAddressZipNil sets the value for AddressZip to be an explicit nil

func (*AddressDomesticExpanded) SetCompany 

func (o *AddressDomesticExpanded) SetCompany(v string)

SetCompany gets a reference to the given NullableString and assigns it to the Company field.

func (*AddressDomesticExpanded) SetCompanyNil 

func (o *AddressDomesticExpanded) SetCompanyNil()

SetCompanyNil sets the value for Company to be an explicit nil

func (*AddressDomesticExpanded) SetDescription 

func (o *AddressDomesticExpanded) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*AddressDomesticExpanded) SetDescriptionNil 

func (o *AddressDomesticExpanded) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*AddressDomesticExpanded) SetEmail 

func (o *AddressDomesticExpanded) SetEmail(v string)

SetEmail gets a reference to the given NullableString and assigns it to the Email field.

func (*AddressDomesticExpanded) SetEmailNil 

func (o *AddressDomesticExpanded) SetEmailNil()

SetEmailNil sets the value for Email to be an explicit nil

func (*AddressDomesticExpanded) SetMetadata 

func (o *AddressDomesticExpanded) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*AddressDomesticExpanded) SetName 

func (o *AddressDomesticExpanded) SetName(v string)

SetName gets a reference to the given NullableString and assigns it to the Name field.

func (*AddressDomesticExpanded) SetNameNil 

func (o *AddressDomesticExpanded) SetNameNil()

SetNameNil sets the value for Name to be an explicit nil

func (*AddressDomesticExpanded) SetPhone 

func (o *AddressDomesticExpanded) SetPhone(v string)

SetPhone gets a reference to the given NullableString and assigns it to the Phone field.

func (*AddressDomesticExpanded) SetPhoneNil 

func (o *AddressDomesticExpanded) SetPhoneNil()

SetPhoneNil sets the value for Phone to be an explicit nil

func (*AddressDomesticExpanded) UnsetAddressCity 

func (o *AddressDomesticExpanded) UnsetAddressCity()

UnsetAddressCity ensures that no value is present for AddressCity, not even an explicit nil

func (*AddressDomesticExpanded) UnsetAddressLine2 

func (o *AddressDomesticExpanded) UnsetAddressLine2()

UnsetAddressLine2 ensures that no value is present for AddressLine2, not even an explicit nil

func (*AddressDomesticExpanded) UnsetAddressState 

func (o *AddressDomesticExpanded) UnsetAddressState()

UnsetAddressState ensures that no value is present for AddressState, not even an explicit nil

func (*AddressDomesticExpanded) UnsetAddressZip 

func (o *AddressDomesticExpanded) UnsetAddressZip()

UnsetAddressZip ensures that no value is present for AddressZip, not even an explicit nil

func (*AddressDomesticExpanded) UnsetCompany 

func (o *AddressDomesticExpanded) UnsetCompany()

UnsetCompany ensures that no value is present for Company, not even an explicit nil

func (*AddressDomesticExpanded) UnsetDescription 

func (o *AddressDomesticExpanded) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*AddressDomesticExpanded) UnsetEmail 

func (o *AddressDomesticExpanded) UnsetEmail()

UnsetEmail ensures that no value is present for Email, not even an explicit nil

func (*AddressDomesticExpanded) UnsetName 

func (o *AddressDomesticExpanded) UnsetName()

UnsetName ensures that no value is present for Name, not even an explicit nil

func (*AddressDomesticExpanded) UnsetPhone 

func (o *AddressDomesticExpanded) UnsetPhone()

UnsetPhone ensures that no value is present for Phone, not even an explicit nil

type AddressEditable 

type AddressEditable struct {
	// The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters.
	AddressLine1 *string `json:"address_line1,omitempty"`
	// The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters.
	AddressLine2 NullableString `json:"address_line2,omitempty"`
	AddressCity  NullableString `json:"address_city,omitempty"`
	AddressState NullableString `json:"address_state,omitempty"`
	// Optional postal code. For US addresses, must be either 5 or 9 digits.
	AddressZip     NullableString   `json:"address_zip,omitempty"`
	AddressCountry *CountryExtended `json:"address_country,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// name associated with address.
	Name NullableString `json:"name,omitempty"`
	// Either `name` or `company` is required, you may also add both.
	Company NullableString `json:"company,omitempty"`
	// Must be no longer than 40 characters.
	Phone NullableString `json:"phone,omitempty"`
	// Must be no longer than 100 characters.
	Email NullableString `json:"email,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
}

AddressEditable struct for AddressEditable

func NewAddressEditable 

func NewAddressEditable() *AddressEditable

NewAddressEditable instantiates a new AddressEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddressEditableWithDefaults 

func NewAddressEditableWithDefaults() *AddressEditable

NewAddressEditableWithDefaults instantiates a new AddressEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddressEditable) GetAddressCity 

func (o *AddressEditable) GetAddressCity() string

GetAddressCity returns the AddressCity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetAddressCityOk 

func (o *AddressEditable) GetAddressCityOk() (*string, bool)

GetAddressCityOk returns a tuple with the AddressCity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetAddressCountry 

func (o *AddressEditable) GetAddressCountry() CountryExtended

GetAddressCountry returns the AddressCountry field value if set, zero value otherwise.

func (*AddressEditable) GetAddressCountryOk 

func (o *AddressEditable) GetAddressCountryOk() (*CountryExtended, bool)

GetAddressCountryOk returns a tuple with the AddressCountry field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressEditable) GetAddressLine1 

func (o *AddressEditable) GetAddressLine1() string

GetAddressLine1 returns the AddressLine1 field value if set, zero value otherwise.

func (*AddressEditable) GetAddressLine1Ok 

func (o *AddressEditable) GetAddressLine1Ok() (*string, bool)

GetAddressLine1Ok returns a tuple with the AddressLine1 field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressEditable) GetAddressLine2 

func (o *AddressEditable) GetAddressLine2() string

GetAddressLine2 returns the AddressLine2 field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetAddressLine2Ok 

func (o *AddressEditable) GetAddressLine2Ok() (*string, bool)

GetAddressLine2Ok returns a tuple with the AddressLine2 field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetAddressState 

func (o *AddressEditable) GetAddressState() string

GetAddressState returns the AddressState field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetAddressStateOk 

func (o *AddressEditable) GetAddressStateOk() (*string, bool)

GetAddressStateOk returns a tuple with the AddressState field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetAddressZip 

func (o *AddressEditable) GetAddressZip() string

GetAddressZip returns the AddressZip field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetAddressZipOk 

func (o *AddressEditable) GetAddressZipOk() (*string, bool)

GetAddressZipOk returns a tuple with the AddressZip field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetCompany 

func (o *AddressEditable) GetCompany() string

GetCompany returns the Company field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetCompanyOk 

func (o *AddressEditable) GetCompanyOk() (*string, bool)

GetCompanyOk returns a tuple with the Company field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetDescription 

func (o *AddressEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetDescriptionOk 

func (o *AddressEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetEmail 

func (o *AddressEditable) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetEmailOk 

func (o *AddressEditable) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetMetadata 

func (o *AddressEditable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*AddressEditable) GetMetadataOk 

func (o *AddressEditable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressEditable) GetName 

func (o *AddressEditable) GetName() string

GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetNameOk 

func (o *AddressEditable) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) GetPhone 

func (o *AddressEditable) GetPhone() string

GetPhone returns the Phone field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressEditable) GetPhoneOk 

func (o *AddressEditable) GetPhoneOk() (*string, bool)

GetPhoneOk returns a tuple with the Phone field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressEditable) HasAddressCity 

func (o *AddressEditable) HasAddressCity() bool

HasAddressCity returns a boolean if a field has been set.

func (*AddressEditable) HasAddressCountry 

func (o *AddressEditable) HasAddressCountry() bool

HasAddressCountry returns a boolean if a field has been set.

func (*AddressEditable) HasAddressLine1 

func (o *AddressEditable) HasAddressLine1() bool

HasAddressLine1 returns a boolean if a field has been set.

func (*AddressEditable) HasAddressLine2 

func (o *AddressEditable) HasAddressLine2() bool

HasAddressLine2 returns a boolean if a field has been set.

func (*AddressEditable) HasAddressState 

func (o *AddressEditable) HasAddressState() bool

HasAddressState returns a boolean if a field has been set.

func (*AddressEditable) HasAddressZip 

func (o *AddressEditable) HasAddressZip() bool

HasAddressZip returns a boolean if a field has been set.

func (*AddressEditable) HasCompany 

func (o *AddressEditable) HasCompany() bool

HasCompany returns a boolean if a field has been set.

func (*AddressEditable) HasDescription 

func (o *AddressEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*AddressEditable) HasEmail 

func (o *AddressEditable) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (*AddressEditable) HasMetadata 

func (o *AddressEditable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*AddressEditable) HasName 

func (o *AddressEditable) HasName() bool

HasName returns a boolean if a field has been set.

func (*AddressEditable) HasPhone 

func (o *AddressEditable) HasPhone() bool

HasPhone returns a boolean if a field has been set.

func (AddressEditable) MarshalJSON 

func (o AddressEditable) MarshalJSON() ([]byte, error)

func (*AddressEditable) SetAddressCity 

func (o *AddressEditable) SetAddressCity(v string)

SetAddressCity gets a reference to the given NullableString and assigns it to the AddressCity field.

func (*AddressEditable) SetAddressCityNil 

func (o *AddressEditable) SetAddressCityNil()

SetAddressCityNil sets the value for AddressCity to be an explicit nil

func (*AddressEditable) SetAddressCountry 

func (o *AddressEditable) SetAddressCountry(v CountryExtended)

SetAddressCountry gets a reference to the given CountryExtended and assigns it to the AddressCountry field.

func (*AddressEditable) SetAddressLine1 

func (o *AddressEditable) SetAddressLine1(v string)

SetAddressLine1 gets a reference to the given string and assigns it to the AddressLine1 field.

func (*AddressEditable) SetAddressLine2 

func (o *AddressEditable) SetAddressLine2(v string)

SetAddressLine2 gets a reference to the given NullableString and assigns it to the AddressLine2 field.

func (*AddressEditable) SetAddressLine2Nil 

func (o *AddressEditable) SetAddressLine2Nil()

SetAddressLine2Nil sets the value for AddressLine2 to be an explicit nil

func (*AddressEditable) SetAddressState 

func (o *AddressEditable) SetAddressState(v string)

SetAddressState gets a reference to the given NullableString and assigns it to the AddressState field.

func (*AddressEditable) SetAddressStateNil 

func (o *AddressEditable) SetAddressStateNil()

SetAddressStateNil sets the value for AddressState to be an explicit nil

func (*AddressEditable) SetAddressZip 

func (o *AddressEditable) SetAddressZip(v string)

SetAddressZip gets a reference to the given NullableString and assigns it to the AddressZip field.

func (*AddressEditable) SetAddressZipNil 

func (o *AddressEditable) SetAddressZipNil()

SetAddressZipNil sets the value for AddressZip to be an explicit nil

func (*AddressEditable) SetCompany 

func (o *AddressEditable) SetCompany(v string)

SetCompany gets a reference to the given NullableString and assigns it to the Company field.

func (*AddressEditable) SetCompanyNil 

func (o *AddressEditable) SetCompanyNil()

SetCompanyNil sets the value for Company to be an explicit nil

func (*AddressEditable) SetDescription 

func (o *AddressEditable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*AddressEditable) SetDescriptionNil 

func (o *AddressEditable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*AddressEditable) SetEmail 

func (o *AddressEditable) SetEmail(v string)

SetEmail gets a reference to the given NullableString and assigns it to the Email field.

func (*AddressEditable) SetEmailNil 

func (o *AddressEditable) SetEmailNil()

SetEmailNil sets the value for Email to be an explicit nil

func (*AddressEditable) SetMetadata 

func (o *AddressEditable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*AddressEditable) SetName 

func (o *AddressEditable) SetName(v string)

SetName gets a reference to the given NullableString and assigns it to the Name field.

func (*AddressEditable) SetNameNil 

func (o *AddressEditable) SetNameNil()

SetNameNil sets the value for Name to be an explicit nil

func (*AddressEditable) SetPhone 

func (o *AddressEditable) SetPhone(v string)

SetPhone gets a reference to the given NullableString and assigns it to the Phone field.

func (*AddressEditable) SetPhoneNil 

func (o *AddressEditable) SetPhoneNil()

SetPhoneNil sets the value for Phone to be an explicit nil

func (*AddressEditable) UnsetAddressCity 

func (o *AddressEditable) UnsetAddressCity()

UnsetAddressCity ensures that no value is present for AddressCity, not even an explicit nil

func (*AddressEditable) UnsetAddressLine2 

func (o *AddressEditable) UnsetAddressLine2()

UnsetAddressLine2 ensures that no value is present for AddressLine2, not even an explicit nil

func (*AddressEditable) UnsetAddressState 

func (o *AddressEditable) UnsetAddressState()

UnsetAddressState ensures that no value is present for AddressState, not even an explicit nil

func (*AddressEditable) UnsetAddressZip 

func (o *AddressEditable) UnsetAddressZip()

UnsetAddressZip ensures that no value is present for AddressZip, not even an explicit nil

func (*AddressEditable) UnsetCompany 

func (o *AddressEditable) UnsetCompany()

UnsetCompany ensures that no value is present for Company, not even an explicit nil

func (*AddressEditable) UnsetDescription 

func (o *AddressEditable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*AddressEditable) UnsetEmail 

func (o *AddressEditable) UnsetEmail()

UnsetEmail ensures that no value is present for Email, not even an explicit nil

func (*AddressEditable) UnsetName 

func (o *AddressEditable) UnsetName()

UnsetName ensures that no value is present for Name, not even an explicit nil

func (*AddressEditable) UnsetPhone 

func (o *AddressEditable) UnsetPhone()

UnsetPhone ensures that no value is present for Phone, not even an explicit nil

type AddressList 

type AddressList struct {
	// list of addresses
	Data []Address `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

AddressList struct for AddressList

func NewAddressList 

func NewAddressList() *AddressList

NewAddressList instantiates a new AddressList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddressListWithDefaults 

func NewAddressListWithDefaults() *AddressList

NewAddressListWithDefaults instantiates a new AddressList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddressList) GetCount 

func (o *AddressList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*AddressList) GetCountOk 

func (o *AddressList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressList) GetData 

func (o *AddressList) GetData() []Address

GetData returns the Data field value if set, zero value otherwise.

func (*AddressList) GetDataOk 

func (o *AddressList) GetDataOk() ([]Address, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressList) GetNextPageToken 

func (o *AddressList) GetNextPageToken() string

func (*AddressList) GetNextUrl 

func (o *AddressList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressList) GetNextUrlOk 

func (o *AddressList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressList) GetObject 

func (o *AddressList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*AddressList) GetObjectOk 

func (o *AddressList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressList) GetPrevPageToken 

func (o *AddressList) GetPrevPageToken() string

func (*AddressList) GetPreviousUrl 

func (o *AddressList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AddressList) GetPreviousUrlOk 

func (o *AddressList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AddressList) GetTotalCount 

func (o *AddressList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*AddressList) GetTotalCountOk 

func (o *AddressList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AddressList) HasCount 

func (o *AddressList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*AddressList) HasData 

func (o *AddressList) HasData() bool

HasData returns a boolean if a field has been set.

func (*AddressList) HasNextUrl 

func (o *AddressList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*AddressList) HasObject 

func (o *AddressList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*AddressList) HasPreviousUrl 

func (o *AddressList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*AddressList) HasTotalCount 

func (o *AddressList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (AddressList) MarshalJSON 

func (o AddressList) MarshalJSON() ([]byte, error)

func (*AddressList) SetCount 

func (o *AddressList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*AddressList) SetData 

func (o *AddressList) SetData(v []Address)

SetData gets a reference to the given []Address and assigns it to the Data field.

func (*AddressList) SetNextUrl 

func (o *AddressList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*AddressList) SetNextUrlNil 

func (o *AddressList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*AddressList) SetObject 

func (o *AddressList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*AddressList) SetPreviousUrl 

func (o *AddressList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*AddressList) SetPreviousUrlNil 

func (o *AddressList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*AddressList) SetTotalCount 

func (o *AddressList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*AddressList) UnsetNextUrl 

func (o *AddressList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*AddressList) UnsetPreviousUrl 

func (o *AddressList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type AddressesApiService 

type AddressesApiService service

AddressesApiService AddressesApi service

func (*AddressesApiService) AddressCreateExecute 

func (a *AddressesApiService) AddressCreateExecute(r ApiAddressCreateRequest) (*Address, *http.Response, error)

Execute executes the request 

@return Address

func (*AddressesApiService) AddressDeleteExecute 

func (a *AddressesApiService) AddressDeleteExecute(r ApiAddressDeleteRequest) (*AddressDeletion, *http.Response, error)

Execute executes the request 

@return AddressDeletion

func (*AddressesApiService) AddressRetrieveExecute 

func (a *AddressesApiService) AddressRetrieveExecute(r ApiAddressRetrieveRequest) (*Address, *http.Response, error)

Execute executes the request 

@return Address

func (*AddressesApiService) AddressesListExecute 

func (a *AddressesApiService) AddressesListExecute(r ApiAddressesListRequest) (*AddressList, *http.Response, error)

Execute executes the request 

@return AddressList

func (*AddressesApiService) Create 

func (a *AddressesApiService) Create(ctx context.Context) ApiAddressCreateRequest

AddressCreate create

Creates a new address given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiAddressCreateRequest

func (*AddressesApiService) Delete 

func (a *AddressesApiService) Delete(ctx context.Context, adrId string) ApiAddressDeleteRequest

AddressDelete delete

Deletes the details of an existing address. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param adrId id of the address
@return ApiAddressDeleteRequest

func (*AddressesApiService) Get 

func (a *AddressesApiService) Get(ctx context.Context, adrId string) ApiAddressRetrieveRequest

AddressRetrieve get

Retrieves the details of an existing address. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param adrId id of the address
@return ApiAddressRetrieveRequest

func (*AddressesApiService) List 

func (a *AddressesApiService) List(ctx context.Context) ApiAddressesListRequest

AddressesList list

Returns a list of your addresses. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiAddressesListRequest

type ApiAddressCreateRequest 

type ApiAddressCreateRequest struct {
	ApiService *AddressesApiService
	// contains filtered or unexported fields
}

func (ApiAddressCreateRequest) AddressEditable 

func (r ApiAddressCreateRequest) AddressEditable(addressEditable AddressEditable) ApiAddressCreateRequest

func (ApiAddressCreateRequest) Execute 

func (r ApiAddressCreateRequest) Execute() (*Address, *http.Response, error)

type ApiAddressDeleteRequest 

type ApiAddressDeleteRequest struct {
	ApiService *AddressesApiService
	// contains filtered or unexported fields
}

func (ApiAddressDeleteRequest) Execute 

func (r ApiAddressDeleteRequest) Execute() (*AddressDeletion, *http.Response, error)

type ApiAddressRetrieveRequest 

type ApiAddressRetrieveRequest struct {
	ApiService *AddressesApiService
	// contains filtered or unexported fields
}

func (ApiAddressRetrieveRequest) Execute 

func (r ApiAddressRetrieveRequest) Execute() (*Address, *http.Response, error)

type ApiAddressesListRequest 

type ApiAddressesListRequest struct {
	ApiService *AddressesApiService
	// contains filtered or unexported fields
}

func (ApiAddressesListRequest) After 

func (r ApiAddressesListRequest) After(after string) ApiAddressesListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiAddressesListRequest) Before 

func (r ApiAddressesListRequest) Before(before string) ApiAddressesListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiAddressesListRequest) DateCreated 

func (r ApiAddressesListRequest) DateCreated(dateCreated map[string]time.Time) ApiAddressesListRequest

Filter by date created.

func (ApiAddressesListRequest) Execute 

func (r ApiAddressesListRequest) Execute() (*AddressList, *http.Response, error)

func (ApiAddressesListRequest) Include 

func (r ApiAddressesListRequest) Include(include []string) ApiAddressesListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiAddressesListRequest) Limit 

func (r ApiAddressesListRequest) Limit(limit int32) ApiAddressesListRequest

How many results to return.

func (ApiAddressesListRequest) Metadata 

func (r ApiAddressesListRequest) Metadata(metadata map[string]string) ApiAddressesListRequest

Filter by metadata key-value pair&#x60;.

type ApiBankAccountCreateRequest 

type ApiBankAccountCreateRequest struct {
	ApiService *BankAccountsApiService
	// contains filtered or unexported fields
}

func (ApiBankAccountCreateRequest) BankAccountWritable 

func (r ApiBankAccountCreateRequest) BankAccountWritable(bankAccountWritable BankAccountWritable) ApiBankAccountCreateRequest

func (ApiBankAccountCreateRequest) Execute 

func (r ApiBankAccountCreateRequest) Execute() (*BankAccount, *http.Response, error)

type ApiBankAccountDeleteRequest 

type ApiBankAccountDeleteRequest struct {
	ApiService *BankAccountsApiService
	// contains filtered or unexported fields
}

func (ApiBankAccountDeleteRequest) Execute 

func (r ApiBankAccountDeleteRequest) Execute() (*BankAccountDeletion, *http.Response, error)

type ApiBankAccountRetrieveRequest 

type ApiBankAccountRetrieveRequest struct {
	ApiService *BankAccountsApiService
	// contains filtered or unexported fields
}

func (ApiBankAccountRetrieveRequest) Execute 

func (r ApiBankAccountRetrieveRequest) Execute() (*BankAccount, *http.Response, error)

type ApiBankAccountVerifyRequest 

type ApiBankAccountVerifyRequest struct {
	ApiService *BankAccountsApiService
	// contains filtered or unexported fields
}

func (ApiBankAccountVerifyRequest) BankAccountVerify 

func (r ApiBankAccountVerifyRequest) BankAccountVerify(bankAccountVerify BankAccountVerify) ApiBankAccountVerifyRequest

func (ApiBankAccountVerifyRequest) Execute 

func (r ApiBankAccountVerifyRequest) Execute() (*BankAccount, *http.Response, error)

type ApiBankAccountsListRequest 

type ApiBankAccountsListRequest struct {
	ApiService *BankAccountsApiService
	// contains filtered or unexported fields
}

func (ApiBankAccountsListRequest) After 

func (r ApiBankAccountsListRequest) After(after string) ApiBankAccountsListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiBankAccountsListRequest) Before 

func (r ApiBankAccountsListRequest) Before(before string) ApiBankAccountsListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiBankAccountsListRequest) DateCreated 

func (r ApiBankAccountsListRequest) DateCreated(dateCreated map[string]time.Time) ApiBankAccountsListRequest

Filter by date created.

func (ApiBankAccountsListRequest) Execute 

func (r ApiBankAccountsListRequest) Execute() (*BankAccountList, *http.Response, error)

func (ApiBankAccountsListRequest) Include 

func (r ApiBankAccountsListRequest) Include(include []string) ApiBankAccountsListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiBankAccountsListRequest) Limit 

func (r ApiBankAccountsListRequest) Limit(limit int32) ApiBankAccountsListRequest

How many results to return.

func (ApiBankAccountsListRequest) Metadata 

func (r ApiBankAccountsListRequest) Metadata(metadata map[string]string) ApiBankAccountsListRequest

Filter by metadata key-value pair&#x60;.

type ApiBillingGroupCreateRequest 

type ApiBillingGroupCreateRequest struct {
	ApiService *BillingGroupsApiService
	// contains filtered or unexported fields
}

func (ApiBillingGroupCreateRequest) BillingGroupEditable 

func (r ApiBillingGroupCreateRequest) BillingGroupEditable(billingGroupEditable BillingGroupEditable) ApiBillingGroupCreateRequest

func (ApiBillingGroupCreateRequest) Execute 

func (r ApiBillingGroupCreateRequest) Execute() (*BillingGroup, *http.Response, error)

type ApiBillingGroupRetrieveRequest 

type ApiBillingGroupRetrieveRequest struct {
	ApiService *BillingGroupsApiService
	// contains filtered or unexported fields
}

func (ApiBillingGroupRetrieveRequest) Execute 

func (r ApiBillingGroupRetrieveRequest) Execute() (*BillingGroup, *http.Response, error)

type ApiBillingGroupUpdateRequest 

type ApiBillingGroupUpdateRequest struct {
	ApiService *BillingGroupsApiService
	// contains filtered or unexported fields
}

func (ApiBillingGroupUpdateRequest) BillingGroupEditable 

func (r ApiBillingGroupUpdateRequest) BillingGroupEditable(billingGroupEditable BillingGroupEditable) ApiBillingGroupUpdateRequest

func (ApiBillingGroupUpdateRequest) Execute 

func (r ApiBillingGroupUpdateRequest) Execute() (*BillingGroup, *http.Response, error)

type ApiBillingGroupsListRequest 

type ApiBillingGroupsListRequest struct {
	ApiService *BillingGroupsApiService
	// contains filtered or unexported fields
}

func (ApiBillingGroupsListRequest) DateCreated 

func (r ApiBillingGroupsListRequest) DateCreated(dateCreated map[string]time.Time) ApiBillingGroupsListRequest

Filter by date created.

func (ApiBillingGroupsListRequest) DateModified 

func (r ApiBillingGroupsListRequest) DateModified(dateModified map[string]string) ApiBillingGroupsListRequest

Filter by date modified.

func (ApiBillingGroupsListRequest) Execute 

func (r ApiBillingGroupsListRequest) Execute() (*BillingGroupList, *http.Response, error)

func (ApiBillingGroupsListRequest) Include 

func (r ApiBillingGroupsListRequest) Include(include []string) ApiBillingGroupsListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiBillingGroupsListRequest) Limit 

func (r ApiBillingGroupsListRequest) Limit(limit int32) ApiBillingGroupsListRequest

How many results to return.

func (ApiBillingGroupsListRequest) Offset 

func (r ApiBillingGroupsListRequest) Offset(offset int32) ApiBillingGroupsListRequest

An integer that designates the offset at which to begin returning results. Defaults to 0.

func (ApiBillingGroupsListRequest) SortByDateModified 

func (r ApiBillingGroupsListRequest) SortByDateModified(sortByDateModified SortByDateModified) ApiBillingGroupsListRequest

Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;date_modfied&#x60;, not both.

type ApiBuckslipCreateRequest 

type ApiBuckslipCreateRequest struct {
	ApiService *BuckslipsApiService
	// contains filtered or unexported fields
}

func (ApiBuckslipCreateRequest) BuckslipEditable 

func (r ApiBuckslipCreateRequest) BuckslipEditable(buckslipEditable BuckslipEditable) ApiBuckslipCreateRequest

func (ApiBuckslipCreateRequest) Execute 

func (r ApiBuckslipCreateRequest) Execute() (*Buckslip, *http.Response, error)

type ApiBuckslipDeleteRequest 

type ApiBuckslipDeleteRequest struct {
	ApiService *BuckslipsApiService
	// contains filtered or unexported fields
}

func (ApiBuckslipDeleteRequest) Execute 

func (r ApiBuckslipDeleteRequest) Execute() (*BuckslipDeletion, *http.Response, error)

type ApiBuckslipOrderCreateRequest 

type ApiBuckslipOrderCreateRequest struct {
	ApiService *BuckslipOrdersApiService
	// contains filtered or unexported fields
}

func (ApiBuckslipOrderCreateRequest) BuckslipOrderEditable 

func (r ApiBuckslipOrderCreateRequest) BuckslipOrderEditable(buckslipOrderEditable BuckslipOrderEditable) ApiBuckslipOrderCreateRequest

func (ApiBuckslipOrderCreateRequest) Execute 

func (r ApiBuckslipOrderCreateRequest) Execute() (*BuckslipOrder, *http.Response, error)

type ApiBuckslipOrdersRetrieveRequest 

type ApiBuckslipOrdersRetrieveRequest struct {
	ApiService *BuckslipOrdersApiService
	// contains filtered or unexported fields
}

func (ApiBuckslipOrdersRetrieveRequest) Execute 

func (r ApiBuckslipOrdersRetrieveRequest) Execute() (*BuckslipOrdersList, *http.Response, error)

func (ApiBuckslipOrdersRetrieveRequest) Limit 

func (r ApiBuckslipOrdersRetrieveRequest) Limit(limit int32) ApiBuckslipOrdersRetrieveRequest

How many results to return.

func (ApiBuckslipOrdersRetrieveRequest) Offset 

func (r ApiBuckslipOrdersRetrieveRequest) Offset(offset int32) ApiBuckslipOrdersRetrieveRequest

An integer that designates the offset at which to begin returning results. Defaults to 0.

type ApiBuckslipRetrieveRequest 

type ApiBuckslipRetrieveRequest struct {
	ApiService *BuckslipsApiService
	// contains filtered or unexported fields
}

func (ApiBuckslipRetrieveRequest) Execute 

func (r ApiBuckslipRetrieveRequest) Execute() (*Buckslip, *http.Response, error)

type ApiBuckslipUpdateRequest 

type ApiBuckslipUpdateRequest struct {
	ApiService *BuckslipsApiService
	// contains filtered or unexported fields
}

func (ApiBuckslipUpdateRequest) BuckslipUpdatable 

func (r ApiBuckslipUpdateRequest) BuckslipUpdatable(buckslipUpdatable BuckslipUpdatable) ApiBuckslipUpdateRequest

func (ApiBuckslipUpdateRequest) Execute 

func (r ApiBuckslipUpdateRequest) Execute() (*Buckslip, *http.Response, error)

type ApiBuckslipsListRequest 

type ApiBuckslipsListRequest struct {
	ApiService *BuckslipsApiService
	// contains filtered or unexported fields
}

func (ApiBuckslipsListRequest) After 

func (r ApiBuckslipsListRequest) After(after string) ApiBuckslipsListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiBuckslipsListRequest) Before 

func (r ApiBuckslipsListRequest) Before(before string) ApiBuckslipsListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiBuckslipsListRequest) Execute 

func (r ApiBuckslipsListRequest) Execute() (*BuckslipsList, *http.Response, error)

func (ApiBuckslipsListRequest) Include 

func (r ApiBuckslipsListRequest) Include(include []string) ApiBuckslipsListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiBuckslipsListRequest) Limit 

func (r ApiBuckslipsListRequest) Limit(limit int32) ApiBuckslipsListRequest

How many results to return.

type ApiBulkIntlVerificationsRequest 

type ApiBulkIntlVerificationsRequest struct {
	ApiService *IntlVerificationsApiService
	// contains filtered or unexported fields
}

func (ApiBulkIntlVerificationsRequest) Execute 

func (r ApiBulkIntlVerificationsRequest) Execute() (*IntlVerifications, *http.Response, error)

func (ApiBulkIntlVerificationsRequest) IntlVerificationsPayload 

func (r ApiBulkIntlVerificationsRequest) IntlVerificationsPayload(intlVerificationsPayload IntlVerificationsPayload) ApiBulkIntlVerificationsRequest

type ApiBulkUsVerificationsRequest 

type ApiBulkUsVerificationsRequest struct {
	ApiService *UsVerificationsApiService
	// contains filtered or unexported fields
}

func (ApiBulkUsVerificationsRequest) Case_ 

func (r ApiBulkUsVerificationsRequest) Case_(case_ string) ApiBulkUsVerificationsRequest

Casing of the verified address. Possible values are &#x60;upper&#x60; and &#x60;proper&#x60; for uppercased (e.g. \&quot;PO BOX\&quot;) and proper-cased (e.g. \&quot;PO Box\&quot;), respectively.

func (ApiBulkUsVerificationsRequest) Execute 

func (r ApiBulkUsVerificationsRequest) Execute() (*UsVerifications, *http.Response, error)

func (ApiBulkUsVerificationsRequest) MultipleComponentsList 

func (r ApiBulkUsVerificationsRequest) MultipleComponentsList(multipleComponentsList MultipleComponentsList) ApiBulkUsVerificationsRequest

type ApiCampaignCreateRequest 

type ApiCampaignCreateRequest struct {
	ApiService *CampaignsApiService
	// contains filtered or unexported fields
}

func (ApiCampaignCreateRequest) CampaignWritable 

func (r ApiCampaignCreateRequest) CampaignWritable(campaignWritable CampaignWritable) ApiCampaignCreateRequest

func (ApiCampaignCreateRequest) Execute 

func (r ApiCampaignCreateRequest) Execute() (*Campaign, *http.Response, error)

func (ApiCampaignCreateRequest) XLangOutput 

func (r ApiCampaignCreateRequest) XLangOutput(xLangOutput string) ApiCampaignCreateRequest

* &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request Default response is in English.

type ApiCampaignDeleteRequest 

type ApiCampaignDeleteRequest struct {
	ApiService *CampaignsApiService
	// contains filtered or unexported fields
}

func (ApiCampaignDeleteRequest) Execute 

func (r ApiCampaignDeleteRequest) Execute() (*CampaignDeletion, *http.Response, error)

type ApiCampaignRetrieveRequest 

type ApiCampaignRetrieveRequest struct {
	ApiService *CampaignsApiService
	// contains filtered or unexported fields
}

func (ApiCampaignRetrieveRequest) Execute 

func (r ApiCampaignRetrieveRequest) Execute() (*Campaign, *http.Response, error)

type ApiCampaignUpdateRequest 

type ApiCampaignUpdateRequest struct {
	ApiService *CampaignsApiService
	// contains filtered or unexported fields
}

func (ApiCampaignUpdateRequest) CampaignUpdatable 

func (r ApiCampaignUpdateRequest) CampaignUpdatable(campaignUpdatable CampaignUpdatable) ApiCampaignUpdateRequest

func (ApiCampaignUpdateRequest) Execute 

func (r ApiCampaignUpdateRequest) Execute() (*Campaign, *http.Response, error)

type ApiCampaignsListRequest 

type ApiCampaignsListRequest struct {
	ApiService *CampaignsApiService
	// contains filtered or unexported fields
}

func (ApiCampaignsListRequest) After 

func (r ApiCampaignsListRequest) After(after string) ApiCampaignsListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiCampaignsListRequest) Before 

func (r ApiCampaignsListRequest) Before(before string) ApiCampaignsListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiCampaignsListRequest) Execute 

func (r ApiCampaignsListRequest) Execute() (*CampaignsList, *http.Response, error)

func (ApiCampaignsListRequest) Include 

func (r ApiCampaignsListRequest) Include(include []string) ApiCampaignsListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiCampaignsListRequest) Limit 

func (r ApiCampaignsListRequest) Limit(limit int32) ApiCampaignsListRequest

How many results to return.

type ApiCardCreateRequest 

type ApiCardCreateRequest struct {
	ApiService *CardsApiService
	// contains filtered or unexported fields
}

func (ApiCardCreateRequest) CardEditable 

func (r ApiCardCreateRequest) CardEditable(cardEditable CardEditable) ApiCardCreateRequest

func (ApiCardCreateRequest) Execute 

func (r ApiCardCreateRequest) Execute() (*Card, *http.Response, error)

type ApiCardDeleteRequest 

type ApiCardDeleteRequest struct {
	ApiService *CardsApiService
	// contains filtered or unexported fields
}

func (ApiCardDeleteRequest) Execute 

func (r ApiCardDeleteRequest) Execute() (*CardDeletion, *http.Response, error)

type ApiCardOrderCreateRequest 

type ApiCardOrderCreateRequest struct {
	ApiService *CardOrdersApiService
	// contains filtered or unexported fields
}

func (ApiCardOrderCreateRequest) CardOrderEditable 

func (r ApiCardOrderCreateRequest) CardOrderEditable(cardOrderEditable CardOrderEditable) ApiCardOrderCreateRequest

func (ApiCardOrderCreateRequest) Execute 

func (r ApiCardOrderCreateRequest) Execute() (*CardOrder, *http.Response, error)

type ApiCardOrdersRetrieveRequest 

type ApiCardOrdersRetrieveRequest struct {
	ApiService *CardOrdersApiService
	// contains filtered or unexported fields
}

func (ApiCardOrdersRetrieveRequest) Execute 

func (r ApiCardOrdersRetrieveRequest) Execute() (*CardOrderList, *http.Response, error)

func (ApiCardOrdersRetrieveRequest) Limit 

func (r ApiCardOrdersRetrieveRequest) Limit(limit int32) ApiCardOrdersRetrieveRequest

How many results to return.

func (ApiCardOrdersRetrieveRequest) Offset 

func (r ApiCardOrdersRetrieveRequest) Offset(offset int32) ApiCardOrdersRetrieveRequest

An integer that designates the offset at which to begin returning results. Defaults to 0.

type ApiCardRetrieveRequest 

type ApiCardRetrieveRequest struct {
	ApiService *CardsApiService
	// contains filtered or unexported fields
}

func (ApiCardRetrieveRequest) Execute 

func (r ApiCardRetrieveRequest) Execute() (*Card, *http.Response, error)

type ApiCardUpdateRequest 

type ApiCardUpdateRequest struct {
	ApiService *CardsApiService
	// contains filtered or unexported fields
}

func (ApiCardUpdateRequest) CardUpdatable 

func (r ApiCardUpdateRequest) CardUpdatable(cardUpdatable CardUpdatable) ApiCardUpdateRequest

func (ApiCardUpdateRequest) Execute 

func (r ApiCardUpdateRequest) Execute() (*Card, *http.Response, error)

type ApiCardsListRequest 

type ApiCardsListRequest struct {
	ApiService *CardsApiService
	// contains filtered or unexported fields
}

func (ApiCardsListRequest) After 

func (r ApiCardsListRequest) After(after string) ApiCardsListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiCardsListRequest) Before 

func (r ApiCardsListRequest) Before(before string) ApiCardsListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiCardsListRequest) Execute 

func (r ApiCardsListRequest) Execute() (*CardList, *http.Response, error)

func (ApiCardsListRequest) Include 

func (r ApiCardsListRequest) Include(include []string) ApiCardsListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiCardsListRequest) Limit 

func (r ApiCardsListRequest) Limit(limit int32) ApiCardsListRequest

How many results to return.

type ApiCheckCancelRequest 

type ApiCheckCancelRequest struct {
	ApiService *ChecksApiService
	// contains filtered or unexported fields
}

func (ApiCheckCancelRequest) Execute 

func (r ApiCheckCancelRequest) Execute() (*CheckDeletion, *http.Response, error)

type ApiCheckCreateRequest 

type ApiCheckCreateRequest struct {
	ApiService *ChecksApiService
	// contains filtered or unexported fields
}

func (ApiCheckCreateRequest) CheckEditable 

func (r ApiCheckCreateRequest) CheckEditable(checkEditable CheckEditable) ApiCheckCreateRequest

func (ApiCheckCreateRequest) Execute 

func (r ApiCheckCreateRequest) Execute() (*Check, *http.Response, error)

func (ApiCheckCreateRequest) IdempotencyKey 

func (r ApiCheckCreateRequest) IdempotencyKey(idempotencyKey string) ApiCheckCreateRequest

A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request).

type ApiCheckRetrieveRequest 

type ApiCheckRetrieveRequest struct {
	ApiService *ChecksApiService
	// contains filtered or unexported fields
}

func (ApiCheckRetrieveRequest) Execute 

func (r ApiCheckRetrieveRequest) Execute() (*Check, *http.Response, error)

type ApiChecksListRequest 

type ApiChecksListRequest struct {
	ApiService *ChecksApiService
	// contains filtered or unexported fields
}

func (ApiChecksListRequest) After 

func (r ApiChecksListRequest) After(after string) ApiChecksListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiChecksListRequest) Before 

func (r ApiChecksListRequest) Before(before string) ApiChecksListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiChecksListRequest) DateCreated 

func (r ApiChecksListRequest) DateCreated(dateCreated map[string]time.Time) ApiChecksListRequest

Filter by date created.

func (ApiChecksListRequest) Execute 

func (r ApiChecksListRequest) Execute() (*CheckList, *http.Response, error)

func (ApiChecksListRequest) Include 

func (r ApiChecksListRequest) Include(include []string) ApiChecksListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiChecksListRequest) Limit 

func (r ApiChecksListRequest) Limit(limit int32) ApiChecksListRequest

How many results to return.

func (ApiChecksListRequest) MailType 

func (r ApiChecksListRequest) MailType(mailType MailType) ApiChecksListRequest

A string designating the mail postage type: * &#x60;usps_first_class&#x60; - (default) * &#x60;usps_standard&#x60; - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. &#x60;usps_standard&#x60; cannot be used with &#x60;4x6&#x60; postcards or for any postcards sent outside of the United States.

func (ApiChecksListRequest) Metadata 

func (r ApiChecksListRequest) Metadata(metadata map[string]string) ApiChecksListRequest

Filter by metadata key-value pair&#x60;.

func (ApiChecksListRequest) Scheduled 

func (r ApiChecksListRequest) Scheduled(scheduled bool) ApiChecksListRequest

* &#x60;true&#x60; - only return orders (past or future) where &#x60;send_date&#x60; is greater than &#x60;date_created&#x60; * &#x60;false&#x60; - only return orders where &#x60;send_date&#x60; is equal to &#x60;date_created&#x60;

func (ApiChecksListRequest) SendDate 

func (r ApiChecksListRequest) SendDate(sendDate map[string]string) ApiChecksListRequest

Filter by date sent.

func (ApiChecksListRequest) SortBy 

func (r ApiChecksListRequest) SortBy(sortBy SortBy3) ApiChecksListRequest

Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.

type ApiCreateTemplateRequest 

type ApiCreateTemplateRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiCreateTemplateRequest) Execute 

func (r ApiCreateTemplateRequest) Execute() (*Template, *http.Response, error)

func (ApiCreateTemplateRequest) TemplateWritable 

func (r ApiCreateTemplateRequest) TemplateWritable(templateWritable TemplateWritable) ApiCreateTemplateRequest

type ApiCreateTemplateVersionRequest 

type ApiCreateTemplateVersionRequest struct {
	ApiService *TemplateVersionsApiService
	// contains filtered or unexported fields
}

func (ApiCreateTemplateVersionRequest) Execute 

func (r ApiCreateTemplateVersionRequest) Execute() (*TemplateVersion, *http.Response, error)

func (ApiCreateTemplateVersionRequest) TemplateVersionWritable 

func (r ApiCreateTemplateVersionRequest) TemplateVersionWritable(templateVersionWritable TemplateVersionWritable) ApiCreateTemplateVersionRequest

type ApiCreativeCreateRequest 

type ApiCreativeCreateRequest struct {
	ApiService *CreativesApiService
	// contains filtered or unexported fields
}

func (ApiCreativeCreateRequest) CreativeWritable 

func (r ApiCreativeCreateRequest) CreativeWritable(creativeWritable CreativeWritable) ApiCreativeCreateRequest

func (ApiCreativeCreateRequest) Execute 

func (r ApiCreativeCreateRequest) Execute() (*CreativeResponse, *http.Response, error)

func (ApiCreativeCreateRequest) XLangOutput 

func (r ApiCreativeCreateRequest) XLangOutput(xLangOutput string) ApiCreativeCreateRequest

* &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request Default response is in English.

type ApiCreativeRetrieveRequest 

type ApiCreativeRetrieveRequest struct {
	ApiService *CreativesApiService
	// contains filtered or unexported fields
}

func (ApiCreativeRetrieveRequest) Execute 

func (r ApiCreativeRetrieveRequest) Execute() (*CreativeResponse, *http.Response, error)

type ApiCreativeUpdateRequest 

type ApiCreativeUpdateRequest struct {
	ApiService *CreativesApiService
	// contains filtered or unexported fields
}

func (ApiCreativeUpdateRequest) CreativePatch 

func (r ApiCreativeUpdateRequest) CreativePatch(creativePatch CreativePatch) ApiCreativeUpdateRequest

func (ApiCreativeUpdateRequest) Execute 

func (r ApiCreativeUpdateRequest) Execute() (*CreativeResponse, *http.Response, error)

type ApiIdentityValidationRequest 

type ApiIdentityValidationRequest struct {
	ApiService *IdentityValidationApiService
	// contains filtered or unexported fields
}

func (ApiIdentityValidationRequest) Execute 

func (r ApiIdentityValidationRequest) Execute() (*IdentityValidation, *http.Response, error)

func (ApiIdentityValidationRequest) MultiLineAddress 

func (r ApiIdentityValidationRequest) MultiLineAddress(multiLineAddress MultiLineAddress) ApiIdentityValidationRequest

type ApiIntlAutocompletionRequest 

type ApiIntlAutocompletionRequest struct {
	ApiService *IntlAutocompletionsApiService
	// contains filtered or unexported fields
}

func (ApiIntlAutocompletionRequest) Execute 

func (r ApiIntlAutocompletionRequest) Execute() (*IntlAutocompletions, *http.Response, error)

func (ApiIntlAutocompletionRequest) IntlAutocompletionsWritable 

func (r ApiIntlAutocompletionRequest) IntlAutocompletionsWritable(intlAutocompletionsWritable IntlAutocompletionsWritable) ApiIntlAutocompletionRequest

func (ApiIntlAutocompletionRequest) XLangOutput 

func (r ApiIntlAutocompletionRequest) XLangOutput(xLangOutput string) ApiIntlAutocompletionRequest

* &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request Default response is in English.

type ApiIntlVerificationRequest 

type ApiIntlVerificationRequest struct {
	ApiService *IntlVerificationsApiService
	// contains filtered or unexported fields
}

func (ApiIntlVerificationRequest) Execute 

func (r ApiIntlVerificationRequest) Execute() (*IntlVerification, *http.Response, error)

func (ApiIntlVerificationRequest) IntlVerificationWritable 

func (r ApiIntlVerificationRequest) IntlVerificationWritable(intlVerificationWritable IntlVerificationWritable) ApiIntlVerificationRequest

func (ApiIntlVerificationRequest) XLangOutput 

func (r ApiIntlVerificationRequest) XLangOutput(xLangOutput string) ApiIntlVerificationRequest

* &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request Default response is in English.

type ApiLetterCancelRequest 

type ApiLetterCancelRequest struct {
	ApiService *LettersApiService
	// contains filtered or unexported fields
}

func (ApiLetterCancelRequest) Execute 

func (r ApiLetterCancelRequest) Execute() (*LetterDeletion, *http.Response, error)

type ApiLetterCreateRequest 

type ApiLetterCreateRequest struct {
	ApiService *LettersApiService
	// contains filtered or unexported fields
}

func (ApiLetterCreateRequest) Execute 

func (r ApiLetterCreateRequest) Execute() (*Letter, *http.Response, error)

func (ApiLetterCreateRequest) IdempotencyKey 

func (r ApiLetterCreateRequest) IdempotencyKey(idempotencyKey string) ApiLetterCreateRequest

A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request).

func (ApiLetterCreateRequest) LetterEditable 

func (r ApiLetterCreateRequest) LetterEditable(letterEditable LetterEditable) ApiLetterCreateRequest

type ApiLetterRetrieveRequest 

type ApiLetterRetrieveRequest struct {
	ApiService *LettersApiService
	// contains filtered or unexported fields
}

func (ApiLetterRetrieveRequest) Execute 

func (r ApiLetterRetrieveRequest) Execute() (*Letter, *http.Response, error)

type ApiLettersListRequest 

type ApiLettersListRequest struct {
	ApiService *LettersApiService
	// contains filtered or unexported fields
}

func (ApiLettersListRequest) After 

func (r ApiLettersListRequest) After(after string) ApiLettersListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiLettersListRequest) Before 

func (r ApiLettersListRequest) Before(before string) ApiLettersListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiLettersListRequest) Color 

func (r ApiLettersListRequest) Color(color bool) ApiLettersListRequest

Set to &#x60;true&#x60; to return only color letters. Set to &#x60;false&#x60; to return only black &amp; white letters.

func (ApiLettersListRequest) DateCreated 

func (r ApiLettersListRequest) DateCreated(dateCreated map[string]time.Time) ApiLettersListRequest

Filter by date created.

func (ApiLettersListRequest) Execute 

func (r ApiLettersListRequest) Execute() (*LetterList, *http.Response, error)

func (ApiLettersListRequest) Include 

func (r ApiLettersListRequest) Include(include []string) ApiLettersListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiLettersListRequest) Limit 

func (r ApiLettersListRequest) Limit(limit int32) ApiLettersListRequest

How many results to return.

func (ApiLettersListRequest) MailType 

func (r ApiLettersListRequest) MailType(mailType MailType) ApiLettersListRequest

A string designating the mail postage type: * &#x60;usps_first_class&#x60; - (default) * &#x60;usps_standard&#x60; - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. &#x60;usps_standard&#x60; cannot be used with &#x60;4x6&#x60; postcards or for any postcards sent outside of the United States.

func (ApiLettersListRequest) Metadata 

func (r ApiLettersListRequest) Metadata(metadata map[string]string) ApiLettersListRequest

Filter by metadata key-value pair&#x60;.

func (ApiLettersListRequest) Scheduled 

func (r ApiLettersListRequest) Scheduled(scheduled bool) ApiLettersListRequest

* &#x60;true&#x60; - only return orders (past or future) where &#x60;send_date&#x60; is greater than &#x60;date_created&#x60; * &#x60;false&#x60; - only return orders where &#x60;send_date&#x60; is equal to &#x60;date_created&#x60;

func (ApiLettersListRequest) SendDate 

func (r ApiLettersListRequest) SendDate(sendDate map[string]string) ApiLettersListRequest

Filter by date sent.

func (ApiLettersListRequest) SortBy 

func (r ApiLettersListRequest) SortBy(sortBy SortBy3) ApiLettersListRequest

Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.

type ApiPlaceholderRequest 

type ApiPlaceholderRequest struct {
	ApiService *DefaultApiService
	// contains filtered or unexported fields
}

func (ApiPlaceholderRequest) Execute 

func (r ApiPlaceholderRequest) Execute() (*PlaceholderModel, *http.Response, error)

type ApiPostcardCreateRequest 

type ApiPostcardCreateRequest struct {
	ApiService *PostcardsApiService
	// contains filtered or unexported fields
}

func (ApiPostcardCreateRequest) Execute 

func (r ApiPostcardCreateRequest) Execute() (*Postcard, *http.Response, error)

func (ApiPostcardCreateRequest) IdempotencyKey 

func (r ApiPostcardCreateRequest) IdempotencyKey(idempotencyKey string) ApiPostcardCreateRequest

A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request).

func (ApiPostcardCreateRequest) PostcardEditable 

func (r ApiPostcardCreateRequest) PostcardEditable(postcardEditable PostcardEditable) ApiPostcardCreateRequest

type ApiPostcardDeleteRequest 

type ApiPostcardDeleteRequest struct {
	ApiService *PostcardsApiService
	// contains filtered or unexported fields
}

func (ApiPostcardDeleteRequest) Execute 

func (r ApiPostcardDeleteRequest) Execute() (*PostcardDeletion, *http.Response, error)

type ApiPostcardRetrieveRequest 

type ApiPostcardRetrieveRequest struct {
	ApiService *PostcardsApiService
	// contains filtered or unexported fields
}

func (ApiPostcardRetrieveRequest) Execute 

func (r ApiPostcardRetrieveRequest) Execute() (*Postcard, *http.Response, error)

type ApiPostcardsListRequest 

type ApiPostcardsListRequest struct {
	ApiService *PostcardsApiService
	// contains filtered or unexported fields
}

func (ApiPostcardsListRequest) After 

func (r ApiPostcardsListRequest) After(after string) ApiPostcardsListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiPostcardsListRequest) Before 

func (r ApiPostcardsListRequest) Before(before string) ApiPostcardsListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiPostcardsListRequest) DateCreated 

func (r ApiPostcardsListRequest) DateCreated(dateCreated map[string]time.Time) ApiPostcardsListRequest

Filter by date created.

func (ApiPostcardsListRequest) Execute 

func (r ApiPostcardsListRequest) Execute() (*PostcardList, *http.Response, error)

func (ApiPostcardsListRequest) Include 

func (r ApiPostcardsListRequest) Include(include []string) ApiPostcardsListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiPostcardsListRequest) Limit 

func (r ApiPostcardsListRequest) Limit(limit int32) ApiPostcardsListRequest

How many results to return.

func (ApiPostcardsListRequest) MailType 

func (r ApiPostcardsListRequest) MailType(mailType MailType) ApiPostcardsListRequest

A string designating the mail postage type: * &#x60;usps_first_class&#x60; - (default) * &#x60;usps_standard&#x60; - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. &#x60;usps_standard&#x60; cannot be used with &#x60;4x6&#x60; postcards or for any postcards sent outside of the United States.

func (ApiPostcardsListRequest) Metadata 

func (r ApiPostcardsListRequest) Metadata(metadata map[string]string) ApiPostcardsListRequest

Filter by metadata key-value pair&#x60;.

func (ApiPostcardsListRequest) Scheduled 

func (r ApiPostcardsListRequest) Scheduled(scheduled bool) ApiPostcardsListRequest

* &#x60;true&#x60; - only return orders (past or future) where &#x60;send_date&#x60; is greater than &#x60;date_created&#x60; * &#x60;false&#x60; - only return orders where &#x60;send_date&#x60; is equal to &#x60;date_created&#x60;

func (ApiPostcardsListRequest) SendDate 

func (r ApiPostcardsListRequest) SendDate(sendDate map[string]string) ApiPostcardsListRequest

Filter by date sent.

func (ApiPostcardsListRequest) Size 

func (r ApiPostcardsListRequest) Size(size []PostcardSize) ApiPostcardsListRequest

Specifies the size of the postcard. Only &#x60;4x6&#x60; postcards can be sent to international destinations.

func (ApiPostcardsListRequest) SortBy 

func (r ApiPostcardsListRequest) SortBy(sortBy SortBy3) ApiPostcardsListRequest

Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.

type ApiReverseGeocodeLookupRequest 

type ApiReverseGeocodeLookupRequest struct {
	ApiService *ReverseGeocodeLookupsApiService
	// contains filtered or unexported fields
}

func (ApiReverseGeocodeLookupRequest) Execute 

func (r ApiReverseGeocodeLookupRequest) Execute() (*ReverseGeocode, *http.Response, error)

func (ApiReverseGeocodeLookupRequest) Location 

func (r ApiReverseGeocodeLookupRequest) Location(location Location) ApiReverseGeocodeLookupRequest

func (ApiReverseGeocodeLookupRequest) Size 

func (r ApiReverseGeocodeLookupRequest) Size(size int32) ApiReverseGeocodeLookupRequest

Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations.

type ApiSelfMailerCreateRequest 

type ApiSelfMailerCreateRequest struct {
	ApiService *SelfMailersApiService
	// contains filtered or unexported fields
}

func (ApiSelfMailerCreateRequest) Execute 

func (r ApiSelfMailerCreateRequest) Execute() (*SelfMailer, *http.Response, error)

func (ApiSelfMailerCreateRequest) IdempotencyKey 

func (r ApiSelfMailerCreateRequest) IdempotencyKey(idempotencyKey string) ApiSelfMailerCreateRequest

A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request).

func (ApiSelfMailerCreateRequest) SelfMailerEditable 

func (r ApiSelfMailerCreateRequest) SelfMailerEditable(selfMailerEditable SelfMailerEditable) ApiSelfMailerCreateRequest

type ApiSelfMailerDeleteRequest 

type ApiSelfMailerDeleteRequest struct {
	ApiService *SelfMailersApiService
	// contains filtered or unexported fields
}

func (ApiSelfMailerDeleteRequest) Execute 

func (r ApiSelfMailerDeleteRequest) Execute() (*SelfMailerDeletion, *http.Response, error)

type ApiSelfMailerRetrieveRequest 

type ApiSelfMailerRetrieveRequest struct {
	ApiService *SelfMailersApiService
	// contains filtered or unexported fields
}

func (ApiSelfMailerRetrieveRequest) Execute 

func (r ApiSelfMailerRetrieveRequest) Execute() (*SelfMailer, *http.Response, error)

type ApiSelfMailersListRequest 

type ApiSelfMailersListRequest struct {
	ApiService *SelfMailersApiService
	// contains filtered or unexported fields
}

func (ApiSelfMailersListRequest) After 

func (r ApiSelfMailersListRequest) After(after string) ApiSelfMailersListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiSelfMailersListRequest) Before 

func (r ApiSelfMailersListRequest) Before(before string) ApiSelfMailersListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiSelfMailersListRequest) DateCreated 

func (r ApiSelfMailersListRequest) DateCreated(dateCreated map[string]time.Time) ApiSelfMailersListRequest

Filter by date created.

func (ApiSelfMailersListRequest) Execute 

func (r ApiSelfMailersListRequest) Execute() (*SelfMailerList, *http.Response, error)

func (ApiSelfMailersListRequest) Include 

func (r ApiSelfMailersListRequest) Include(include []string) ApiSelfMailersListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiSelfMailersListRequest) Limit 

func (r ApiSelfMailersListRequest) Limit(limit int32) ApiSelfMailersListRequest

How many results to return.

func (ApiSelfMailersListRequest) MailType 

func (r ApiSelfMailersListRequest) MailType(mailType MailType) ApiSelfMailersListRequest

A string designating the mail postage type: * &#x60;usps_first_class&#x60; - (default) * &#x60;usps_standard&#x60; - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. &#x60;usps_standard&#x60; cannot be used with &#x60;4x6&#x60; postcards or for any postcards sent outside of the United States.

func (ApiSelfMailersListRequest) Metadata 

func (r ApiSelfMailersListRequest) Metadata(metadata map[string]string) ApiSelfMailersListRequest

Filter by metadata key-value pair&#x60;.

func (ApiSelfMailersListRequest) Scheduled 

func (r ApiSelfMailersListRequest) Scheduled(scheduled bool) ApiSelfMailersListRequest

* &#x60;true&#x60; - only return orders (past or future) where &#x60;send_date&#x60; is greater than &#x60;date_created&#x60; * &#x60;false&#x60; - only return orders where &#x60;send_date&#x60; is equal to &#x60;date_created&#x60;

func (ApiSelfMailersListRequest) SendDate 

func (r ApiSelfMailersListRequest) SendDate(sendDate map[string]string) ApiSelfMailersListRequest

Filter by date sent.

func (ApiSelfMailersListRequest) Size 

func (r ApiSelfMailersListRequest) Size(size []SelfMailerSize) ApiSelfMailersListRequest

The self mailer sizes to be returned.

func (ApiSelfMailersListRequest) SortBy 

func (r ApiSelfMailersListRequest) SortBy(sortBy SortBy3) ApiSelfMailersListRequest

Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.

type ApiTemplateDeleteRequest 

type ApiTemplateDeleteRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplateDeleteRequest) Execute 

func (r ApiTemplateDeleteRequest) Execute() (*TemplateDeletion, *http.Response, error)

type ApiTemplateRetrieveRequest 

type ApiTemplateRetrieveRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplateRetrieveRequest) Execute 

func (r ApiTemplateRetrieveRequest) Execute() (*Template, *http.Response, error)

type ApiTemplateUpdateRequest 

type ApiTemplateUpdateRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplateUpdateRequest) Execute 

func (r ApiTemplateUpdateRequest) Execute() (*Template, *http.Response, error)

func (ApiTemplateUpdateRequest) TemplateUpdate 

func (r ApiTemplateUpdateRequest) TemplateUpdate(templateUpdate TemplateUpdate) ApiTemplateUpdateRequest

type ApiTemplateVersionDeleteRequest 

type ApiTemplateVersionDeleteRequest struct {
	ApiService *TemplateVersionsApiService
	// contains filtered or unexported fields
}

func (ApiTemplateVersionDeleteRequest) Execute 

func (r ApiTemplateVersionDeleteRequest) Execute() (*TemplateVersionDeletion, *http.Response, error)

type ApiTemplateVersionRetrieveRequest 

type ApiTemplateVersionRetrieveRequest struct {
	ApiService *TemplateVersionsApiService
	// contains filtered or unexported fields
}

func (ApiTemplateVersionRetrieveRequest) Execute 

func (r ApiTemplateVersionRetrieveRequest) Execute() (*TemplateVersion, *http.Response, error)

type ApiTemplateVersionUpdateRequest 

type ApiTemplateVersionUpdateRequest struct {
	ApiService *TemplateVersionsApiService
	// contains filtered or unexported fields
}

func (ApiTemplateVersionUpdateRequest) Execute 

func (r ApiTemplateVersionUpdateRequest) Execute() (*TemplateVersion, *http.Response, error)

func (ApiTemplateVersionUpdateRequest) TemplateVersionUpdatable 

func (r ApiTemplateVersionUpdateRequest) TemplateVersionUpdatable(templateVersionUpdatable TemplateVersionUpdatable) ApiTemplateVersionUpdateRequest

type ApiTemplateVersionsListRequest 

type ApiTemplateVersionsListRequest struct {
	ApiService *TemplateVersionsApiService
	// contains filtered or unexported fields
}

func (ApiTemplateVersionsListRequest) After 

func (r ApiTemplateVersionsListRequest) After(after string) ApiTemplateVersionsListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiTemplateVersionsListRequest) Before 

func (r ApiTemplateVersionsListRequest) Before(before string) ApiTemplateVersionsListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiTemplateVersionsListRequest) DateCreated 

func (r ApiTemplateVersionsListRequest) DateCreated(dateCreated map[string]time.Time) ApiTemplateVersionsListRequest

Filter by date created.

func (ApiTemplateVersionsListRequest) Execute 

func (r ApiTemplateVersionsListRequest) Execute() (*TemplateVersionList, *http.Response, error)

func (ApiTemplateVersionsListRequest) Include 

func (r ApiTemplateVersionsListRequest) Include(include []string) ApiTemplateVersionsListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiTemplateVersionsListRequest) Limit 

func (r ApiTemplateVersionsListRequest) Limit(limit int32) ApiTemplateVersionsListRequest

How many results to return.

type ApiTemplatesListRequest 

type ApiTemplatesListRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplatesListRequest) After 

func (r ApiTemplatesListRequest) After(after string) ApiTemplatesListRequest

A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.

func (ApiTemplatesListRequest) Before 

func (r ApiTemplatesListRequest) Before(before string) ApiTemplatesListRequest

A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.

func (ApiTemplatesListRequest) DateCreated 

func (r ApiTemplatesListRequest) DateCreated(dateCreated map[string]time.Time) ApiTemplatesListRequest

Filter by date created.

func (ApiTemplatesListRequest) Execute 

func (r ApiTemplatesListRequest) Execute() (*TemplateList, *http.Response, error)

func (ApiTemplatesListRequest) Include 

func (r ApiTemplatesListRequest) Include(include []string) ApiTemplatesListRequest

Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.

func (ApiTemplatesListRequest) Limit 

func (r ApiTemplatesListRequest) Limit(limit int32) ApiTemplatesListRequest

How many results to return.

func (ApiTemplatesListRequest) Metadata 

func (r ApiTemplatesListRequest) Metadata(metadata map[string]string) ApiTemplatesListRequest

Filter by metadata key-value pair&#x60;.

type ApiUsAutocompletionRequest 

type ApiUsAutocompletionRequest struct {
	ApiService *UsAutocompletionsApiService
	// contains filtered or unexported fields
}

func (ApiUsAutocompletionRequest) Execute 

func (r ApiUsAutocompletionRequest) Execute() (*UsAutocompletions, *http.Response, error)

func (ApiUsAutocompletionRequest) UsAutocompletionsWritable 

func (r ApiUsAutocompletionRequest) UsAutocompletionsWritable(usAutocompletionsWritable UsAutocompletionsWritable) ApiUsAutocompletionRequest

type ApiUsVerificationRequest 

type ApiUsVerificationRequest struct {
	ApiService *UsVerificationsApiService
	// contains filtered or unexported fields
}

func (ApiUsVerificationRequest) Case_ 

func (r ApiUsVerificationRequest) Case_(case_ string) ApiUsVerificationRequest

Casing of the verified address. Possible values are &#x60;upper&#x60; and &#x60;proper&#x60; for uppercased (e.g. \&quot;PO BOX\&quot;) and proper-cased (e.g. \&quot;PO Box\&quot;), respectively.

func (ApiUsVerificationRequest) Execute 

func (r ApiUsVerificationRequest) Execute() (*UsVerification, *http.Response, error)

func (ApiUsVerificationRequest) UsVerificationsWritable 

func (r ApiUsVerificationRequest) UsVerificationsWritable(usVerificationsWritable UsVerificationsWritable) ApiUsVerificationRequest

type ApiZipLookupRequest 

type ApiZipLookupRequest struct {
	ApiService *ZipLookupsApiService
	// contains filtered or unexported fields
}

func (ApiZipLookupRequest) Execute 

func (r ApiZipLookupRequest) Execute() (*Zip, *http.Response, error)

func (ApiZipLookupRequest) ZipEditable 

func (r ApiZipLookupRequest) ZipEditable(zipEditable ZipEditable) ApiZipLookupRequest

type BankAccount 

type BankAccount struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Must be a [valid US routing number](https://www.frbservices.org/index.html).
	RoutingNumber string `json:"routing_number"`
	AccountNumber string `json:"account_number"`
	// The type of entity that holds the account.
	AccountType string `json:"account_type"`
	// The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login).
	Signatory string `json:"signatory"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// Unique identifier prefixed with `bank_`.
	Id string `json:"id"`
	// A signed link to the signature image. will be generated.
	SignatureUrl NullableString `json:"signature_url,omitempty"`
	// The name of the bank based on the provided routing number, e.g. `JPMORGAN CHASE BANK`.
	BankName *string `json:"bank_name,omitempty"`
	// A bank account must be verified before a check can be created.
	Verified *bool `json:"verified,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool  `json:"deleted,omitempty"`
	Object  string `json:"object"`
}

BankAccount struct for BankAccount

func NewBankAccount 

func NewBankAccount(routingNumber string, accountNumber string, accountType string, signatory string, id string, dateCreated time.Time, dateModified time.Time, object string) *BankAccount

NewBankAccount instantiates a new BankAccount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBankAccountWithDefaults 

func NewBankAccountWithDefaults() *BankAccount

NewBankAccountWithDefaults instantiates a new BankAccount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BankAccount) GetAccountNumber 

func (o *BankAccount) GetAccountNumber() string

GetAccountNumber returns the AccountNumber field value

func (*BankAccount) GetAccountNumberOk 

func (o *BankAccount) GetAccountNumberOk() (*string, bool)

GetAccountNumberOk returns a tuple with the AccountNumber field value and a boolean to check if the value has been set.

func (*BankAccount) GetAccountType 

func (o *BankAccount) GetAccountType() string

GetAccountType returns the AccountType field value

func (*BankAccount) GetAccountTypeOk 

func (o *BankAccount) GetAccountTypeOk() (*string, bool)

GetAccountTypeOk returns a tuple with the AccountType field value and a boolean to check if the value has been set.

func (*BankAccount) GetBankName 

func (o *BankAccount) GetBankName() string

GetBankName returns the BankName field value if set, zero value otherwise.

func (*BankAccount) GetBankNameOk 

func (o *BankAccount) GetBankNameOk() (*string, bool)

GetBankNameOk returns a tuple with the BankName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccount) GetDateCreated 

func (o *BankAccount) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*BankAccount) GetDateCreatedOk 

func (o *BankAccount) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*BankAccount) GetDateModified 

func (o *BankAccount) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*BankAccount) GetDateModifiedOk 

func (o *BankAccount) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*BankAccount) GetDeleted 

func (o *BankAccount) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*BankAccount) GetDeletedOk 

func (o *BankAccount) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccount) GetDescription 

func (o *BankAccount) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BankAccount) GetDescriptionOk 

func (o *BankAccount) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BankAccount) GetId 

func (o *BankAccount) GetId() string

GetId returns the Id field value

func (*BankAccount) GetIdOk 

func (o *BankAccount) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*BankAccount) GetMetadata 

func (o *BankAccount) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*BankAccount) GetMetadataOk 

func (o *BankAccount) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccount) GetObject 

func (o *BankAccount) GetObject() string

GetObject returns the Object field value

func (*BankAccount) GetObjectOk 

func (o *BankAccount) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*BankAccount) GetRoutingNumber 

func (o *BankAccount) GetRoutingNumber() string

GetRoutingNumber returns the RoutingNumber field value

func (*BankAccount) GetRoutingNumberOk 

func (o *BankAccount) GetRoutingNumberOk() (*string, bool)

GetRoutingNumberOk returns a tuple with the RoutingNumber field value and a boolean to check if the value has been set.

func (*BankAccount) GetSignatory 

func (o *BankAccount) GetSignatory() string

GetSignatory returns the Signatory field value

func (*BankAccount) GetSignatoryOk 

func (o *BankAccount) GetSignatoryOk() (*string, bool)

GetSignatoryOk returns a tuple with the Signatory field value and a boolean to check if the value has been set.

func (*BankAccount) GetSignatureUrl 

func (o *BankAccount) GetSignatureUrl() string

GetSignatureUrl returns the SignatureUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BankAccount) GetSignatureUrlOk 

func (o *BankAccount) GetSignatureUrlOk() (*string, bool)

GetSignatureUrlOk returns a tuple with the SignatureUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BankAccount) GetVerified 

func (o *BankAccount) GetVerified() bool

GetVerified returns the Verified field value if set, zero value otherwise.

func (*BankAccount) GetVerifiedOk 

func (o *BankAccount) GetVerifiedOk() (*bool, bool)

GetVerifiedOk returns a tuple with the Verified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccount) HasBankName 

func (o *BankAccount) HasBankName() bool

HasBankName returns a boolean if a field has been set.

func (*BankAccount) HasDeleted 

func (o *BankAccount) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*BankAccount) HasDescription 

func (o *BankAccount) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*BankAccount) HasMetadata 

func (o *BankAccount) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*BankAccount) HasSignatureUrl 

func (o *BankAccount) HasSignatureUrl() bool

HasSignatureUrl returns a boolean if a field has been set.

func (*BankAccount) HasVerified 

func (o *BankAccount) HasVerified() bool

HasVerified returns a boolean if a field has been set.

func (BankAccount) MarshalJSON 

func (o BankAccount) MarshalJSON() ([]byte, error)

func (*BankAccount) SetAccountNumber 

func (o *BankAccount) SetAccountNumber(v string)

SetAccountNumber sets field value

func (*BankAccount) SetAccountType 

func (o *BankAccount) SetAccountType(v string)

SetAccountType sets field value

func (*BankAccount) SetBankName 

func (o *BankAccount) SetBankName(v string)

SetBankName gets a reference to the given string and assigns it to the BankName field.

func (*BankAccount) SetDateCreated 

func (o *BankAccount) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*BankAccount) SetDateModified 

func (o *BankAccount) SetDateModified(v time.Time)

SetDateModified sets field value

func (*BankAccount) SetDeleted 

func (o *BankAccount) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*BankAccount) SetDescription 

func (o *BankAccount) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*BankAccount) SetDescriptionNil 

func (o *BankAccount) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*BankAccount) SetId 

func (o *BankAccount) SetId(v string)

SetId sets field value

func (*BankAccount) SetMetadata 

func (o *BankAccount) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*BankAccount) SetObject 

func (o *BankAccount) SetObject(v string)

SetObject sets field value

func (*BankAccount) SetRoutingNumber 

func (o *BankAccount) SetRoutingNumber(v string)

SetRoutingNumber sets field value

func (*BankAccount) SetSignatory 

func (o *BankAccount) SetSignatory(v string)

SetSignatory sets field value

func (*BankAccount) SetSignatureUrl 

func (o *BankAccount) SetSignatureUrl(v string)

SetSignatureUrl gets a reference to the given NullableString and assigns it to the SignatureUrl field.

func (*BankAccount) SetSignatureUrlNil 

func (o *BankAccount) SetSignatureUrlNil()

SetSignatureUrlNil sets the value for SignatureUrl to be an explicit nil

func (*BankAccount) SetVerified 

func (o *BankAccount) SetVerified(v bool)

SetVerified gets a reference to the given bool and assigns it to the Verified field.

func (*BankAccount) UnsetDescription 

func (o *BankAccount) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*BankAccount) UnsetSignatureUrl 

func (o *BankAccount) UnsetSignatureUrl()

UnsetSignatureUrl ensures that no value is present for SignatureUrl, not even an explicit nil

type BankAccountDeletion 

type BankAccountDeletion struct {
	// Unique identifier prefixed with `bank_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

BankAccountDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewBankAccountDeletion 

func NewBankAccountDeletion() *BankAccountDeletion

NewBankAccountDeletion instantiates a new BankAccountDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBankAccountDeletionWithDefaults 

func NewBankAccountDeletionWithDefaults() *BankAccountDeletion

NewBankAccountDeletionWithDefaults instantiates a new BankAccountDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BankAccountDeletion) GetDeleted 

func (o *BankAccountDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*BankAccountDeletion) GetDeletedOk 

func (o *BankAccountDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountDeletion) GetId 

func (o *BankAccountDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BankAccountDeletion) GetIdOk 

func (o *BankAccountDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountDeletion) GetObject 

func (o *BankAccountDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*BankAccountDeletion) GetObjectOk 

func (o *BankAccountDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountDeletion) HasDeleted 

func (o *BankAccountDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*BankAccountDeletion) HasId 

func (o *BankAccountDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*BankAccountDeletion) HasObject 

func (o *BankAccountDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (BankAccountDeletion) MarshalJSON 

func (o BankAccountDeletion) MarshalJSON() ([]byte, error)

func (*BankAccountDeletion) SetDeleted 

func (o *BankAccountDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*BankAccountDeletion) SetId 

func (o *BankAccountDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*BankAccountDeletion) SetObject 

func (o *BankAccountDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type BankAccountList 

type BankAccountList struct {
	// list of addresses
	Data []BankAccount `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

BankAccountList struct for BankAccountList

func NewBankAccountList 

func NewBankAccountList() *BankAccountList

NewBankAccountList instantiates a new BankAccountList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBankAccountListWithDefaults 

func NewBankAccountListWithDefaults() *BankAccountList

NewBankAccountListWithDefaults instantiates a new BankAccountList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BankAccountList) GetCount 

func (o *BankAccountList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*BankAccountList) GetCountOk 

func (o *BankAccountList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountList) GetData 

func (o *BankAccountList) GetData() []BankAccount

GetData returns the Data field value if set, zero value otherwise.

func (*BankAccountList) GetDataOk 

func (o *BankAccountList) GetDataOk() ([]BankAccount, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountList) GetNextPageToken 

func (o *BankAccountList) GetNextPageToken() string

func (*BankAccountList) GetNextUrl 

func (o *BankAccountList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BankAccountList) GetNextUrlOk 

func (o *BankAccountList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BankAccountList) GetObject 

func (o *BankAccountList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*BankAccountList) GetObjectOk 

func (o *BankAccountList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountList) GetPrevPageToken 

func (o *BankAccountList) GetPrevPageToken() string

func (*BankAccountList) GetPreviousUrl 

func (o *BankAccountList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BankAccountList) GetPreviousUrlOk 

func (o *BankAccountList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BankAccountList) GetTotalCount 

func (o *BankAccountList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*BankAccountList) GetTotalCountOk 

func (o *BankAccountList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountList) HasCount 

func (o *BankAccountList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*BankAccountList) HasData 

func (o *BankAccountList) HasData() bool

HasData returns a boolean if a field has been set.

func (*BankAccountList) HasNextUrl 

func (o *BankAccountList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*BankAccountList) HasObject 

func (o *BankAccountList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*BankAccountList) HasPreviousUrl 

func (o *BankAccountList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*BankAccountList) HasTotalCount 

func (o *BankAccountList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (BankAccountList) MarshalJSON 

func (o BankAccountList) MarshalJSON() ([]byte, error)

func (*BankAccountList) SetCount 

func (o *BankAccountList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*BankAccountList) SetData 

func (o *BankAccountList) SetData(v []BankAccount)

SetData gets a reference to the given []BankAccount and assigns it to the Data field.

func (*BankAccountList) SetNextUrl 

func (o *BankAccountList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*BankAccountList) SetNextUrlNil 

func (o *BankAccountList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*BankAccountList) SetObject 

func (o *BankAccountList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*BankAccountList) SetPreviousUrl 

func (o *BankAccountList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*BankAccountList) SetPreviousUrlNil 

func (o *BankAccountList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*BankAccountList) SetTotalCount 

func (o *BankAccountList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*BankAccountList) UnsetNextUrl 

func (o *BankAccountList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*BankAccountList) UnsetPreviousUrl 

func (o *BankAccountList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type BankAccountVerify 

type BankAccountVerify struct {
	// In live mode, an array containing the two micro deposits (in cents) placed in the bank account. In test mode, no micro deposits will be placed, so any two integers between `1` and `100` will work.
	Amounts []int32 `json:"amounts"`
}

BankAccountVerify struct for BankAccountVerify

func NewBankAccountVerify 

func NewBankAccountVerify(amounts []int32) *BankAccountVerify

NewBankAccountVerify instantiates a new BankAccountVerify object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBankAccountVerifyWithDefaults 

func NewBankAccountVerifyWithDefaults() *BankAccountVerify

NewBankAccountVerifyWithDefaults instantiates a new BankAccountVerify object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BankAccountVerify) GetAmounts 

func (o *BankAccountVerify) GetAmounts() []int32

GetAmounts returns the Amounts field value

func (*BankAccountVerify) GetAmountsOk 

func (o *BankAccountVerify) GetAmountsOk() ([]int32, bool)

GetAmountsOk returns a tuple with the Amounts field value and a boolean to check if the value has been set.

func (BankAccountVerify) MarshalJSON 

func (o BankAccountVerify) MarshalJSON() ([]byte, error)

func (*BankAccountVerify) SetAmounts 

func (o *BankAccountVerify) SetAmounts(v []int32)

SetAmounts sets field value

type BankAccountWritable 

type BankAccountWritable struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Must be a [valid US routing number](https://www.frbservices.org/index.html).
	RoutingNumber string       `json:"routing_number"`
	AccountNumber string       `json:"account_number"`
	AccountType   BankTypeEnum `json:"account_type"`
	// The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login).
	Signatory string `json:"signatory"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
}

BankAccountWritable struct for BankAccountWritable

func NewBankAccountWritable 

func NewBankAccountWritable(routingNumber string, accountNumber string, accountType BankTypeEnum, signatory string) *BankAccountWritable

NewBankAccountWritable instantiates a new BankAccountWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBankAccountWritableWithDefaults 

func NewBankAccountWritableWithDefaults() *BankAccountWritable

NewBankAccountWritableWithDefaults instantiates a new BankAccountWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BankAccountWritable) GetAccountNumber 

func (o *BankAccountWritable) GetAccountNumber() string

GetAccountNumber returns the AccountNumber field value

func (*BankAccountWritable) GetAccountNumberOk 

func (o *BankAccountWritable) GetAccountNumberOk() (*string, bool)

GetAccountNumberOk returns a tuple with the AccountNumber field value and a boolean to check if the value has been set.

func (*BankAccountWritable) GetAccountType 

func (o *BankAccountWritable) GetAccountType() BankTypeEnum

GetAccountType returns the AccountType field value

func (*BankAccountWritable) GetAccountTypeOk 

func (o *BankAccountWritable) GetAccountTypeOk() (*BankTypeEnum, bool)

GetAccountTypeOk returns a tuple with the AccountType field value and a boolean to check if the value has been set.

func (*BankAccountWritable) GetDescription 

func (o *BankAccountWritable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BankAccountWritable) GetDescriptionOk 

func (o *BankAccountWritable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BankAccountWritable) GetMetadata 

func (o *BankAccountWritable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*BankAccountWritable) GetMetadataOk 

func (o *BankAccountWritable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BankAccountWritable) GetRoutingNumber 

func (o *BankAccountWritable) GetRoutingNumber() string

GetRoutingNumber returns the RoutingNumber field value

func (*BankAccountWritable) GetRoutingNumberOk 

func (o *BankAccountWritable) GetRoutingNumberOk() (*string, bool)

GetRoutingNumberOk returns a tuple with the RoutingNumber field value and a boolean to check if the value has been set.

func (*BankAccountWritable) GetSignatory 

func (o *BankAccountWritable) GetSignatory() string

GetSignatory returns the Signatory field value

func (*BankAccountWritable) GetSignatoryOk 

func (o *BankAccountWritable) GetSignatoryOk() (*string, bool)

GetSignatoryOk returns a tuple with the Signatory field value and a boolean to check if the value has been set.

func (*BankAccountWritable) HasDescription 

func (o *BankAccountWritable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*BankAccountWritable) HasMetadata 

func (o *BankAccountWritable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (BankAccountWritable) MarshalJSON 

func (o BankAccountWritable) MarshalJSON() ([]byte, error)

func (*BankAccountWritable) SetAccountNumber 

func (o *BankAccountWritable) SetAccountNumber(v string)

SetAccountNumber sets field value

func (*BankAccountWritable) SetAccountType 

func (o *BankAccountWritable) SetAccountType(v BankTypeEnum)

SetAccountType sets field value

func (*BankAccountWritable) SetDescription 

func (o *BankAccountWritable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*BankAccountWritable) SetDescriptionNil 

func (o *BankAccountWritable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*BankAccountWritable) SetMetadata 

func (o *BankAccountWritable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*BankAccountWritable) SetRoutingNumber 

func (o *BankAccountWritable) SetRoutingNumber(v string)

SetRoutingNumber sets field value

func (*BankAccountWritable) SetSignatory 

func (o *BankAccountWritable) SetSignatory(v string)

SetSignatory sets field value

func (*BankAccountWritable) UnsetDescription 

func (o *BankAccountWritable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type BankAccountsApiService 

type BankAccountsApiService service

BankAccountsApiService BankAccountsApi service

func (*BankAccountsApiService) BankAccountCreateExecute 

func (a *BankAccountsApiService) BankAccountCreateExecute(r ApiBankAccountCreateRequest) (*BankAccount, *http.Response, error)

Execute executes the request 

@return BankAccount

func (*BankAccountsApiService) BankAccountDeleteExecute 

func (a *BankAccountsApiService) BankAccountDeleteExecute(r ApiBankAccountDeleteRequest) (*BankAccountDeletion, *http.Response, error)

Execute executes the request 

@return BankAccountDeletion

func (*BankAccountsApiService) BankAccountRetrieveExecute 

func (a *BankAccountsApiService) BankAccountRetrieveExecute(r ApiBankAccountRetrieveRequest) (*BankAccount, *http.Response, error)

Execute executes the request 

@return BankAccount

func (*BankAccountsApiService) BankAccountVerifyExecute 

func (a *BankAccountsApiService) BankAccountVerifyExecute(r ApiBankAccountVerifyRequest) (*BankAccount, *http.Response, error)

Execute executes the request 

@return BankAccount

func (*BankAccountsApiService) BankAccountsListExecute 

func (a *BankAccountsApiService) BankAccountsListExecute(r ApiBankAccountsListRequest) (*BankAccountList, *http.Response, error)

Execute executes the request 

@return BankAccountList

func (*BankAccountsApiService) Create 

func (a *BankAccountsApiService) Create(ctx context.Context) ApiBankAccountCreateRequest

BankAccountCreate create

Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description "VERIFICATION". 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBankAccountCreateRequest

func (*BankAccountsApiService) Delete 

func (a *BankAccountsApiService) Delete(ctx context.Context, bankId string) ApiBankAccountDeleteRequest

BankAccountDelete delete

Permanently deletes a bank account. It cannot be undone. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bankId id of the bank account
@return ApiBankAccountDeleteRequest

func (*BankAccountsApiService) Get 

func (a *BankAccountsApiService) Get(ctx context.Context, bankId string) ApiBankAccountRetrieveRequest

BankAccountRetrieve get

Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bankId id of the bank account
@return ApiBankAccountRetrieveRequest

func (*BankAccountsApiService) List 

func (a *BankAccountsApiService) List(ctx context.Context) ApiBankAccountsListRequest

BankAccountsList list

Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBankAccountsListRequest

func (*BankAccountsApiService) Verify 

func (a *BankAccountsApiService) Verify(ctx context.Context, bankId string) ApiBankAccountVerifyRequest

BankAccountVerify verify

Verify a bank account in order to create a check. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bankId id of the bank account to be verified
@return ApiBankAccountVerifyRequest

type BankTypeEnum 

type BankTypeEnum string

BankTypeEnum The type of entity that holds the account. 

const (
	BANKTYPEENUM_COMPANY    BankTypeEnum = "company"
	BANKTYPEENUM_INDIVIDUAL BankTypeEnum = "individual"
)

List of bank_type_enum

func NewBankTypeEnumFromValue 

func NewBankTypeEnumFromValue(v string) (*BankTypeEnum, error)

NewBankTypeEnumFromValue returns a pointer to a valid BankTypeEnum for the value passed as argument, or an error if the value passed is not allowed by the enum

func (BankTypeEnum) IsValid 

func (v BankTypeEnum) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (BankTypeEnum) Ptr 

func (v BankTypeEnum) Ptr() *BankTypeEnum

Ptr returns reference to bank_type_enum value

func (*BankTypeEnum) UnmarshalJSON 

func (v *BankTypeEnum) UnmarshalJSON(src []byte) error

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BillingGroup 

type BillingGroup struct {
	// Description of the billing group.
	Description *string `json:"description,omitempty"`
	// Name of the billing group.
	Name string `json:"name"`
	// Unique identifier prefixed with `bg_`.
	Id string `json:"id"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Value is resource type.
	Object string `json:"object"`
}

BillingGroup struct for BillingGroup

func NewBillingGroup 

func NewBillingGroup(name string, id string, dateCreated time.Time, dateModified time.Time, object string) *BillingGroup

NewBillingGroup instantiates a new BillingGroup object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBillingGroupWithDefaults 

func NewBillingGroupWithDefaults() *BillingGroup

NewBillingGroupWithDefaults instantiates a new BillingGroup object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BillingGroup) GetDateCreated 

func (o *BillingGroup) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*BillingGroup) GetDateCreatedOk 

func (o *BillingGroup) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*BillingGroup) GetDateModified 

func (o *BillingGroup) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*BillingGroup) GetDateModifiedOk 

func (o *BillingGroup) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*BillingGroup) GetDescription 

func (o *BillingGroup) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*BillingGroup) GetDescriptionOk 

func (o *BillingGroup) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BillingGroup) GetId 

func (o *BillingGroup) GetId() string

GetId returns the Id field value

func (*BillingGroup) GetIdOk 

func (o *BillingGroup) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*BillingGroup) GetName 

func (o *BillingGroup) GetName() string

GetName returns the Name field value

func (*BillingGroup) GetNameOk 

func (o *BillingGroup) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*BillingGroup) GetObject 

func (o *BillingGroup) GetObject() string

GetObject returns the Object field value

func (*BillingGroup) GetObjectOk 

func (o *BillingGroup) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*BillingGroup) HasDescription 

func (o *BillingGroup) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (BillingGroup) MarshalJSON 

func (o BillingGroup) MarshalJSON() ([]byte, error)

func (*BillingGroup) SetDateCreated 

func (o *BillingGroup) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*BillingGroup) SetDateModified 

func (o *BillingGroup) SetDateModified(v time.Time)

SetDateModified sets field value

func (*BillingGroup) SetDescription 

func (o *BillingGroup) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*BillingGroup) SetId 

func (o *BillingGroup) SetId(v string)

SetId sets field value

func (*BillingGroup) SetName 

func (o *BillingGroup) SetName(v string)

SetName sets field value

func (*BillingGroup) SetObject 

func (o *BillingGroup) SetObject(v string)

SetObject sets field value

type BillingGroupEditable 

type BillingGroupEditable struct {
	// Description of the billing group.
	Description *string `json:"description,omitempty"`
	// Name of the billing group.
	Name string `json:"name"`
}

BillingGroupEditable struct for BillingGroupEditable

func NewBillingGroupEditable 

func NewBillingGroupEditable(name string) *BillingGroupEditable

NewBillingGroupEditable instantiates a new BillingGroupEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBillingGroupEditableWithDefaults 

func NewBillingGroupEditableWithDefaults() *BillingGroupEditable

NewBillingGroupEditableWithDefaults instantiates a new BillingGroupEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BillingGroupEditable) GetDescription 

func (o *BillingGroupEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*BillingGroupEditable) GetDescriptionOk 

func (o *BillingGroupEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BillingGroupEditable) GetName 

func (o *BillingGroupEditable) GetName() string

GetName returns the Name field value

func (*BillingGroupEditable) GetNameOk 

func (o *BillingGroupEditable) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*BillingGroupEditable) HasDescription 

func (o *BillingGroupEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (BillingGroupEditable) MarshalJSON 

func (o BillingGroupEditable) MarshalJSON() ([]byte, error)

func (*BillingGroupEditable) SetDescription 

func (o *BillingGroupEditable) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*BillingGroupEditable) SetName 

func (o *BillingGroupEditable) SetName(v string)

SetName sets field value

type BillingGroupList 

type BillingGroupList struct {
	// list of billing groups
	Data []BillingGroup `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
}

BillingGroupList struct for BillingGroupList

func NewBillingGroupList 

func NewBillingGroupList() *BillingGroupList

NewBillingGroupList instantiates a new BillingGroupList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBillingGroupListWithDefaults 

func NewBillingGroupListWithDefaults() *BillingGroupList

NewBillingGroupListWithDefaults instantiates a new BillingGroupList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BillingGroupList) GetCount 

func (o *BillingGroupList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*BillingGroupList) GetCountOk 

func (o *BillingGroupList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BillingGroupList) GetData 

func (o *BillingGroupList) GetData() []BillingGroup

GetData returns the Data field value if set, zero value otherwise.

func (*BillingGroupList) GetDataOk 

func (o *BillingGroupList) GetDataOk() ([]BillingGroup, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BillingGroupList) GetNextPageToken 

func (o *BillingGroupList) GetNextPageToken() string

func (*BillingGroupList) GetNextUrl 

func (o *BillingGroupList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BillingGroupList) GetNextUrlOk 

func (o *BillingGroupList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BillingGroupList) GetObject 

func (o *BillingGroupList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*BillingGroupList) GetObjectOk 

func (o *BillingGroupList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BillingGroupList) GetPrevPageToken 

func (o *BillingGroupList) GetPrevPageToken() string

func (*BillingGroupList) GetPreviousUrl 

func (o *BillingGroupList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BillingGroupList) GetPreviousUrlOk 

func (o *BillingGroupList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BillingGroupList) HasCount 

func (o *BillingGroupList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*BillingGroupList) HasData 

func (o *BillingGroupList) HasData() bool

HasData returns a boolean if a field has been set.

func (*BillingGroupList) HasNextUrl 

func (o *BillingGroupList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*BillingGroupList) HasObject 

func (o *BillingGroupList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*BillingGroupList) HasPreviousUrl 

func (o *BillingGroupList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (BillingGroupList) MarshalJSON 

func (o BillingGroupList) MarshalJSON() ([]byte, error)

func (*BillingGroupList) SetCount 

func (o *BillingGroupList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*BillingGroupList) SetData 

func (o *BillingGroupList) SetData(v []BillingGroup)

SetData gets a reference to the given []BillingGroup and assigns it to the Data field.

func (*BillingGroupList) SetNextUrl 

func (o *BillingGroupList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*BillingGroupList) SetNextUrlNil 

func (o *BillingGroupList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*BillingGroupList) SetObject 

func (o *BillingGroupList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*BillingGroupList) SetPreviousUrl 

func (o *BillingGroupList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*BillingGroupList) SetPreviousUrlNil 

func (o *BillingGroupList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*BillingGroupList) UnsetNextUrl 

func (o *BillingGroupList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*BillingGroupList) UnsetPreviousUrl 

func (o *BillingGroupList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type BillingGroupsApiService 

type BillingGroupsApiService service

BillingGroupsApiService BillingGroupsApi service

func (*BillingGroupsApiService) BillingGroupCreateExecute 

func (a *BillingGroupsApiService) BillingGroupCreateExecute(r ApiBillingGroupCreateRequest) (*BillingGroup, *http.Response, error)

Execute executes the request 

@return BillingGroup

func (*BillingGroupsApiService) BillingGroupRetrieveExecute 

func (a *BillingGroupsApiService) BillingGroupRetrieveExecute(r ApiBillingGroupRetrieveRequest) (*BillingGroup, *http.Response, error)

Execute executes the request 

@return BillingGroup

func (*BillingGroupsApiService) BillingGroupUpdateExecute 

func (a *BillingGroupsApiService) BillingGroupUpdateExecute(r ApiBillingGroupUpdateRequest) (*BillingGroup, *http.Response, error)

Execute executes the request 

@return BillingGroup

func (*BillingGroupsApiService) BillingGroupsListExecute 

func (a *BillingGroupsApiService) BillingGroupsListExecute(r ApiBillingGroupsListRequest) (*BillingGroupList, *http.Response, error)

Execute executes the request 

@return BillingGroupList

func (*BillingGroupsApiService) Create 

func (a *BillingGroupsApiService) Create(ctx context.Context) ApiBillingGroupCreateRequest

BillingGroupCreate create

Creates a new billing_group with the provided properties. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBillingGroupCreateRequest

func (*BillingGroupsApiService) Get 

func (a *BillingGroupsApiService) Get(ctx context.Context, bgId string) ApiBillingGroupRetrieveRequest

BillingGroupRetrieve get

Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bgId id of the billing_group
@return ApiBillingGroupRetrieveRequest

func (*BillingGroupsApiService) List 

func (a *BillingGroupsApiService) List(ctx context.Context) ApiBillingGroupsListRequest

BillingGroupsList list

Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBillingGroupsListRequest

func (*BillingGroupsApiService) Update 

func (a *BillingGroupsApiService) Update(ctx context.Context, bgId string) ApiBillingGroupUpdateRequest

BillingGroupUpdate update

Updates all editable attributes of the billing_group with the given id. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bgId id of the billing_group
@return ApiBillingGroupUpdateRequest

type Buckslip 

type Buckslip struct {
	// Unique identifier prefixed with `bck_`.
	Id string `json:"id"`
	// True if the buckslips should be auto-reordered.
	AutoReorder bool `json:"auto_reorder"`
	// The number of buckslips to be reordered.
	ReorderQuantity NullableInt32 `json:"reorder_quantity"`
	// The threshold amount of the buckslip
	ThresholdAmount int32 `json:"threshold_amount"`
	// The signed link for the buckslip.
	Url string `json:"url"`
	// The raw URL of the buckslip.
	RawUrl string `json:"raw_url"`
	// The original URL of the front template.
	FrontOriginalUrl string `json:"front_original_url"`
	// The original URL of the back template.
	BackOriginalUrl string      `json:"back_original_url"`
	Thumbnails      []Thumbnail `json:"thumbnails"`
	// The available quantity of buckslips.
	AvailableQuantity float32 `json:"available_quantity"`
	// The allocated quantity of buckslips.
	AllocatedQuantity float32 `json:"allocated_quantity"`
	// The onhand quantity of buckslips.
	OnhandQuantity float32 `json:"onhand_quantity"`
	// The pending quantity of buckslips.
	PendingQuantity float32 `json:"pending_quantity"`
	// The sum of pending and onhand quantities of buckslips.
	ProjectedQuantity float32 `json:"projected_quantity"`
	// An array of buckslip orders that are associated with the buckslip.
	BuckslipOrders []BuckslipOrder `json:"buckslip_orders"`
	Stock          string          `json:"stock"`
	Weight         string          `json:"weight"`
	Finish         string          `json:"finish"`
	Status         string          `json:"status"`
	// object
	Object string `json:"object"`
	// Description of the buckslip.
	Description NullableString `json:"description"`
	// The size of the buckslip
	Size *string `json:"size,omitempty"`
}

Buckslip struct for Buckslip

func NewBuckslip 

func NewBuckslip(id string, autoReorder bool, reorderQuantity NullableInt32, thresholdAmount int32, url string, rawUrl string, frontOriginalUrl string, backOriginalUrl string, thumbnails []Thumbnail, availableQuantity float32, allocatedQuantity float32, onhandQuantity float32, pendingQuantity float32, projectedQuantity float32, buckslipOrders []BuckslipOrder, stock string, weight string, finish string, status string, object string, description NullableString) *Buckslip

NewBuckslip instantiates a new Buckslip object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipWithDefaults 

func NewBuckslipWithDefaults() *Buckslip

NewBuckslipWithDefaults instantiates a new Buckslip object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Buckslip) GetAllocatedQuantity 

func (o *Buckslip) GetAllocatedQuantity() float32

GetAllocatedQuantity returns the AllocatedQuantity field value

func (*Buckslip) GetAllocatedQuantityOk 

func (o *Buckslip) GetAllocatedQuantityOk() (*float32, bool)

GetAllocatedQuantityOk returns a tuple with the AllocatedQuantity field value and a boolean to check if the value has been set.

func (*Buckslip) GetAutoReorder 

func (o *Buckslip) GetAutoReorder() bool

GetAutoReorder returns the AutoReorder field value

func (*Buckslip) GetAutoReorderOk 

func (o *Buckslip) GetAutoReorderOk() (*bool, bool)

GetAutoReorderOk returns a tuple with the AutoReorder field value and a boolean to check if the value has been set.

func (*Buckslip) GetAvailableQuantity 

func (o *Buckslip) GetAvailableQuantity() float32

GetAvailableQuantity returns the AvailableQuantity field value

func (*Buckslip) GetAvailableQuantityOk 

func (o *Buckslip) GetAvailableQuantityOk() (*float32, bool)

GetAvailableQuantityOk returns a tuple with the AvailableQuantity field value and a boolean to check if the value has been set.

func (*Buckslip) GetBackOriginalUrl 

func (o *Buckslip) GetBackOriginalUrl() string

GetBackOriginalUrl returns the BackOriginalUrl field value

func (*Buckslip) GetBackOriginalUrlOk 

func (o *Buckslip) GetBackOriginalUrlOk() (*string, bool)

GetBackOriginalUrlOk returns a tuple with the BackOriginalUrl field value and a boolean to check if the value has been set.

func (*Buckslip) GetBuckslipOrders 

func (o *Buckslip) GetBuckslipOrders() []BuckslipOrder

GetBuckslipOrders returns the BuckslipOrders field value

func (*Buckslip) GetBuckslipOrdersOk 

func (o *Buckslip) GetBuckslipOrdersOk() ([]BuckslipOrder, bool)

GetBuckslipOrdersOk returns a tuple with the BuckslipOrders field value and a boolean to check if the value has been set.

func (*Buckslip) GetDescription 

func (o *Buckslip) GetDescription() string

GetDescription returns the Description field value If the value is explicit nil, the zero value for string will be returned

func (*Buckslip) GetDescriptionOk 

func (o *Buckslip) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Buckslip) GetFinish 

func (o *Buckslip) GetFinish() string

GetFinish returns the Finish field value

func (*Buckslip) GetFinishOk 

func (o *Buckslip) GetFinishOk() (*string, bool)

GetFinishOk returns a tuple with the Finish field value and a boolean to check if the value has been set.

func (*Buckslip) GetFrontOriginalUrl 

func (o *Buckslip) GetFrontOriginalUrl() string

GetFrontOriginalUrl returns the FrontOriginalUrl field value

func (*Buckslip) GetFrontOriginalUrlOk 

func (o *Buckslip) GetFrontOriginalUrlOk() (*string, bool)

GetFrontOriginalUrlOk returns a tuple with the FrontOriginalUrl field value and a boolean to check if the value has been set.

func (*Buckslip) GetId 

func (o *Buckslip) GetId() string

GetId returns the Id field value

func (*Buckslip) GetIdOk 

func (o *Buckslip) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Buckslip) GetObject 

func (o *Buckslip) GetObject() string

GetObject returns the Object field value

func (*Buckslip) GetObjectOk 

func (o *Buckslip) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*Buckslip) GetOnhandQuantity 

func (o *Buckslip) GetOnhandQuantity() float32

GetOnhandQuantity returns the OnhandQuantity field value

func (*Buckslip) GetOnhandQuantityOk 

func (o *Buckslip) GetOnhandQuantityOk() (*float32, bool)

GetOnhandQuantityOk returns a tuple with the OnhandQuantity field value and a boolean to check if the value has been set.

func (*Buckslip) GetPendingQuantity 

func (o *Buckslip) GetPendingQuantity() float32

GetPendingQuantity returns the PendingQuantity field value

func (*Buckslip) GetPendingQuantityOk 

func (o *Buckslip) GetPendingQuantityOk() (*float32, bool)

GetPendingQuantityOk returns a tuple with the PendingQuantity field value and a boolean to check if the value has been set.

func (*Buckslip) GetProjectedQuantity 

func (o *Buckslip) GetProjectedQuantity() float32

GetProjectedQuantity returns the ProjectedQuantity field value

func (*Buckslip) GetProjectedQuantityOk 

func (o *Buckslip) GetProjectedQuantityOk() (*float32, bool)

GetProjectedQuantityOk returns a tuple with the ProjectedQuantity field value and a boolean to check if the value has been set.

func (*Buckslip) GetRawUrl 

func (o *Buckslip) GetRawUrl() string

GetRawUrl returns the RawUrl field value

func (*Buckslip) GetRawUrlOk 

func (o *Buckslip) GetRawUrlOk() (*string, bool)

GetRawUrlOk returns a tuple with the RawUrl field value and a boolean to check if the value has been set.

func (*Buckslip) GetReorderQuantity 

func (o *Buckslip) GetReorderQuantity() int32

GetReorderQuantity returns the ReorderQuantity field value If the value is explicit nil, the zero value for int32 will be returned

func (*Buckslip) GetReorderQuantityOk 

func (o *Buckslip) GetReorderQuantityOk() (*int32, bool)

GetReorderQuantityOk returns a tuple with the ReorderQuantity field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Buckslip) GetSize 

func (o *Buckslip) GetSize() string

GetSize returns the Size field value if set, zero value otherwise.

func (*Buckslip) GetSizeOk 

func (o *Buckslip) GetSizeOk() (*string, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Buckslip) GetStatus 

func (o *Buckslip) GetStatus() string

GetStatus returns the Status field value

func (*Buckslip) GetStatusOk 

func (o *Buckslip) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.

func (*Buckslip) GetStock 

func (o *Buckslip) GetStock() string

GetStock returns the Stock field value

func (*Buckslip) GetStockOk 

func (o *Buckslip) GetStockOk() (*string, bool)

GetStockOk returns a tuple with the Stock field value and a boolean to check if the value has been set.

func (*Buckslip) GetThresholdAmount 

func (o *Buckslip) GetThresholdAmount() int32

GetThresholdAmount returns the ThresholdAmount field value

func (*Buckslip) GetThresholdAmountOk 

func (o *Buckslip) GetThresholdAmountOk() (*int32, bool)

GetThresholdAmountOk returns a tuple with the ThresholdAmount field value and a boolean to check if the value has been set.

func (*Buckslip) GetThumbnails 

func (o *Buckslip) GetThumbnails() []Thumbnail

GetThumbnails returns the Thumbnails field value

func (*Buckslip) GetThumbnailsOk 

func (o *Buckslip) GetThumbnailsOk() ([]Thumbnail, bool)

GetThumbnailsOk returns a tuple with the Thumbnails field value and a boolean to check if the value has been set.

func (*Buckslip) GetUrl 

func (o *Buckslip) GetUrl() string

GetUrl returns the Url field value

func (*Buckslip) GetUrlOk 

func (o *Buckslip) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*Buckslip) GetWeight 

func (o *Buckslip) GetWeight() string

GetWeight returns the Weight field value

func (*Buckslip) GetWeightOk 

func (o *Buckslip) GetWeightOk() (*string, bool)

GetWeightOk returns a tuple with the Weight field value and a boolean to check if the value has been set.

func (*Buckslip) HasSize 

func (o *Buckslip) HasSize() bool

HasSize returns a boolean if a field has been set.

func (Buckslip) MarshalJSON 

func (o Buckslip) MarshalJSON() ([]byte, error)

func (*Buckslip) SetAllocatedQuantity 

func (o *Buckslip) SetAllocatedQuantity(v float32)

SetAllocatedQuantity sets field value

func (*Buckslip) SetAutoReorder 

func (o *Buckslip) SetAutoReorder(v bool)

SetAutoReorder sets field value

func (*Buckslip) SetAvailableQuantity 

func (o *Buckslip) SetAvailableQuantity(v float32)

SetAvailableQuantity sets field value

func (*Buckslip) SetBackOriginalUrl 

func (o *Buckslip) SetBackOriginalUrl(v string)

SetBackOriginalUrl sets field value

func (*Buckslip) SetBuckslipOrders 

func (o *Buckslip) SetBuckslipOrders(v []BuckslipOrder)

SetBuckslipOrders sets field value

func (*Buckslip) SetDescription 

func (o *Buckslip) SetDescription(v string)

SetDescription sets field value

func (*Buckslip) SetFinish 

func (o *Buckslip) SetFinish(v string)

SetFinish sets field value

func (*Buckslip) SetFrontOriginalUrl 

func (o *Buckslip) SetFrontOriginalUrl(v string)

SetFrontOriginalUrl sets field value

func (*Buckslip) SetId 

func (o *Buckslip) SetId(v string)

SetId sets field value

func (*Buckslip) SetObject 

func (o *Buckslip) SetObject(v string)

SetObject sets field value

func (*Buckslip) SetOnhandQuantity 

func (o *Buckslip) SetOnhandQuantity(v float32)

SetOnhandQuantity sets field value

func (*Buckslip) SetPendingQuantity 

func (o *Buckslip) SetPendingQuantity(v float32)

SetPendingQuantity sets field value

func (*Buckslip) SetProjectedQuantity 

func (o *Buckslip) SetProjectedQuantity(v float32)

SetProjectedQuantity sets field value

func (*Buckslip) SetRawUrl 

func (o *Buckslip) SetRawUrl(v string)

SetRawUrl sets field value

func (*Buckslip) SetReorderQuantity 

func (o *Buckslip) SetReorderQuantity(v int32)

SetReorderQuantity sets field value

func (*Buckslip) SetSize 

func (o *Buckslip) SetSize(v string)

SetSize gets a reference to the given string and assigns it to the Size field.

func (*Buckslip) SetStatus 

func (o *Buckslip) SetStatus(v string)

SetStatus sets field value

func (*Buckslip) SetStock 

func (o *Buckslip) SetStock(v string)

SetStock sets field value

func (*Buckslip) SetThresholdAmount 

func (o *Buckslip) SetThresholdAmount(v int32)

SetThresholdAmount sets field value

func (*Buckslip) SetThumbnails 

func (o *Buckslip) SetThumbnails(v []Thumbnail)

SetThumbnails sets field value

func (*Buckslip) SetUrl 

func (o *Buckslip) SetUrl(v string)

SetUrl sets field value

func (*Buckslip) SetWeight 

func (o *Buckslip) SetWeight(v string)

SetWeight sets field value

type BuckslipDeletion 

type BuckslipDeletion struct {
	// Unique identifier prefixed with `bck_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
}

BuckslipDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewBuckslipDeletion 

func NewBuckslipDeletion() *BuckslipDeletion

NewBuckslipDeletion instantiates a new BuckslipDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipDeletionWithDefaults 

func NewBuckslipDeletionWithDefaults() *BuckslipDeletion

NewBuckslipDeletionWithDefaults instantiates a new BuckslipDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuckslipDeletion) GetDeleted 

func (o *BuckslipDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*BuckslipDeletion) GetDeletedOk 

func (o *BuckslipDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipDeletion) GetId 

func (o *BuckslipDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BuckslipDeletion) GetIdOk 

func (o *BuckslipDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipDeletion) HasDeleted 

func (o *BuckslipDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*BuckslipDeletion) HasId 

func (o *BuckslipDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (BuckslipDeletion) MarshalJSON 

func (o BuckslipDeletion) MarshalJSON() ([]byte, error)

func (*BuckslipDeletion) SetDeleted 

func (o *BuckslipDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*BuckslipDeletion) SetId 

func (o *BuckslipDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

type BuckslipEditable 

type BuckslipEditable struct {
	// A PDF template for the front of the buckslip
	Front string `json:"front"`
	// A PDF template for the back of the buckslip
	Back *string `json:"back,omitempty"`
	// Description of the buckslip.
	Description NullableString `json:"description,omitempty"`
	// The size of the buckslip
	Size *string `json:"size,omitempty"`
}

BuckslipEditable struct for BuckslipEditable

func NewBuckslipEditable 

func NewBuckslipEditable(front string) *BuckslipEditable

NewBuckslipEditable instantiates a new BuckslipEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipEditableWithDefaults 

func NewBuckslipEditableWithDefaults() *BuckslipEditable

NewBuckslipEditableWithDefaults instantiates a new BuckslipEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuckslipEditable) GetBack 

func (o *BuckslipEditable) GetBack() string

GetBack returns the Back field value if set, zero value otherwise.

func (*BuckslipEditable) GetBackOk 

func (o *BuckslipEditable) GetBackOk() (*string, bool)

GetBackOk returns a tuple with the Back field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipEditable) GetDescription 

func (o *BuckslipEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BuckslipEditable) GetDescriptionOk 

func (o *BuckslipEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BuckslipEditable) GetFront 

func (o *BuckslipEditable) GetFront() string

GetFront returns the Front field value

func (*BuckslipEditable) GetFrontOk 

func (o *BuckslipEditable) GetFrontOk() (*string, bool)

GetFrontOk returns a tuple with the Front field value and a boolean to check if the value has been set.

func (*BuckslipEditable) GetSize 

func (o *BuckslipEditable) GetSize() string

GetSize returns the Size field value if set, zero value otherwise.

func (*BuckslipEditable) GetSizeOk 

func (o *BuckslipEditable) GetSizeOk() (*string, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipEditable) HasBack 

func (o *BuckslipEditable) HasBack() bool

HasBack returns a boolean if a field has been set.

func (*BuckslipEditable) HasDescription 

func (o *BuckslipEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*BuckslipEditable) HasSize 

func (o *BuckslipEditable) HasSize() bool

HasSize returns a boolean if a field has been set.

func (BuckslipEditable) MarshalJSON 

func (o BuckslipEditable) MarshalJSON() ([]byte, error)

func (*BuckslipEditable) SetBack 

func (o *BuckslipEditable) SetBack(v string)

SetBack gets a reference to the given string and assigns it to the Back field.

func (*BuckslipEditable) SetDescription 

func (o *BuckslipEditable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*BuckslipEditable) SetDescriptionNil 

func (o *BuckslipEditable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*BuckslipEditable) SetFront 

func (o *BuckslipEditable) SetFront(v string)

SetFront sets field value

func (*BuckslipEditable) SetSize 

func (o *BuckslipEditable) SetSize(v string)

SetSize gets a reference to the given string and assigns it to the Size field.

func (*BuckslipEditable) UnsetDescription 

func (o *BuckslipEditable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type BuckslipOrder 

type BuckslipOrder struct {
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object string `json:"object"`
	// Unique identifier prefixed with `bo_`.
	Id *string `json:"id,omitempty"`
	// Unique identifier prefixed with `bck_`.
	BuckslipId *string `json:"buckslip_id,omitempty"`
	// The status of the buckslip order.
	Status *string `json:"status,omitempty"`
	// The quantity of buckslips ordered.
	QuantityOrdered *float32 `json:"quantity_ordered,omitempty"`
	// The unit price for the buckslip order.
	UnitPrice *float32 `json:"unit_price,omitempty"`
	// The inventory of the buckslip order.
	Inventory *float32 `json:"inventory,omitempty"`
	// The reason for cancellation.
	CancelledReason *string `json:"cancelled_reason,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	AvailabilityDate *time.Time `json:"availability_date,omitempty"`
	// The fixed deadline for the buckslips to be printed.
	ExpectedAvailabilityDate *time.Time `json:"expected_availability_date,omitempty"`
}

BuckslipOrder struct for BuckslipOrder

func NewBuckslipOrder 

func NewBuckslipOrder(dateCreated time.Time, dateModified time.Time, object string) *BuckslipOrder

NewBuckslipOrder instantiates a new BuckslipOrder object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipOrderWithDefaults 

func NewBuckslipOrderWithDefaults() *BuckslipOrder

NewBuckslipOrderWithDefaults instantiates a new BuckslipOrder object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuckslipOrder) GetAvailabilityDate 

func (o *BuckslipOrder) GetAvailabilityDate() time.Time

GetAvailabilityDate returns the AvailabilityDate field value if set, zero value otherwise.

func (*BuckslipOrder) GetAvailabilityDateOk 

func (o *BuckslipOrder) GetAvailabilityDateOk() (*time.Time, bool)

GetAvailabilityDateOk returns a tuple with the AvailabilityDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetBuckslipId 

func (o *BuckslipOrder) GetBuckslipId() string

GetBuckslipId returns the BuckslipId field value if set, zero value otherwise.

func (*BuckslipOrder) GetBuckslipIdOk 

func (o *BuckslipOrder) GetBuckslipIdOk() (*string, bool)

GetBuckslipIdOk returns a tuple with the BuckslipId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetCancelledReason 

func (o *BuckslipOrder) GetCancelledReason() string

GetCancelledReason returns the CancelledReason field value if set, zero value otherwise.

func (*BuckslipOrder) GetCancelledReasonOk 

func (o *BuckslipOrder) GetCancelledReasonOk() (*string, bool)

GetCancelledReasonOk returns a tuple with the CancelledReason field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetDateCreated 

func (o *BuckslipOrder) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*BuckslipOrder) GetDateCreatedOk 

func (o *BuckslipOrder) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*BuckslipOrder) GetDateModified 

func (o *BuckslipOrder) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*BuckslipOrder) GetDateModifiedOk 

func (o *BuckslipOrder) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*BuckslipOrder) GetDeleted 

func (o *BuckslipOrder) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*BuckslipOrder) GetDeletedOk 

func (o *BuckslipOrder) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetExpectedAvailabilityDate 

func (o *BuckslipOrder) GetExpectedAvailabilityDate() time.Time

GetExpectedAvailabilityDate returns the ExpectedAvailabilityDate field value if set, zero value otherwise.

func (*BuckslipOrder) GetExpectedAvailabilityDateOk 

func (o *BuckslipOrder) GetExpectedAvailabilityDateOk() (*time.Time, bool)

GetExpectedAvailabilityDateOk returns a tuple with the ExpectedAvailabilityDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetId 

func (o *BuckslipOrder) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BuckslipOrder) GetIdOk 

func (o *BuckslipOrder) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetInventory 

func (o *BuckslipOrder) GetInventory() float32

GetInventory returns the Inventory field value if set, zero value otherwise.

func (*BuckslipOrder) GetInventoryOk 

func (o *BuckslipOrder) GetInventoryOk() (*float32, bool)

GetInventoryOk returns a tuple with the Inventory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetObject 

func (o *BuckslipOrder) GetObject() string

GetObject returns the Object field value

func (*BuckslipOrder) GetObjectOk 

func (o *BuckslipOrder) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*BuckslipOrder) GetQuantityOrdered 

func (o *BuckslipOrder) GetQuantityOrdered() float32

GetQuantityOrdered returns the QuantityOrdered field value if set, zero value otherwise.

func (*BuckslipOrder) GetQuantityOrderedOk 

func (o *BuckslipOrder) GetQuantityOrderedOk() (*float32, bool)

GetQuantityOrderedOk returns a tuple with the QuantityOrdered field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetStatus 

func (o *BuckslipOrder) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*BuckslipOrder) GetStatusOk 

func (o *BuckslipOrder) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) GetUnitPrice 

func (o *BuckslipOrder) GetUnitPrice() float32

GetUnitPrice returns the UnitPrice field value if set, zero value otherwise.

func (*BuckslipOrder) GetUnitPriceOk 

func (o *BuckslipOrder) GetUnitPriceOk() (*float32, bool)

GetUnitPriceOk returns a tuple with the UnitPrice field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrder) HasAvailabilityDate 

func (o *BuckslipOrder) HasAvailabilityDate() bool

HasAvailabilityDate returns a boolean if a field has been set.

func (*BuckslipOrder) HasBuckslipId 

func (o *BuckslipOrder) HasBuckslipId() bool

HasBuckslipId returns a boolean if a field has been set.

func (*BuckslipOrder) HasCancelledReason 

func (o *BuckslipOrder) HasCancelledReason() bool

HasCancelledReason returns a boolean if a field has been set.

func (*BuckslipOrder) HasDeleted 

func (o *BuckslipOrder) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*BuckslipOrder) HasExpectedAvailabilityDate 

func (o *BuckslipOrder) HasExpectedAvailabilityDate() bool

HasExpectedAvailabilityDate returns a boolean if a field has been set.

func (*BuckslipOrder) HasId 

func (o *BuckslipOrder) HasId() bool

HasId returns a boolean if a field has been set.

func (*BuckslipOrder) HasInventory 

func (o *BuckslipOrder) HasInventory() bool

HasInventory returns a boolean if a field has been set.

func (*BuckslipOrder) HasQuantityOrdered 

func (o *BuckslipOrder) HasQuantityOrdered() bool

HasQuantityOrdered returns a boolean if a field has been set.

func (*BuckslipOrder) HasStatus 

func (o *BuckslipOrder) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*BuckslipOrder) HasUnitPrice 

func (o *BuckslipOrder) HasUnitPrice() bool

HasUnitPrice returns a boolean if a field has been set.

func (BuckslipOrder) MarshalJSON 

func (o BuckslipOrder) MarshalJSON() ([]byte, error)

func (*BuckslipOrder) SetAvailabilityDate 

func (o *BuckslipOrder) SetAvailabilityDate(v time.Time)

SetAvailabilityDate gets a reference to the given time.Time and assigns it to the AvailabilityDate field.

func (*BuckslipOrder) SetBuckslipId 

func (o *BuckslipOrder) SetBuckslipId(v string)

SetBuckslipId gets a reference to the given string and assigns it to the BuckslipId field.

func (*BuckslipOrder) SetCancelledReason 

func (o *BuckslipOrder) SetCancelledReason(v string)

SetCancelledReason gets a reference to the given string and assigns it to the CancelledReason field.

func (*BuckslipOrder) SetDateCreated 

func (o *BuckslipOrder) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*BuckslipOrder) SetDateModified 

func (o *BuckslipOrder) SetDateModified(v time.Time)

SetDateModified sets field value

func (*BuckslipOrder) SetDeleted 

func (o *BuckslipOrder) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*BuckslipOrder) SetExpectedAvailabilityDate 

func (o *BuckslipOrder) SetExpectedAvailabilityDate(v time.Time)

SetExpectedAvailabilityDate gets a reference to the given time.Time and assigns it to the ExpectedAvailabilityDate field.

func (*BuckslipOrder) SetId 

func (o *BuckslipOrder) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*BuckslipOrder) SetInventory 

func (o *BuckslipOrder) SetInventory(v float32)

SetInventory gets a reference to the given float32 and assigns it to the Inventory field.

func (*BuckslipOrder) SetObject 

func (o *BuckslipOrder) SetObject(v string)

SetObject sets field value

func (*BuckslipOrder) SetQuantityOrdered 

func (o *BuckslipOrder) SetQuantityOrdered(v float32)

SetQuantityOrdered gets a reference to the given float32 and assigns it to the QuantityOrdered field.

func (*BuckslipOrder) SetStatus 

func (o *BuckslipOrder) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*BuckslipOrder) SetUnitPrice 

func (o *BuckslipOrder) SetUnitPrice(v float32)

SetUnitPrice gets a reference to the given float32 and assigns it to the UnitPrice field.

type BuckslipOrderEditable 

type BuckslipOrderEditable struct {
	// The quantity of buckslips in the order (minimum 5,000).
	Quantity int32 `json:"quantity"`
}

BuckslipOrderEditable struct for BuckslipOrderEditable

func NewBuckslipOrderEditable 

func NewBuckslipOrderEditable(quantity int32) *BuckslipOrderEditable

NewBuckslipOrderEditable instantiates a new BuckslipOrderEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipOrderEditableWithDefaults 

func NewBuckslipOrderEditableWithDefaults() *BuckslipOrderEditable

NewBuckslipOrderEditableWithDefaults instantiates a new BuckslipOrderEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuckslipOrderEditable) GetQuantity 

func (o *BuckslipOrderEditable) GetQuantity() int32

GetQuantity returns the Quantity field value

func (*BuckslipOrderEditable) GetQuantityOk 

func (o *BuckslipOrderEditable) GetQuantityOk() (*int32, bool)

GetQuantityOk returns a tuple with the Quantity field value and a boolean to check if the value has been set.

func (BuckslipOrderEditable) MarshalJSON 

func (o BuckslipOrderEditable) MarshalJSON() ([]byte, error)

func (*BuckslipOrderEditable) SetQuantity 

func (o *BuckslipOrderEditable) SetQuantity(v int32)

SetQuantity sets field value

type BuckslipOrdersApiService 

type BuckslipOrdersApiService service

BuckslipOrdersApiService BuckslipOrdersApi service

func (*BuckslipOrdersApiService) BuckslipOrderCreateExecute 

func (a *BuckslipOrdersApiService) BuckslipOrderCreateExecute(r ApiBuckslipOrderCreateRequest) (*BuckslipOrder, *http.Response, error)

Execute executes the request 

@return BuckslipOrder

func (*BuckslipOrdersApiService) BuckslipOrdersRetrieveExecute 

func (a *BuckslipOrdersApiService) BuckslipOrdersRetrieveExecute(r ApiBuckslipOrdersRetrieveRequest) (*BuckslipOrdersList, *http.Response, error)

Execute executes the request 

@return BuckslipOrdersList

func (*BuckslipOrdersApiService) Create 

func (a *BuckslipOrdersApiService) Create(ctx context.Context, buckslipId string) ApiBuckslipOrderCreateRequest

BuckslipOrderCreate create

Creates a new buckslip order given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param buckslipId The ID of the buckslip to which the buckslip orders belong.
@return ApiBuckslipOrderCreateRequest

func (*BuckslipOrdersApiService) Get 

func (a *BuckslipOrdersApiService) Get(ctx context.Context, buckslipId string) ApiBuckslipOrdersRetrieveRequest

BuckslipOrdersRetrieve get

Retrieves the buckslip orders associated with the given buckslip id. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param buckslipId The ID of the buckslip to which the buckslip orders belong.
@return ApiBuckslipOrdersRetrieveRequest

type BuckslipOrdersList 

type BuckslipOrdersList struct {
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// Url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// Url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

BuckslipOrdersList struct for BuckslipOrdersList

func NewBuckslipOrdersList 

func NewBuckslipOrdersList() *BuckslipOrdersList

NewBuckslipOrdersList instantiates a new BuckslipOrdersList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipOrdersListWithDefaults 

func NewBuckslipOrdersListWithDefaults() *BuckslipOrdersList

NewBuckslipOrdersListWithDefaults instantiates a new BuckslipOrdersList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuckslipOrdersList) GetCount 

func (o *BuckslipOrdersList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*BuckslipOrdersList) GetCountOk 

func (o *BuckslipOrdersList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrdersList) GetNextPageToken 

func (o *BuckslipOrdersList) GetNextPageToken() string

func (*BuckslipOrdersList) GetNextUrl 

func (o *BuckslipOrdersList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BuckslipOrdersList) GetNextUrlOk 

func (o *BuckslipOrdersList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BuckslipOrdersList) GetObject 

func (o *BuckslipOrdersList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*BuckslipOrdersList) GetObjectOk 

func (o *BuckslipOrdersList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrdersList) GetPrevPageToken 

func (o *BuckslipOrdersList) GetPrevPageToken() string

func (*BuckslipOrdersList) GetPreviousUrl 

func (o *BuckslipOrdersList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BuckslipOrdersList) GetPreviousUrlOk 

func (o *BuckslipOrdersList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BuckslipOrdersList) GetTotalCount 

func (o *BuckslipOrdersList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*BuckslipOrdersList) GetTotalCountOk 

func (o *BuckslipOrdersList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipOrdersList) HasCount 

func (o *BuckslipOrdersList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*BuckslipOrdersList) HasNextUrl 

func (o *BuckslipOrdersList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*BuckslipOrdersList) HasObject 

func (o *BuckslipOrdersList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*BuckslipOrdersList) HasPreviousUrl 

func (o *BuckslipOrdersList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*BuckslipOrdersList) HasTotalCount 

func (o *BuckslipOrdersList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (BuckslipOrdersList) MarshalJSON 

func (o BuckslipOrdersList) MarshalJSON() ([]byte, error)

func (*BuckslipOrdersList) SetCount 

func (o *BuckslipOrdersList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*BuckslipOrdersList) SetNextUrl 

func (o *BuckslipOrdersList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*BuckslipOrdersList) SetNextUrlNil 

func (o *BuckslipOrdersList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*BuckslipOrdersList) SetObject 

func (o *BuckslipOrdersList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*BuckslipOrdersList) SetPreviousUrl 

func (o *BuckslipOrdersList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*BuckslipOrdersList) SetPreviousUrlNil 

func (o *BuckslipOrdersList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*BuckslipOrdersList) SetTotalCount 

func (o *BuckslipOrdersList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*BuckslipOrdersList) UnsetNextUrl 

func (o *BuckslipOrdersList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*BuckslipOrdersList) UnsetPreviousUrl 

func (o *BuckslipOrdersList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type BuckslipUpdatable 

type BuckslipUpdatable struct {
	// Description of the buckslip.
	Description NullableString `json:"description,omitempty"`
	// Allows for auto reordering
	AutoReorder *bool `json:"auto_reorder,omitempty"`
	// The quantity of items to be reordered (only required when auto_reorder is true).
	ReorderQuantity *float32 `json:"reorder_quantity,omitempty"`
}

BuckslipUpdatable struct for BuckslipUpdatable

func NewBuckslipUpdatable 

func NewBuckslipUpdatable() *BuckslipUpdatable

NewBuckslipUpdatable instantiates a new BuckslipUpdatable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipUpdatableWithDefaults 

func NewBuckslipUpdatableWithDefaults() *BuckslipUpdatable

NewBuckslipUpdatableWithDefaults instantiates a new BuckslipUpdatable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuckslipUpdatable) GetAutoReorder 

func (o *BuckslipUpdatable) GetAutoReorder() bool

GetAutoReorder returns the AutoReorder field value if set, zero value otherwise.

func (*BuckslipUpdatable) GetAutoReorderOk 

func (o *BuckslipUpdatable) GetAutoReorderOk() (*bool, bool)

GetAutoReorderOk returns a tuple with the AutoReorder field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipUpdatable) GetDescription 

func (o *BuckslipUpdatable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BuckslipUpdatable) GetDescriptionOk 

func (o *BuckslipUpdatable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BuckslipUpdatable) GetReorderQuantity 

func (o *BuckslipUpdatable) GetReorderQuantity() float32

GetReorderQuantity returns the ReorderQuantity field value if set, zero value otherwise.

func (*BuckslipUpdatable) GetReorderQuantityOk 

func (o *BuckslipUpdatable) GetReorderQuantityOk() (*float32, bool)

GetReorderQuantityOk returns a tuple with the ReorderQuantity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipUpdatable) HasAutoReorder 

func (o *BuckslipUpdatable) HasAutoReorder() bool

HasAutoReorder returns a boolean if a field has been set.

func (*BuckslipUpdatable) HasDescription 

func (o *BuckslipUpdatable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*BuckslipUpdatable) HasReorderQuantity 

func (o *BuckslipUpdatable) HasReorderQuantity() bool

HasReorderQuantity returns a boolean if a field has been set.

func (BuckslipUpdatable) MarshalJSON 

func (o BuckslipUpdatable) MarshalJSON() ([]byte, error)

func (*BuckslipUpdatable) SetAutoReorder 

func (o *BuckslipUpdatable) SetAutoReorder(v bool)

SetAutoReorder gets a reference to the given bool and assigns it to the AutoReorder field.

func (*BuckslipUpdatable) SetDescription 

func (o *BuckslipUpdatable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*BuckslipUpdatable) SetDescriptionNil 

func (o *BuckslipUpdatable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*BuckslipUpdatable) SetReorderQuantity 

func (o *BuckslipUpdatable) SetReorderQuantity(v float32)

SetReorderQuantity gets a reference to the given float32 and assigns it to the ReorderQuantity field.

func (*BuckslipUpdatable) UnsetDescription 

func (o *BuckslipUpdatable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type BuckslipsApiService 

type BuckslipsApiService service

BuckslipsApiService BuckslipsApi service

func (*BuckslipsApiService) BuckslipCreateExecute 

func (a *BuckslipsApiService) BuckslipCreateExecute(r ApiBuckslipCreateRequest) (*Buckslip, *http.Response, error)

Execute executes the request 

@return Buckslip

func (*BuckslipsApiService) BuckslipDeleteExecute 

func (a *BuckslipsApiService) BuckslipDeleteExecute(r ApiBuckslipDeleteRequest) (*BuckslipDeletion, *http.Response, error)

Execute executes the request 

@return BuckslipDeletion

func (*BuckslipsApiService) BuckslipRetrieveExecute 

func (a *BuckslipsApiService) BuckslipRetrieveExecute(r ApiBuckslipRetrieveRequest) (*Buckslip, *http.Response, error)

Execute executes the request 

@return Buckslip

func (*BuckslipsApiService) BuckslipUpdateExecute 

func (a *BuckslipsApiService) BuckslipUpdateExecute(r ApiBuckslipUpdateRequest) (*Buckslip, *http.Response, error)

Execute executes the request 

@return Buckslip

func (*BuckslipsApiService) BuckslipsListExecute 

func (a *BuckslipsApiService) BuckslipsListExecute(r ApiBuckslipsListRequest) (*BuckslipsList, *http.Response, error)

Execute executes the request 

@return BuckslipsList

func (*BuckslipsApiService) Create 

func (a *BuckslipsApiService) Create(ctx context.Context) ApiBuckslipCreateRequest

BuckslipCreate create

Creates a new buckslip given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBuckslipCreateRequest

func (*BuckslipsApiService) Delete 

func (a *BuckslipsApiService) Delete(ctx context.Context, buckslipId string) ApiBuckslipDeleteRequest

BuckslipDelete delete

Delete an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param buckslipId id of the buckslip
@return ApiBuckslipDeleteRequest

func (*BuckslipsApiService) Get 

func (a *BuckslipsApiService) Get(ctx context.Context, buckslipId string) ApiBuckslipRetrieveRequest

BuckslipRetrieve get

Retrieves the details of an existing buckslip. You need only supply the unique customer identifier that was returned upon buckslip creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param buckslipId id of the buckslip
@return ApiBuckslipRetrieveRequest

func (*BuckslipsApiService) List 

func (a *BuckslipsApiService) List(ctx context.Context) ApiBuckslipsListRequest

BuckslipsList List

Returns a list of your buckslips. The buckslips are returned sorted by creation date, with the most recently created buckslips appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBuckslipsListRequest

func (*BuckslipsApiService) Update 

func (a *BuckslipsApiService) Update(ctx context.Context, buckslipId string) ApiBuckslipUpdateRequest

BuckslipUpdate update

Update the details of an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param buckslipId id of the buckslip
@return ApiBuckslipUpdateRequest

type BuckslipsList 

type BuckslipsList struct {
	// list of buckslips
	Data []Buckslip `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

BuckslipsList struct for BuckslipsList

func NewBuckslipsList 

func NewBuckslipsList() *BuckslipsList

NewBuckslipsList instantiates a new BuckslipsList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuckslipsListWithDefaults 

func NewBuckslipsListWithDefaults() *BuckslipsList

NewBuckslipsListWithDefaults instantiates a new BuckslipsList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuckslipsList) GetCount 

func (o *BuckslipsList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*BuckslipsList) GetCountOk 

func (o *BuckslipsList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipsList) GetData 

func (o *BuckslipsList) GetData() []Buckslip

GetData returns the Data field value if set, zero value otherwise.

func (*BuckslipsList) GetDataOk 

func (o *BuckslipsList) GetDataOk() ([]Buckslip, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipsList) GetNextPageToken 

func (o *BuckslipsList) GetNextPageToken() string

func (*BuckslipsList) GetNextUrl 

func (o *BuckslipsList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BuckslipsList) GetNextUrlOk 

func (o *BuckslipsList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BuckslipsList) GetObject 

func (o *BuckslipsList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*BuckslipsList) GetObjectOk 

func (o *BuckslipsList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipsList) GetPrevPageToken 

func (o *BuckslipsList) GetPrevPageToken() string

func (*BuckslipsList) GetPreviousUrl 

func (o *BuckslipsList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BuckslipsList) GetPreviousUrlOk 

func (o *BuckslipsList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BuckslipsList) GetTotalCount 

func (o *BuckslipsList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*BuckslipsList) GetTotalCountOk 

func (o *BuckslipsList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BuckslipsList) HasCount 

func (o *BuckslipsList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*BuckslipsList) HasData 

func (o *BuckslipsList) HasData() bool

HasData returns a boolean if a field has been set.

func (*BuckslipsList) HasNextUrl 

func (o *BuckslipsList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*BuckslipsList) HasObject 

func (o *BuckslipsList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*BuckslipsList) HasPreviousUrl 

func (o *BuckslipsList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*BuckslipsList) HasTotalCount 

func (o *BuckslipsList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (BuckslipsList) MarshalJSON 

func (o BuckslipsList) MarshalJSON() ([]byte, error)

func (*BuckslipsList) SetCount 

func (o *BuckslipsList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*BuckslipsList) SetData 

func (o *BuckslipsList) SetData(v []Buckslip)

SetData gets a reference to the given []Buckslip and assigns it to the Data field.

func (*BuckslipsList) SetNextUrl 

func (o *BuckslipsList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*BuckslipsList) SetNextUrlNil 

func (o *BuckslipsList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*BuckslipsList) SetObject 

func (o *BuckslipsList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*BuckslipsList) SetPreviousUrl 

func (o *BuckslipsList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*BuckslipsList) SetPreviousUrlNil 

func (o *BuckslipsList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*BuckslipsList) SetTotalCount 

func (o *BuckslipsList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*BuckslipsList) UnsetNextUrl 

func (o *BuckslipsList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*BuckslipsList) UnsetPreviousUrl 

func (o *BuckslipsList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type BulkError 

type BulkError struct {
	Error *BulkErrorProperties `json:"error,omitempty"`
}

BulkError Lob uses RESTful HTTP response codes to indicate success or failure of an API request.

func NewBulkError 

func NewBulkError() *BulkError

NewBulkError instantiates a new BulkError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBulkErrorWithDefaults 

func NewBulkErrorWithDefaults() *BulkError

NewBulkErrorWithDefaults instantiates a new BulkError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BulkError) GetError 

func (o *BulkError) GetError() BulkErrorProperties

GetError returns the Error field value if set, zero value otherwise.

func (*BulkError) GetErrorOk 

func (o *BulkError) GetErrorOk() (*BulkErrorProperties, bool)

GetErrorOk returns a tuple with the Error field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BulkError) HasError 

func (o *BulkError) HasError() bool

HasError returns a boolean if a field has been set.

func (BulkError) MarshalJSON 

func (o BulkError) MarshalJSON() ([]byte, error)

func (*BulkError) SetError 

func (o *BulkError) SetError(v BulkErrorProperties)

SetError gets a reference to the given BulkErrorProperties and assigns it to the Error field.

type BulkErrorProperties 

type BulkErrorProperties struct {
	// A human-readable message with more details about the error
	Message *string `json:"message,omitempty"`
	// A conventional HTTP status code.
	StatusCode *int32 `json:"status_code,omitempty"`
}

BulkErrorProperties Bulk error properties

func NewBulkErrorProperties 

func NewBulkErrorProperties() *BulkErrorProperties

NewBulkErrorProperties instantiates a new BulkErrorProperties object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBulkErrorPropertiesWithDefaults 

func NewBulkErrorPropertiesWithDefaults() *BulkErrorProperties

NewBulkErrorPropertiesWithDefaults instantiates a new BulkErrorProperties object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BulkErrorProperties) GetMessage 

func (o *BulkErrorProperties) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*BulkErrorProperties) GetMessageOk 

func (o *BulkErrorProperties) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BulkErrorProperties) GetStatusCode 

func (o *BulkErrorProperties) GetStatusCode() int32

GetStatusCode returns the StatusCode field value if set, zero value otherwise.

func (*BulkErrorProperties) GetStatusCodeOk 

func (o *BulkErrorProperties) GetStatusCodeOk() (*int32, bool)

GetStatusCodeOk returns a tuple with the StatusCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BulkErrorProperties) HasMessage 

func (o *BulkErrorProperties) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*BulkErrorProperties) HasStatusCode 

func (o *BulkErrorProperties) HasStatusCode() bool

HasStatusCode returns a boolean if a field has been set.

func (BulkErrorProperties) MarshalJSON 

func (o BulkErrorProperties) MarshalJSON() ([]byte, error)

func (*BulkErrorProperties) SetMessage 

func (o *BulkErrorProperties) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*BulkErrorProperties) SetStatusCode 

func (o *BulkErrorProperties) SetStatusCode(v int32)

SetStatusCode gets a reference to the given int32 and assigns it to the StatusCode field.

type Campaign 

type Campaign struct {
	// Unique identifier prefixed with `bg_`.
	BillingGroupId NullableString `json:"billing_group_id,omitempty"`
	// Name of the campaign.
	Name string `json:"name"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description  NullableString  `json:"description,omitempty"`
	ScheduleType CmpScheduleType `json:"schedule_type"`
	// If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign.
	TargetDeliveryDate NullableTime `json:"target_delivery_date,omitempty"`
	// If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign.
	SendDate NullableTime `json:"send_date,omitempty"`
	// A window, in minutes, within which the campaign can be canceled.
	CancelWindowCampaignMinutes NullableInt32 `json:"cancel_window_campaign_minutes,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	UseType  NullableCmpUseType `json:"use_type"`
	// Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA.
	AutoCancelIfNcoa bool `json:"auto_cancel_if_ncoa"`
	// Unique identifier prefixed with `cmp_`.
	Id string `json:"id"`
	// Account ID that this campaign is associated with.
	AccountId *string `json:"account_id,omitempty"`
	// Whether or not the campaign is still a draft.
	IsDraft bool `json:"is_draft"`
	// An array of creatives that have been associated with this campaign.
	Creatives []CampaignCreative `json:"creatives"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is resource type.
	Object string `json:"object"`
}

Campaign struct for Campaign

func NewCampaign 

func NewCampaign(name string, scheduleType CmpScheduleType, useType NullableCmpUseType, autoCancelIfNcoa bool, id string, isDraft bool, creatives []CampaignCreative, dateCreated time.Time, dateModified time.Time, object string) *Campaign

NewCampaign instantiates a new Campaign object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCampaignWithDefaults 

func NewCampaignWithDefaults() *Campaign

NewCampaignWithDefaults instantiates a new Campaign object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Campaign) GetAccountId 

func (o *Campaign) GetAccountId() string

GetAccountId returns the AccountId field value if set, zero value otherwise.

func (*Campaign) GetAccountIdOk 

func (o *Campaign) GetAccountIdOk() (*string, bool)

GetAccountIdOk returns a tuple with the AccountId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Campaign) GetAutoCancelIfNcoa 

func (o *Campaign) GetAutoCancelIfNcoa() bool

GetAutoCancelIfNcoa returns the AutoCancelIfNcoa field value

func (*Campaign) GetAutoCancelIfNcoaOk 

func (o *Campaign) GetAutoCancelIfNcoaOk() (*bool, bool)

GetAutoCancelIfNcoaOk returns a tuple with the AutoCancelIfNcoa field value and a boolean to check if the value has been set.

func (*Campaign) GetBillingGroupId 

func (o *Campaign) GetBillingGroupId() string

GetBillingGroupId returns the BillingGroupId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Campaign) GetBillingGroupIdOk 

func (o *Campaign) GetBillingGroupIdOk() (*string, bool)

GetBillingGroupIdOk returns a tuple with the BillingGroupId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Campaign) GetCancelWindowCampaignMinutes 

func (o *Campaign) GetCancelWindowCampaignMinutes() int32

GetCancelWindowCampaignMinutes returns the CancelWindowCampaignMinutes field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Campaign) GetCancelWindowCampaignMinutesOk 

func (o *Campaign) GetCancelWindowCampaignMinutesOk() (*int32, bool)

GetCancelWindowCampaignMinutesOk returns a tuple with the CancelWindowCampaignMinutes field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Campaign) GetCreatives 

func (o *Campaign) GetCreatives() []CampaignCreative

GetCreatives returns the Creatives field value

func (*Campaign) GetCreativesOk 

func (o *Campaign) GetCreativesOk() ([]CampaignCreative, bool)

GetCreativesOk returns a tuple with the Creatives field value and a boolean to check if the value has been set.

func (*Campaign) GetDateCreated 

func (o *Campaign) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*Campaign) GetDateCreatedOk 

func (o *Campaign) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*Campaign) GetDateModified 

func (o *Campaign) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*Campaign) GetDateModifiedOk 

func (o *Campaign) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*Campaign) GetDeleted 

func (o *Campaign) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*Campaign) GetDeletedOk 

func (o *Campaign) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Campaign) GetDescription 

func (o *Campaign) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Campaign) GetDescriptionOk 

func (o *Campaign) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Campaign) GetId 

func (o *Campaign) GetId() string

GetId returns the Id field value

func (*Campaign) GetIdOk 

func (o *Campaign) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Campaign) GetIsDraft 

func (o *Campaign) GetIsDraft() bool

GetIsDraft returns the IsDraft field value

func (*Campaign) GetIsDraftOk 

func (o *Campaign) GetIsDraftOk() (*bool, bool)

GetIsDraftOk returns a tuple with the IsDraft field value and a boolean to check if the value has been set.

func (*Campaign) GetMetadata 

func (o *Campaign) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*Campaign) GetMetadataOk 

func (o *Campaign) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Campaign) GetName 

func (o *Campaign) GetName() string

GetName returns the Name field value

func (*Campaign) GetNameOk 

func (o *Campaign) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*Campaign) GetObject 

func (o *Campaign) GetObject() string

GetObject returns the Object field value

func (*Campaign) GetObjectOk 

func (o *Campaign) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*Campaign) GetScheduleType 

func (o *Campaign) GetScheduleType() CmpScheduleType

GetScheduleType returns the ScheduleType field value

func (*Campaign) GetScheduleTypeOk 

func (o *Campaign) GetScheduleTypeOk() (*CmpScheduleType, bool)

GetScheduleTypeOk returns a tuple with the ScheduleType field value and a boolean to check if the value has been set.

func (*Campaign) GetSendDate 

func (o *Campaign) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Campaign) GetSendDateOk 

func (o *Campaign) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Campaign) GetTargetDeliveryDate 

func (o *Campaign) GetTargetDeliveryDate() time.Time

GetTargetDeliveryDate returns the TargetDeliveryDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Campaign) GetTargetDeliveryDateOk 

func (o *Campaign) GetTargetDeliveryDateOk() (*time.Time, bool)

GetTargetDeliveryDateOk returns a tuple with the TargetDeliveryDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Campaign) GetUseType 

func (o *Campaign) GetUseType() CmpUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for CmpUseType will be returned

func (*Campaign) GetUseTypeOk 

func (o *Campaign) GetUseTypeOk() (*CmpUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Campaign) HasAccountId 

func (o *Campaign) HasAccountId() bool

HasAccountId returns a boolean if a field has been set.

func (*Campaign) HasBillingGroupId 

func (o *Campaign) HasBillingGroupId() bool

HasBillingGroupId returns a boolean if a field has been set.

func (*Campaign) HasCancelWindowCampaignMinutes 

func (o *Campaign) HasCancelWindowCampaignMinutes() bool

HasCancelWindowCampaignMinutes returns a boolean if a field has been set.

func (*Campaign) HasDeleted 

func (o *Campaign) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*Campaign) HasDescription 

func (o *Campaign) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Campaign) HasMetadata 

func (o *Campaign) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*Campaign) HasSendDate 

func (o *Campaign) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*Campaign) HasTargetDeliveryDate 

func (o *Campaign) HasTargetDeliveryDate() bool

HasTargetDeliveryDate returns a boolean if a field has been set.

func (Campaign) MarshalJSON 

func (o Campaign) MarshalJSON() ([]byte, error)

func (*Campaign) SetAccountId 

func (o *Campaign) SetAccountId(v string)

SetAccountId gets a reference to the given string and assigns it to the AccountId field.

func (*Campaign) SetAutoCancelIfNcoa 

func (o *Campaign) SetAutoCancelIfNcoa(v bool)

SetAutoCancelIfNcoa sets field value

func (*Campaign) SetBillingGroupId 

func (o *Campaign) SetBillingGroupId(v string)

SetBillingGroupId gets a reference to the given NullableString and assigns it to the BillingGroupId field.

func (*Campaign) SetBillingGroupIdNil 

func (o *Campaign) SetBillingGroupIdNil()

SetBillingGroupIdNil sets the value for BillingGroupId to be an explicit nil

func (*Campaign) SetCancelWindowCampaignMinutes 

func (o *Campaign) SetCancelWindowCampaignMinutes(v int32)

SetCancelWindowCampaignMinutes gets a reference to the given NullableInt32 and assigns it to the CancelWindowCampaignMinutes field.

func (*Campaign) SetCancelWindowCampaignMinutesNil 

func (o *Campaign) SetCancelWindowCampaignMinutesNil()

SetCancelWindowCampaignMinutesNil sets the value for CancelWindowCampaignMinutes to be an explicit nil

func (*Campaign) SetCreatives 

func (o *Campaign) SetCreatives(v []CampaignCreative)

SetCreatives sets field value

func (*Campaign) SetDateCreated 

func (o *Campaign) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*Campaign) SetDateModified 

func (o *Campaign) SetDateModified(v time.Time)

SetDateModified sets field value

func (*Campaign) SetDeleted 

func (o *Campaign) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*Campaign) SetDescription 

func (o *Campaign) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*Campaign) SetDescriptionNil 

func (o *Campaign) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*Campaign) SetId 

func (o *Campaign) SetId(v string)

SetId sets field value

func (*Campaign) SetIsDraft 

func (o *Campaign) SetIsDraft(v bool)

SetIsDraft sets field value

func (*Campaign) SetMetadata 

func (o *Campaign) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*Campaign) SetName 

func (o *Campaign) SetName(v string)

SetName sets field value

func (*Campaign) SetObject 

func (o *Campaign) SetObject(v string)

SetObject sets field value

func (*Campaign) SetScheduleType 

func (o *Campaign) SetScheduleType(v CmpScheduleType)

SetScheduleType sets field value

func (*Campaign) SetSendDate 

func (o *Campaign) SetSendDate(v time.Time)

SetSendDate gets a reference to the given NullableTime and assigns it to the SendDate field.

func (*Campaign) SetSendDateNil 

func (o *Campaign) SetSendDateNil()

SetSendDateNil sets the value for SendDate to be an explicit nil

func (*Campaign) SetTargetDeliveryDate 

func (o *Campaign) SetTargetDeliveryDate(v time.Time)

SetTargetDeliveryDate gets a reference to the given NullableTime and assigns it to the TargetDeliveryDate field.

func (*Campaign) SetTargetDeliveryDateNil 

func (o *Campaign) SetTargetDeliveryDateNil()

SetTargetDeliveryDateNil sets the value for TargetDeliveryDate to be an explicit nil

func (*Campaign) SetUseType 

func (o *Campaign) SetUseType(v CmpUseType)

SetUseType sets field value

func (*Campaign) UnsetBillingGroupId 

func (o *Campaign) UnsetBillingGroupId()

UnsetBillingGroupId ensures that no value is present for BillingGroupId, not even an explicit nil

func (*Campaign) UnsetCancelWindowCampaignMinutes 

func (o *Campaign) UnsetCancelWindowCampaignMinutes()

UnsetCancelWindowCampaignMinutes ensures that no value is present for CancelWindowCampaignMinutes, not even an explicit nil

func (*Campaign) UnsetDescription 

func (o *Campaign) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*Campaign) UnsetSendDate 

func (o *Campaign) UnsetSendDate()

UnsetSendDate ensures that no value is present for SendDate, not even an explicit nil

func (*Campaign) UnsetTargetDeliveryDate 

func (o *Campaign) UnsetTargetDeliveryDate()

UnsetTargetDeliveryDate ensures that no value is present for TargetDeliveryDate, not even an explicit nil

type CampaignCreative 

type CampaignCreative struct {
	// Unique identifier prefixed with `crv_`.
	Id *string `json:"id,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Must either be an address ID or an inline object with correct address parameters.
	From interface{} `json:"from,omitempty"`
	// Mailpiece type for the creative
	ResourceType *string `json:"resource_type,omitempty"`
	// Either PostcardDetailsReturned or LetterDetailsReturned
	Details interface{} `json:"details,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// Preview URLs associated with a creative's artwork asset(s) if the creative uses HTML templates as assets.
	TemplatePreviewUrls map[string]interface{} `json:"template_preview_urls,omitempty"`
	// A list of template preview objects if the creative uses HTML template(s) as artwork asset(s).
	TemplatePreviews []map[string]interface{} `json:"template_previews,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted   *bool      `json:"deleted,omitempty"`
	Campaigns []Campaign `json:"campaigns,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified *time.Time `json:"date_modified,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

CampaignCreative struct for CampaignCreative

func NewCampaignCreative 

func NewCampaignCreative() *CampaignCreative

NewCampaignCreative instantiates a new CampaignCreative object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCampaignCreativeWithDefaults 

func NewCampaignCreativeWithDefaults() *CampaignCreative

NewCampaignCreativeWithDefaults instantiates a new CampaignCreative object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CampaignCreative) GetCampaigns 

func (o *CampaignCreative) GetCampaigns() []Campaign

GetCampaigns returns the Campaigns field value if set, zero value otherwise.

func (*CampaignCreative) GetCampaignsOk 

func (o *CampaignCreative) GetCampaignsOk() ([]Campaign, bool)

GetCampaignsOk returns a tuple with the Campaigns field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetDateCreated 

func (o *CampaignCreative) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*CampaignCreative) GetDateCreatedOk 

func (o *CampaignCreative) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetDateModified 

func (o *CampaignCreative) GetDateModified() time.Time

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*CampaignCreative) GetDateModifiedOk 

func (o *CampaignCreative) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetDeleted 

func (o *CampaignCreative) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*CampaignCreative) GetDeletedOk 

func (o *CampaignCreative) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetDescription 

func (o *CampaignCreative) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignCreative) GetDescriptionOk 

func (o *CampaignCreative) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignCreative) GetDetails 

func (o *CampaignCreative) GetDetails() interface{}

GetDetails returns the Details field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignCreative) GetDetailsOk 

func (o *CampaignCreative) GetDetailsOk() (*interface{}, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignCreative) GetFrom 

func (o *CampaignCreative) GetFrom() interface{}

GetFrom returns the From field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignCreative) GetFromOk 

func (o *CampaignCreative) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignCreative) GetId 

func (o *CampaignCreative) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*CampaignCreative) GetIdOk 

func (o *CampaignCreative) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetMetadata 

func (o *CampaignCreative) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*CampaignCreative) GetMetadataOk 

func (o *CampaignCreative) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetObject 

func (o *CampaignCreative) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CampaignCreative) GetObjectOk 

func (o *CampaignCreative) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetResourceType 

func (o *CampaignCreative) GetResourceType() string

GetResourceType returns the ResourceType field value if set, zero value otherwise.

func (*CampaignCreative) GetResourceTypeOk 

func (o *CampaignCreative) GetResourceTypeOk() (*string, bool)

GetResourceTypeOk returns a tuple with the ResourceType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetTemplatePreviewUrls 

func (o *CampaignCreative) GetTemplatePreviewUrls() map[string]interface{}

GetTemplatePreviewUrls returns the TemplatePreviewUrls field value if set, zero value otherwise.

func (*CampaignCreative) GetTemplatePreviewUrlsOk 

func (o *CampaignCreative) GetTemplatePreviewUrlsOk() (map[string]interface{}, bool)

GetTemplatePreviewUrlsOk returns a tuple with the TemplatePreviewUrls field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) GetTemplatePreviews 

func (o *CampaignCreative) GetTemplatePreviews() []map[string]interface{}

GetTemplatePreviews returns the TemplatePreviews field value if set, zero value otherwise.

func (*CampaignCreative) GetTemplatePreviewsOk 

func (o *CampaignCreative) GetTemplatePreviewsOk() ([]map[string]interface{}, bool)

GetTemplatePreviewsOk returns a tuple with the TemplatePreviews field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignCreative) HasCampaigns 

func (o *CampaignCreative) HasCampaigns() bool

HasCampaigns returns a boolean if a field has been set.

func (*CampaignCreative) HasDateCreated 

func (o *CampaignCreative) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*CampaignCreative) HasDateModified 

func (o *CampaignCreative) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (*CampaignCreative) HasDeleted 

func (o *CampaignCreative) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*CampaignCreative) HasDescription 

func (o *CampaignCreative) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CampaignCreative) HasDetails 

func (o *CampaignCreative) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*CampaignCreative) HasFrom 

func (o *CampaignCreative) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*CampaignCreative) HasId 

func (o *CampaignCreative) HasId() bool

HasId returns a boolean if a field has been set.

func (*CampaignCreative) HasMetadata 

func (o *CampaignCreative) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*CampaignCreative) HasObject 

func (o *CampaignCreative) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*CampaignCreative) HasResourceType 

func (o *CampaignCreative) HasResourceType() bool

HasResourceType returns a boolean if a field has been set.

func (*CampaignCreative) HasTemplatePreviewUrls 

func (o *CampaignCreative) HasTemplatePreviewUrls() bool

HasTemplatePreviewUrls returns a boolean if a field has been set.

func (*CampaignCreative) HasTemplatePreviews 

func (o *CampaignCreative) HasTemplatePreviews() bool

HasTemplatePreviews returns a boolean if a field has been set.

func (CampaignCreative) MarshalJSON 

func (o CampaignCreative) MarshalJSON() ([]byte, error)

func (*CampaignCreative) SetCampaigns 

func (o *CampaignCreative) SetCampaigns(v []Campaign)

SetCampaigns gets a reference to the given []Campaign and assigns it to the Campaigns field.

func (*CampaignCreative) SetDateCreated 

func (o *CampaignCreative) SetDateCreated(v time.Time)

SetDateCreated gets a reference to the given time.Time and assigns it to the DateCreated field.

func (*CampaignCreative) SetDateModified 

func (o *CampaignCreative) SetDateModified(v time.Time)

SetDateModified gets a reference to the given time.Time and assigns it to the DateModified field.

func (*CampaignCreative) SetDeleted 

func (o *CampaignCreative) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*CampaignCreative) SetDescription 

func (o *CampaignCreative) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CampaignCreative) SetDescriptionNil 

func (o *CampaignCreative) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CampaignCreative) SetDetails 

func (o *CampaignCreative) SetDetails(v interface{})

SetDetails gets a reference to the given interface{} and assigns it to the Details field.

func (*CampaignCreative) SetFrom 

func (o *CampaignCreative) SetFrom(v interface{})

SetFrom gets a reference to the given interface{} and assigns it to the From field.

func (*CampaignCreative) SetId 

func (o *CampaignCreative) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*CampaignCreative) SetMetadata 

func (o *CampaignCreative) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*CampaignCreative) SetObject 

func (o *CampaignCreative) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*CampaignCreative) SetResourceType 

func (o *CampaignCreative) SetResourceType(v string)

SetResourceType gets a reference to the given string and assigns it to the ResourceType field.

func (*CampaignCreative) SetTemplatePreviewUrls 

func (o *CampaignCreative) SetTemplatePreviewUrls(v map[string]interface{})

SetTemplatePreviewUrls gets a reference to the given map[string]interface{} and assigns it to the TemplatePreviewUrls field.

func (*CampaignCreative) SetTemplatePreviews 

func (o *CampaignCreative) SetTemplatePreviews(v []map[string]interface{})

SetTemplatePreviews gets a reference to the given []map[string]interface{} and assigns it to the TemplatePreviews field.

func (*CampaignCreative) UnsetDescription 

func (o *CampaignCreative) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type CampaignDeletion 

type CampaignDeletion struct {
	// Unique identifier prefixed with `cmp_`.
	Id *string `json:"id,omitempty"`
	// True if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
}

CampaignDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewCampaignDeletion 

func NewCampaignDeletion() *CampaignDeletion

NewCampaignDeletion instantiates a new CampaignDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCampaignDeletionWithDefaults 

func NewCampaignDeletionWithDefaults() *CampaignDeletion

NewCampaignDeletionWithDefaults instantiates a new CampaignDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CampaignDeletion) GetDeleted 

func (o *CampaignDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*CampaignDeletion) GetDeletedOk 

func (o *CampaignDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignDeletion) GetId 

func (o *CampaignDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*CampaignDeletion) GetIdOk 

func (o *CampaignDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignDeletion) HasDeleted 

func (o *CampaignDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*CampaignDeletion) HasId 

func (o *CampaignDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (CampaignDeletion) MarshalJSON 

func (o CampaignDeletion) MarshalJSON() ([]byte, error)

func (*CampaignDeletion) SetDeleted 

func (o *CampaignDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*CampaignDeletion) SetId 

func (o *CampaignDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

type CampaignUpdatable 

type CampaignUpdatable struct {
	Name *string `json:"name,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description  NullableString   `json:"description,omitempty"`
	ScheduleType *CmpScheduleType `json:"schedule_type,omitempty"`
	// If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign.
	TargetDeliveryDate *time.Time `json:"target_delivery_date,omitempty"`
	// If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign.
	SendDate *time.Time `json:"send_date,omitempty"`
	// A window, in minutes, within which the campaign can be canceled.
	CancelWindowCampaignMinutes *int32 `json:"cancel_window_campaign_minutes,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// Whether or not the campaign is still a draft.
	IsDraft *bool              `json:"is_draft,omitempty"`
	UseType NullableCmpUseType `json:"use_type,omitempty"`
	// Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA.
	AutoCancelIfNcoa *bool `json:"auto_cancel_if_ncoa,omitempty"`
}

CampaignUpdatable struct for CampaignUpdatable

func NewCampaignUpdatable 

func NewCampaignUpdatable() *CampaignUpdatable

NewCampaignUpdatable instantiates a new CampaignUpdatable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCampaignUpdatableWithDefaults 

func NewCampaignUpdatableWithDefaults() *CampaignUpdatable

NewCampaignUpdatableWithDefaults instantiates a new CampaignUpdatable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CampaignUpdatable) GetAutoCancelIfNcoa 

func (o *CampaignUpdatable) GetAutoCancelIfNcoa() bool

GetAutoCancelIfNcoa returns the AutoCancelIfNcoa field value if set, zero value otherwise.

func (*CampaignUpdatable) GetAutoCancelIfNcoaOk 

func (o *CampaignUpdatable) GetAutoCancelIfNcoaOk() (*bool, bool)

GetAutoCancelIfNcoaOk returns a tuple with the AutoCancelIfNcoa field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetCancelWindowCampaignMinutes 

func (o *CampaignUpdatable) GetCancelWindowCampaignMinutes() int32

GetCancelWindowCampaignMinutes returns the CancelWindowCampaignMinutes field value if set, zero value otherwise.

func (*CampaignUpdatable) GetCancelWindowCampaignMinutesOk 

func (o *CampaignUpdatable) GetCancelWindowCampaignMinutesOk() (*int32, bool)

GetCancelWindowCampaignMinutesOk returns a tuple with the CancelWindowCampaignMinutes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetDescription 

func (o *CampaignUpdatable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignUpdatable) GetDescriptionOk 

func (o *CampaignUpdatable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignUpdatable) GetIsDraft 

func (o *CampaignUpdatable) GetIsDraft() bool

GetIsDraft returns the IsDraft field value if set, zero value otherwise.

func (*CampaignUpdatable) GetIsDraftOk 

func (o *CampaignUpdatable) GetIsDraftOk() (*bool, bool)

GetIsDraftOk returns a tuple with the IsDraft field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetMetadata 

func (o *CampaignUpdatable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*CampaignUpdatable) GetMetadataOk 

func (o *CampaignUpdatable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetName 

func (o *CampaignUpdatable) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*CampaignUpdatable) GetNameOk 

func (o *CampaignUpdatable) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetScheduleType 

func (o *CampaignUpdatable) GetScheduleType() CmpScheduleType

GetScheduleType returns the ScheduleType field value if set, zero value otherwise.

func (*CampaignUpdatable) GetScheduleTypeOk 

func (o *CampaignUpdatable) GetScheduleTypeOk() (*CmpScheduleType, bool)

GetScheduleTypeOk returns a tuple with the ScheduleType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetSendDate 

func (o *CampaignUpdatable) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*CampaignUpdatable) GetSendDateOk 

func (o *CampaignUpdatable) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetTargetDeliveryDate 

func (o *CampaignUpdatable) GetTargetDeliveryDate() time.Time

GetTargetDeliveryDate returns the TargetDeliveryDate field value if set, zero value otherwise.

func (*CampaignUpdatable) GetTargetDeliveryDateOk 

func (o *CampaignUpdatable) GetTargetDeliveryDateOk() (*time.Time, bool)

GetTargetDeliveryDateOk returns a tuple with the TargetDeliveryDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignUpdatable) GetUseType 

func (o *CampaignUpdatable) GetUseType() CmpUseType

GetUseType returns the UseType field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignUpdatable) GetUseTypeOk 

func (o *CampaignUpdatable) GetUseTypeOk() (*CmpUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignUpdatable) HasAutoCancelIfNcoa 

func (o *CampaignUpdatable) HasAutoCancelIfNcoa() bool

HasAutoCancelIfNcoa returns a boolean if a field has been set.

func (*CampaignUpdatable) HasCancelWindowCampaignMinutes 

func (o *CampaignUpdatable) HasCancelWindowCampaignMinutes() bool

HasCancelWindowCampaignMinutes returns a boolean if a field has been set.

func (*CampaignUpdatable) HasDescription 

func (o *CampaignUpdatable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CampaignUpdatable) HasIsDraft 

func (o *CampaignUpdatable) HasIsDraft() bool

HasIsDraft returns a boolean if a field has been set.

func (*CampaignUpdatable) HasMetadata 

func (o *CampaignUpdatable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*CampaignUpdatable) HasName 

func (o *CampaignUpdatable) HasName() bool

HasName returns a boolean if a field has been set.

func (*CampaignUpdatable) HasScheduleType 

func (o *CampaignUpdatable) HasScheduleType() bool

HasScheduleType returns a boolean if a field has been set.

func (*CampaignUpdatable) HasSendDate 

func (o *CampaignUpdatable) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*CampaignUpdatable) HasTargetDeliveryDate 

func (o *CampaignUpdatable) HasTargetDeliveryDate() bool

HasTargetDeliveryDate returns a boolean if a field has been set.

func (*CampaignUpdatable) HasUseType 

func (o *CampaignUpdatable) HasUseType() bool

HasUseType returns a boolean if a field has been set.

func (CampaignUpdatable) MarshalJSON 

func (o CampaignUpdatable) MarshalJSON() ([]byte, error)

func (*CampaignUpdatable) SetAutoCancelIfNcoa 

func (o *CampaignUpdatable) SetAutoCancelIfNcoa(v bool)

SetAutoCancelIfNcoa gets a reference to the given bool and assigns it to the AutoCancelIfNcoa field.

func (*CampaignUpdatable) SetCancelWindowCampaignMinutes 

func (o *CampaignUpdatable) SetCancelWindowCampaignMinutes(v int32)

SetCancelWindowCampaignMinutes gets a reference to the given int32 and assigns it to the CancelWindowCampaignMinutes field.

func (*CampaignUpdatable) SetDescription 

func (o *CampaignUpdatable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CampaignUpdatable) SetDescriptionNil 

func (o *CampaignUpdatable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CampaignUpdatable) SetIsDraft 

func (o *CampaignUpdatable) SetIsDraft(v bool)

SetIsDraft gets a reference to the given bool and assigns it to the IsDraft field.

func (*CampaignUpdatable) SetMetadata 

func (o *CampaignUpdatable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*CampaignUpdatable) SetName 

func (o *CampaignUpdatable) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*CampaignUpdatable) SetScheduleType 

func (o *CampaignUpdatable) SetScheduleType(v CmpScheduleType)

SetScheduleType gets a reference to the given CmpScheduleType and assigns it to the ScheduleType field.

func (*CampaignUpdatable) SetSendDate 

func (o *CampaignUpdatable) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*CampaignUpdatable) SetTargetDeliveryDate 

func (o *CampaignUpdatable) SetTargetDeliveryDate(v time.Time)

SetTargetDeliveryDate gets a reference to the given time.Time and assigns it to the TargetDeliveryDate field.

func (*CampaignUpdatable) SetUseType 

func (o *CampaignUpdatable) SetUseType(v CmpUseType)

SetUseType gets a reference to the given NullableCmpUseType and assigns it to the UseType field.

func (*CampaignUpdatable) SetUseTypeNil 

func (o *CampaignUpdatable) SetUseTypeNil()

SetUseTypeNil sets the value for UseType to be an explicit nil

func (*CampaignUpdatable) UnsetDescription 

func (o *CampaignUpdatable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*CampaignUpdatable) UnsetUseType 

func (o *CampaignUpdatable) UnsetUseType()

UnsetUseType ensures that no value is present for UseType, not even an explicit nil

type CampaignWritable 

type CampaignWritable struct {
	// Unique identifier prefixed with `bg_`.
	BillingGroupId NullableString `json:"billing_group_id,omitempty"`
	// Name of the campaign.
	Name string `json:"name"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description  NullableString  `json:"description,omitempty"`
	ScheduleType CmpScheduleType `json:"schedule_type"`
	// If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign.
	TargetDeliveryDate NullableTime `json:"target_delivery_date,omitempty"`
	// If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign.
	SendDate NullableTime `json:"send_date,omitempty"`
	// A window, in minutes, within which the campaign can be canceled.
	CancelWindowCampaignMinutes NullableInt32 `json:"cancel_window_campaign_minutes,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	UseType  NullableCmpUseType `json:"use_type"`
	// Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA.
	AutoCancelIfNcoa *bool `json:"auto_cancel_if_ncoa,omitempty"`
}

CampaignWritable struct for CampaignWritable

func NewCampaignWritable 

func NewCampaignWritable(name string, scheduleType CmpScheduleType, useType NullableCmpUseType) *CampaignWritable

NewCampaignWritable instantiates a new CampaignWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCampaignWritableWithDefaults 

func NewCampaignWritableWithDefaults() *CampaignWritable

NewCampaignWritableWithDefaults instantiates a new CampaignWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CampaignWritable) GetAutoCancelIfNcoa 

func (o *CampaignWritable) GetAutoCancelIfNcoa() bool

GetAutoCancelIfNcoa returns the AutoCancelIfNcoa field value if set, zero value otherwise.

func (*CampaignWritable) GetAutoCancelIfNcoaOk 

func (o *CampaignWritable) GetAutoCancelIfNcoaOk() (*bool, bool)

GetAutoCancelIfNcoaOk returns a tuple with the AutoCancelIfNcoa field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignWritable) GetBillingGroupId 

func (o *CampaignWritable) GetBillingGroupId() string

GetBillingGroupId returns the BillingGroupId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignWritable) GetBillingGroupIdOk 

func (o *CampaignWritable) GetBillingGroupIdOk() (*string, bool)

GetBillingGroupIdOk returns a tuple with the BillingGroupId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignWritable) GetCancelWindowCampaignMinutes 

func (o *CampaignWritable) GetCancelWindowCampaignMinutes() int32

GetCancelWindowCampaignMinutes returns the CancelWindowCampaignMinutes field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignWritable) GetCancelWindowCampaignMinutesOk 

func (o *CampaignWritable) GetCancelWindowCampaignMinutesOk() (*int32, bool)

GetCancelWindowCampaignMinutesOk returns a tuple with the CancelWindowCampaignMinutes field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignWritable) GetDescription 

func (o *CampaignWritable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignWritable) GetDescriptionOk 

func (o *CampaignWritable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignWritable) GetMetadata 

func (o *CampaignWritable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*CampaignWritable) GetMetadataOk 

func (o *CampaignWritable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignWritable) GetName 

func (o *CampaignWritable) GetName() string

GetName returns the Name field value

func (*CampaignWritable) GetNameOk 

func (o *CampaignWritable) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*CampaignWritable) GetScheduleType 

func (o *CampaignWritable) GetScheduleType() CmpScheduleType

GetScheduleType returns the ScheduleType field value

func (*CampaignWritable) GetScheduleTypeOk 

func (o *CampaignWritable) GetScheduleTypeOk() (*CmpScheduleType, bool)

GetScheduleTypeOk returns a tuple with the ScheduleType field value and a boolean to check if the value has been set.

func (*CampaignWritable) GetSendDate 

func (o *CampaignWritable) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignWritable) GetSendDateOk 

func (o *CampaignWritable) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignWritable) GetTargetDeliveryDate 

func (o *CampaignWritable) GetTargetDeliveryDate() time.Time

GetTargetDeliveryDate returns the TargetDeliveryDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignWritable) GetTargetDeliveryDateOk 

func (o *CampaignWritable) GetTargetDeliveryDateOk() (*time.Time, bool)

GetTargetDeliveryDateOk returns a tuple with the TargetDeliveryDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignWritable) GetUseType 

func (o *CampaignWritable) GetUseType() CmpUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for CmpUseType will be returned

func (*CampaignWritable) GetUseTypeOk 

func (o *CampaignWritable) GetUseTypeOk() (*CmpUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignWritable) HasAutoCancelIfNcoa 

func (o *CampaignWritable) HasAutoCancelIfNcoa() bool

HasAutoCancelIfNcoa returns a boolean if a field has been set.

func (*CampaignWritable) HasBillingGroupId 

func (o *CampaignWritable) HasBillingGroupId() bool

HasBillingGroupId returns a boolean if a field has been set.

func (*CampaignWritable) HasCancelWindowCampaignMinutes 

func (o *CampaignWritable) HasCancelWindowCampaignMinutes() bool

HasCancelWindowCampaignMinutes returns a boolean if a field has been set.

func (*CampaignWritable) HasDescription 

func (o *CampaignWritable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CampaignWritable) HasMetadata 

func (o *CampaignWritable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*CampaignWritable) HasSendDate 

func (o *CampaignWritable) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*CampaignWritable) HasTargetDeliveryDate 

func (o *CampaignWritable) HasTargetDeliveryDate() bool

HasTargetDeliveryDate returns a boolean if a field has been set.

func (CampaignWritable) MarshalJSON 

func (o CampaignWritable) MarshalJSON() ([]byte, error)

func (*CampaignWritable) SetAutoCancelIfNcoa 

func (o *CampaignWritable) SetAutoCancelIfNcoa(v bool)

SetAutoCancelIfNcoa gets a reference to the given bool and assigns it to the AutoCancelIfNcoa field.

func (*CampaignWritable) SetBillingGroupId 

func (o *CampaignWritable) SetBillingGroupId(v string)

SetBillingGroupId gets a reference to the given NullableString and assigns it to the BillingGroupId field.

func (*CampaignWritable) SetBillingGroupIdNil 

func (o *CampaignWritable) SetBillingGroupIdNil()

SetBillingGroupIdNil sets the value for BillingGroupId to be an explicit nil

func (*CampaignWritable) SetCancelWindowCampaignMinutes 

func (o *CampaignWritable) SetCancelWindowCampaignMinutes(v int32)

SetCancelWindowCampaignMinutes gets a reference to the given NullableInt32 and assigns it to the CancelWindowCampaignMinutes field.

func (*CampaignWritable) SetCancelWindowCampaignMinutesNil 

func (o *CampaignWritable) SetCancelWindowCampaignMinutesNil()

SetCancelWindowCampaignMinutesNil sets the value for CancelWindowCampaignMinutes to be an explicit nil

func (*CampaignWritable) SetDescription 

func (o *CampaignWritable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CampaignWritable) SetDescriptionNil 

func (o *CampaignWritable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CampaignWritable) SetMetadata 

func (o *CampaignWritable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*CampaignWritable) SetName 

func (o *CampaignWritable) SetName(v string)

SetName sets field value

func (*CampaignWritable) SetScheduleType 

func (o *CampaignWritable) SetScheduleType(v CmpScheduleType)

SetScheduleType sets field value

func (*CampaignWritable) SetSendDate 

func (o *CampaignWritable) SetSendDate(v time.Time)

SetSendDate gets a reference to the given NullableTime and assigns it to the SendDate field.

func (*CampaignWritable) SetSendDateNil 

func (o *CampaignWritable) SetSendDateNil()

SetSendDateNil sets the value for SendDate to be an explicit nil

func (*CampaignWritable) SetTargetDeliveryDate 

func (o *CampaignWritable) SetTargetDeliveryDate(v time.Time)

SetTargetDeliveryDate gets a reference to the given NullableTime and assigns it to the TargetDeliveryDate field.

func (*CampaignWritable) SetTargetDeliveryDateNil 

func (o *CampaignWritable) SetTargetDeliveryDateNil()

SetTargetDeliveryDateNil sets the value for TargetDeliveryDate to be an explicit nil

func (*CampaignWritable) SetUseType 

func (o *CampaignWritable) SetUseType(v CmpUseType)

SetUseType sets field value

func (*CampaignWritable) UnsetBillingGroupId 

func (o *CampaignWritable) UnsetBillingGroupId()

UnsetBillingGroupId ensures that no value is present for BillingGroupId, not even an explicit nil

func (*CampaignWritable) UnsetCancelWindowCampaignMinutes 

func (o *CampaignWritable) UnsetCancelWindowCampaignMinutes()

UnsetCancelWindowCampaignMinutes ensures that no value is present for CancelWindowCampaignMinutes, not even an explicit nil

func (*CampaignWritable) UnsetDescription 

func (o *CampaignWritable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*CampaignWritable) UnsetSendDate 

func (o *CampaignWritable) UnsetSendDate()

UnsetSendDate ensures that no value is present for SendDate, not even an explicit nil

func (*CampaignWritable) UnsetTargetDeliveryDate 

func (o *CampaignWritable) UnsetTargetDeliveryDate()

UnsetTargetDeliveryDate ensures that no value is present for TargetDeliveryDate, not even an explicit nil

type CampaignsApiService 

type CampaignsApiService service

CampaignsApiService CampaignsApi service

func (*CampaignsApiService) CampaignCreateExecute 

func (a *CampaignsApiService) CampaignCreateExecute(r ApiCampaignCreateRequest) (*Campaign, *http.Response, error)

Execute executes the request 

@return Campaign

func (*CampaignsApiService) CampaignDeleteExecute 

func (a *CampaignsApiService) CampaignDeleteExecute(r ApiCampaignDeleteRequest) (*CampaignDeletion, *http.Response, error)

Execute executes the request 

@return CampaignDeletion

func (*CampaignsApiService) CampaignRetrieveExecute 

func (a *CampaignsApiService) CampaignRetrieveExecute(r ApiCampaignRetrieveRequest) (*Campaign, *http.Response, error)

Execute executes the request 

@return Campaign

func (*CampaignsApiService) CampaignUpdateExecute 

func (a *CampaignsApiService) CampaignUpdateExecute(r ApiCampaignUpdateRequest) (*Campaign, *http.Response, error)

Execute executes the request 

@return Campaign

func (*CampaignsApiService) CampaignsListExecute 

func (a *CampaignsApiService) CampaignsListExecute(r ApiCampaignsListRequest) (*CampaignsList, *http.Response, error)

Execute executes the request 

@return CampaignsList

func (*CampaignsApiService) Create 

func (a *CampaignsApiService) Create(ctx context.Context) ApiCampaignCreateRequest

CampaignCreate create

Creates a new campaign with the provided properties. See how to launch your first campaign [here](https://help.lob.com/best-practices/launching-your-first-campaign). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCampaignCreateRequest

func (*CampaignsApiService) Delete 

func (a *CampaignsApiService) Delete(ctx context.Context, cmpId string) ApiCampaignDeleteRequest

CampaignDelete delete

Delete an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. Deleting a campaign also deletes any associated mail pieces that have been created but not sent. A campaign's `send_date` matches its associated mail pieces' `send_date`s. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cmpId id of the campaign
@return ApiCampaignDeleteRequest

func (*CampaignsApiService) Get 

func (a *CampaignsApiService) Get(ctx context.Context, cmpId string) ApiCampaignRetrieveRequest

CampaignRetrieve get

Retrieves the details of an existing campaign. You need only supply the unique campaign identifier that was returned upon campaign creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cmpId id of the campaign
@return ApiCampaignRetrieveRequest

func (*CampaignsApiService) List 

func (a *CampaignsApiService) List(ctx context.Context) ApiCampaignsListRequest

CampaignsList list

Returns a list of your campaigns. The campaigns are returned sorted by creation date, with the most recently created campaigns appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCampaignsListRequest

func (*CampaignsApiService) Update 

func (a *CampaignsApiService) Update(ctx context.Context, cmpId string) ApiCampaignUpdateRequest

CampaignUpdate update

Update the details of an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cmpId id of the campaign
@return ApiCampaignUpdateRequest

type CampaignsList 

type CampaignsList struct {
	// list of campaigns
	Data []Campaign `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

CampaignsList struct for CampaignsList

func NewCampaignsList 

func NewCampaignsList() *CampaignsList

NewCampaignsList instantiates a new CampaignsList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCampaignsListWithDefaults 

func NewCampaignsListWithDefaults() *CampaignsList

NewCampaignsListWithDefaults instantiates a new CampaignsList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CampaignsList) GetCount 

func (o *CampaignsList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*CampaignsList) GetCountOk 

func (o *CampaignsList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignsList) GetData 

func (o *CampaignsList) GetData() []Campaign

GetData returns the Data field value if set, zero value otherwise.

func (*CampaignsList) GetDataOk 

func (o *CampaignsList) GetDataOk() ([]Campaign, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignsList) GetNextPageToken 

func (o *CampaignsList) GetNextPageToken() string

func (*CampaignsList) GetNextUrl 

func (o *CampaignsList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignsList) GetNextUrlOk 

func (o *CampaignsList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignsList) GetObject 

func (o *CampaignsList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CampaignsList) GetObjectOk 

func (o *CampaignsList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignsList) GetPrevPageToken 

func (o *CampaignsList) GetPrevPageToken() string

func (*CampaignsList) GetPreviousUrl 

func (o *CampaignsList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CampaignsList) GetPreviousUrlOk 

func (o *CampaignsList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CampaignsList) GetTotalCount 

func (o *CampaignsList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*CampaignsList) GetTotalCountOk 

func (o *CampaignsList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CampaignsList) HasCount 

func (o *CampaignsList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*CampaignsList) HasData 

func (o *CampaignsList) HasData() bool

HasData returns a boolean if a field has been set.

func (*CampaignsList) HasNextUrl 

func (o *CampaignsList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*CampaignsList) HasObject 

func (o *CampaignsList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*CampaignsList) HasPreviousUrl 

func (o *CampaignsList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*CampaignsList) HasTotalCount 

func (o *CampaignsList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (CampaignsList) MarshalJSON 

func (o CampaignsList) MarshalJSON() ([]byte, error)

func (*CampaignsList) SetCount 

func (o *CampaignsList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*CampaignsList) SetData 

func (o *CampaignsList) SetData(v []Campaign)

SetData gets a reference to the given []Campaign and assigns it to the Data field.

func (*CampaignsList) SetNextUrl 

func (o *CampaignsList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*CampaignsList) SetNextUrlNil 

func (o *CampaignsList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*CampaignsList) SetObject 

func (o *CampaignsList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*CampaignsList) SetPreviousUrl 

func (o *CampaignsList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*CampaignsList) SetPreviousUrlNil 

func (o *CampaignsList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*CampaignsList) SetTotalCount 

func (o *CampaignsList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*CampaignsList) UnsetNextUrl 

func (o *CampaignsList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*CampaignsList) UnsetPreviousUrl 

func (o *CampaignsList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type Card 

type Card struct {
	// Unique identifier prefixed with `card_`.
	Id string `json:"id"`
	// The signed link for the card.
	Url string `json:"url"`
	// True if the cards should be auto-reordered.
	AutoReorder bool `json:"auto_reorder"`
	// The number of cards to be reordered. Only present when auto_reorder is True.
	ReorderQuantity NullableInt32 `json:"reorder_quantity,omitempty"`
	// The raw URL of the card.
	RawUrl *string `json:"raw_url,omitempty"`
	// The original URL of the front template.
	FrontOriginalUrl *string `json:"front_original_url,omitempty"`
	// The original URL of the back template.
	BackOriginalUrl *string     `json:"back_original_url,omitempty"`
	Thumbnails      []Thumbnail `json:"thumbnails"`
	// The available quantity of cards.
	AvailableQuantity int32 `json:"available_quantity"`
	// The pending quantity of cards.
	PendingQuantity int32   `json:"pending_quantity"`
	Status          *string `json:"status,omitempty"`
	// The orientation of the card.
	Orientation *string `json:"orientation,omitempty"`
	// The threshold amount of the card
	ThresholdAmount *int32 `json:"threshold_amount,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// object
	Object string `json:"object"`
	// Description of the card.
	Description NullableString `json:"description,omitempty"`
	// The size of the card
	Size string `json:"size"`
}

Card struct for Card

func NewCard 

func NewCard(id string, url string, autoReorder bool, thumbnails []Thumbnail, availableQuantity int32, pendingQuantity int32, dateCreated time.Time, dateModified time.Time, object string, size string) *Card

NewCard instantiates a new Card object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardWithDefaults 

func NewCardWithDefaults() *Card

NewCardWithDefaults instantiates a new Card object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Card) GetAutoReorder 

func (o *Card) GetAutoReorder() bool

GetAutoReorder returns the AutoReorder field value

func (*Card) GetAutoReorderOk 

func (o *Card) GetAutoReorderOk() (*bool, bool)

GetAutoReorderOk returns a tuple with the AutoReorder field value and a boolean to check if the value has been set.

func (*Card) GetAvailableQuantity 

func (o *Card) GetAvailableQuantity() int32

GetAvailableQuantity returns the AvailableQuantity field value

func (*Card) GetAvailableQuantityOk 

func (o *Card) GetAvailableQuantityOk() (*int32, bool)

GetAvailableQuantityOk returns a tuple with the AvailableQuantity field value and a boolean to check if the value has been set.

func (*Card) GetBackOriginalUrl 

func (o *Card) GetBackOriginalUrl() string

GetBackOriginalUrl returns the BackOriginalUrl field value if set, zero value otherwise.

func (*Card) GetBackOriginalUrlOk 

func (o *Card) GetBackOriginalUrlOk() (*string, bool)

GetBackOriginalUrlOk returns a tuple with the BackOriginalUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Card) GetDateCreated 

func (o *Card) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*Card) GetDateCreatedOk 

func (o *Card) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*Card) GetDateModified 

func (o *Card) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*Card) GetDateModifiedOk 

func (o *Card) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*Card) GetDeleted 

func (o *Card) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*Card) GetDeletedOk 

func (o *Card) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Card) GetDescription 

func (o *Card) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Card) GetDescriptionOk 

func (o *Card) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Card) GetFrontOriginalUrl 

func (o *Card) GetFrontOriginalUrl() string

GetFrontOriginalUrl returns the FrontOriginalUrl field value if set, zero value otherwise.

func (*Card) GetFrontOriginalUrlOk 

func (o *Card) GetFrontOriginalUrlOk() (*string, bool)

GetFrontOriginalUrlOk returns a tuple with the FrontOriginalUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Card) GetId 

func (o *Card) GetId() string

GetId returns the Id field value

func (*Card) GetIdOk 

func (o *Card) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Card) GetObject 

func (o *Card) GetObject() string

GetObject returns the Object field value

func (*Card) GetObjectOk 

func (o *Card) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*Card) GetOrientation 

func (o *Card) GetOrientation() string

GetOrientation returns the Orientation field value if set, zero value otherwise.

func (*Card) GetOrientationOk 

func (o *Card) GetOrientationOk() (*string, bool)

GetOrientationOk returns a tuple with the Orientation field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Card) GetPendingQuantity 

func (o *Card) GetPendingQuantity() int32

GetPendingQuantity returns the PendingQuantity field value

func (*Card) GetPendingQuantityOk 

func (o *Card) GetPendingQuantityOk() (*int32, bool)

GetPendingQuantityOk returns a tuple with the PendingQuantity field value and a boolean to check if the value has been set.

func (*Card) GetRawUrl 

func (o *Card) GetRawUrl() string

GetRawUrl returns the RawUrl field value if set, zero value otherwise.

func (*Card) GetRawUrlOk 

func (o *Card) GetRawUrlOk() (*string, bool)

GetRawUrlOk returns a tuple with the RawUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Card) GetReorderQuantity 

func (o *Card) GetReorderQuantity() int32

GetReorderQuantity returns the ReorderQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Card) GetReorderQuantityOk 

func (o *Card) GetReorderQuantityOk() (*int32, bool)

GetReorderQuantityOk returns a tuple with the ReorderQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Card) GetSize 

func (o *Card) GetSize() string

GetSize returns the Size field value

func (*Card) GetSizeOk 

func (o *Card) GetSizeOk() (*string, bool)

GetSizeOk returns a tuple with the Size field value and a boolean to check if the value has been set.

func (*Card) GetStatus 

func (o *Card) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*Card) GetStatusOk 

func (o *Card) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Card) GetThresholdAmount 

func (o *Card) GetThresholdAmount() int32

GetThresholdAmount returns the ThresholdAmount field value if set, zero value otherwise.

func (*Card) GetThresholdAmountOk 

func (o *Card) GetThresholdAmountOk() (*int32, bool)

GetThresholdAmountOk returns a tuple with the ThresholdAmount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Card) GetThumbnails 

func (o *Card) GetThumbnails() []Thumbnail

GetThumbnails returns the Thumbnails field value

func (*Card) GetThumbnailsOk 

func (o *Card) GetThumbnailsOk() ([]Thumbnail, bool)

GetThumbnailsOk returns a tuple with the Thumbnails field value and a boolean to check if the value has been set.

func (*Card) GetUrl 

func (o *Card) GetUrl() string

GetUrl returns the Url field value

func (*Card) GetUrlOk 

func (o *Card) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*Card) HasBackOriginalUrl 

func (o *Card) HasBackOriginalUrl() bool

HasBackOriginalUrl returns a boolean if a field has been set.

func (*Card) HasDeleted 

func (o *Card) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*Card) HasDescription 

func (o *Card) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Card) HasFrontOriginalUrl 

func (o *Card) HasFrontOriginalUrl() bool

HasFrontOriginalUrl returns a boolean if a field has been set.

func (*Card) HasOrientation 

func (o *Card) HasOrientation() bool

HasOrientation returns a boolean if a field has been set.

func (*Card) HasRawUrl 

func (o *Card) HasRawUrl() bool

HasRawUrl returns a boolean if a field has been set.

func (*Card) HasReorderQuantity 

func (o *Card) HasReorderQuantity() bool

HasReorderQuantity returns a boolean if a field has been set.

func (*Card) HasStatus 

func (o *Card) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*Card) HasThresholdAmount 

func (o *Card) HasThresholdAmount() bool

HasThresholdAmount returns a boolean if a field has been set.

func (Card) MarshalJSON 

func (o Card) MarshalJSON() ([]byte, error)

func (*Card) SetAutoReorder 

func (o *Card) SetAutoReorder(v bool)

SetAutoReorder sets field value

func (*Card) SetAvailableQuantity 

func (o *Card) SetAvailableQuantity(v int32)

SetAvailableQuantity sets field value

func (*Card) SetBackOriginalUrl 

func (o *Card) SetBackOriginalUrl(v string)

SetBackOriginalUrl gets a reference to the given string and assigns it to the BackOriginalUrl field.

func (*Card) SetDateCreated 

func (o *Card) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*Card) SetDateModified 

func (o *Card) SetDateModified(v time.Time)

SetDateModified sets field value

func (*Card) SetDeleted 

func (o *Card) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*Card) SetDescription 

func (o *Card) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*Card) SetDescriptionNil 

func (o *Card) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*Card) SetFrontOriginalUrl 

func (o *Card) SetFrontOriginalUrl(v string)

SetFrontOriginalUrl gets a reference to the given string and assigns it to the FrontOriginalUrl field.

func (*Card) SetId 

func (o *Card) SetId(v string)

SetId sets field value

func (*Card) SetObject 

func (o *Card) SetObject(v string)

SetObject sets field value

func (*Card) SetOrientation 

func (o *Card) SetOrientation(v string)

SetOrientation gets a reference to the given string and assigns it to the Orientation field.

func (*Card) SetPendingQuantity 

func (o *Card) SetPendingQuantity(v int32)

SetPendingQuantity sets field value

func (*Card) SetRawUrl 

func (o *Card) SetRawUrl(v string)

SetRawUrl gets a reference to the given string and assigns it to the RawUrl field.

func (*Card) SetReorderQuantity 

func (o *Card) SetReorderQuantity(v int32)

SetReorderQuantity gets a reference to the given NullableInt32 and assigns it to the ReorderQuantity field.

func (*Card) SetReorderQuantityNil 

func (o *Card) SetReorderQuantityNil()

SetReorderQuantityNil sets the value for ReorderQuantity to be an explicit nil

func (*Card) SetSize 

func (o *Card) SetSize(v string)

SetSize sets field value

func (*Card) SetStatus 

func (o *Card) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*Card) SetThresholdAmount 

func (o *Card) SetThresholdAmount(v int32)

SetThresholdAmount gets a reference to the given int32 and assigns it to the ThresholdAmount field.

func (*Card) SetThumbnails 

func (o *Card) SetThumbnails(v []Thumbnail)

SetThumbnails sets field value

func (*Card) SetUrl 

func (o *Card) SetUrl(v string)

SetUrl sets field value

func (*Card) UnsetDescription 

func (o *Card) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*Card) UnsetReorderQuantity 

func (o *Card) UnsetReorderQuantity()

UnsetReorderQuantity ensures that no value is present for ReorderQuantity, not even an explicit nil

type CardDeletion 

type CardDeletion struct {
	// Unique identifier prefixed with `card_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

CardDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewCardDeletion 

func NewCardDeletion() *CardDeletion

NewCardDeletion instantiates a new CardDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardDeletionWithDefaults 

func NewCardDeletionWithDefaults() *CardDeletion

NewCardDeletionWithDefaults instantiates a new CardDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CardDeletion) GetDeleted 

func (o *CardDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*CardDeletion) GetDeletedOk 

func (o *CardDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardDeletion) GetId 

func (o *CardDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*CardDeletion) GetIdOk 

func (o *CardDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardDeletion) GetObject 

func (o *CardDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CardDeletion) GetObjectOk 

func (o *CardDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardDeletion) HasDeleted 

func (o *CardDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*CardDeletion) HasId 

func (o *CardDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*CardDeletion) HasObject 

func (o *CardDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (CardDeletion) MarshalJSON 

func (o CardDeletion) MarshalJSON() ([]byte, error)

func (*CardDeletion) SetDeleted 

func (o *CardDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*CardDeletion) SetId 

func (o *CardDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*CardDeletion) SetObject 

func (o *CardDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type CardEditable 

type CardEditable struct {
	// A PDF template for the front of the card
	Front string `json:"front"`
	// A PDF template for the back of the card
	Back *string `json:"back,omitempty"`
	// The size of the card
	Size *string `json:"size,omitempty"`
	// Description of the card.
	Description NullableString `json:"description,omitempty"`
}

CardEditable struct for CardEditable

func NewCardEditable 

func NewCardEditable(front string) *CardEditable

NewCardEditable instantiates a new CardEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardEditableWithDefaults 

func NewCardEditableWithDefaults() *CardEditable

NewCardEditableWithDefaults instantiates a new CardEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CardEditable) GetBack 

func (o *CardEditable) GetBack() string

GetBack returns the Back field value if set, zero value otherwise.

func (*CardEditable) GetBackOk 

func (o *CardEditable) GetBackOk() (*string, bool)

GetBackOk returns a tuple with the Back field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardEditable) GetDescription 

func (o *CardEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CardEditable) GetDescriptionOk 

func (o *CardEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CardEditable) GetFront 

func (o *CardEditable) GetFront() string

GetFront returns the Front field value

func (*CardEditable) GetFrontOk 

func (o *CardEditable) GetFrontOk() (*string, bool)

GetFrontOk returns a tuple with the Front field value and a boolean to check if the value has been set.

func (*CardEditable) GetSize 

func (o *CardEditable) GetSize() string

GetSize returns the Size field value if set, zero value otherwise.

func (*CardEditable) GetSizeOk 

func (o *CardEditable) GetSizeOk() (*string, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardEditable) HasBack 

func (o *CardEditable) HasBack() bool

HasBack returns a boolean if a field has been set.

func (*CardEditable) HasDescription 

func (o *CardEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CardEditable) HasSize 

func (o *CardEditable) HasSize() bool

HasSize returns a boolean if a field has been set.

func (CardEditable) MarshalJSON 

func (o CardEditable) MarshalJSON() ([]byte, error)

func (*CardEditable) SetBack 

func (o *CardEditable) SetBack(v string)

SetBack gets a reference to the given string and assigns it to the Back field.

func (*CardEditable) SetDescription 

func (o *CardEditable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CardEditable) SetDescriptionNil 

func (o *CardEditable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CardEditable) SetFront 

func (o *CardEditable) SetFront(v string)

SetFront sets field value

func (*CardEditable) SetSize 

func (o *CardEditable) SetSize(v string)

SetSize gets a reference to the given string and assigns it to the Size field.

func (*CardEditable) UnsetDescription 

func (o *CardEditable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type CardList 

type CardList struct {
	// list of cards
	Data []Card `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

CardList struct for CardList

func NewCardList 

func NewCardList() *CardList

NewCardList instantiates a new CardList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardListWithDefaults 

func NewCardListWithDefaults() *CardList

NewCardListWithDefaults instantiates a new CardList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CardList) GetCount 

func (o *CardList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*CardList) GetCountOk 

func (o *CardList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardList) GetData 

func (o *CardList) GetData() []Card

GetData returns the Data field value if set, zero value otherwise.

func (*CardList) GetDataOk 

func (o *CardList) GetDataOk() ([]Card, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardList) GetNextPageToken 

func (o *CardList) GetNextPageToken() string

func (*CardList) GetNextUrl 

func (o *CardList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CardList) GetNextUrlOk 

func (o *CardList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CardList) GetObject 

func (o *CardList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CardList) GetObjectOk 

func (o *CardList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardList) GetPrevPageToken 

func (o *CardList) GetPrevPageToken() string

func (*CardList) GetPreviousUrl 

func (o *CardList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CardList) GetPreviousUrlOk 

func (o *CardList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CardList) GetTotalCount 

func (o *CardList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*CardList) GetTotalCountOk 

func (o *CardList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardList) HasCount 

func (o *CardList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*CardList) HasData 

func (o *CardList) HasData() bool

HasData returns a boolean if a field has been set.

func (*CardList) HasNextUrl 

func (o *CardList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*CardList) HasObject 

func (o *CardList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*CardList) HasPreviousUrl 

func (o *CardList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*CardList) HasTotalCount 

func (o *CardList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (CardList) MarshalJSON 

func (o CardList) MarshalJSON() ([]byte, error)

func (*CardList) SetCount 

func (o *CardList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*CardList) SetData 

func (o *CardList) SetData(v []Card)

SetData gets a reference to the given []Card and assigns it to the Data field.

func (*CardList) SetNextUrl 

func (o *CardList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*CardList) SetNextUrlNil 

func (o *CardList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*CardList) SetObject 

func (o *CardList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*CardList) SetPreviousUrl 

func (o *CardList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*CardList) SetPreviousUrlNil 

func (o *CardList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*CardList) SetTotalCount 

func (o *CardList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*CardList) UnsetNextUrl 

func (o *CardList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*CardList) UnsetPreviousUrl 

func (o *CardList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type CardOrder 

type CardOrder struct {
	// Unique identifier prefixed with `co_`.
	Id *string `json:"id,omitempty"`
	// Unique identifier prefixed with `card_`.
	CardId *string `json:"card_id,omitempty"`
	// The status of the card order.
	Status *string `json:"status,omitempty"`
	// The inventory of the card order.
	Inventory *float32 `json:"inventory,omitempty"`
	// The quantity of cards ordered
	QuantityOrdered *float32 `json:"quantity_ordered,omitempty"`
	// The unit price for the card order.
	UnitPrice *float32 `json:"unit_price,omitempty"`
	// The reason for cancellation.
	CancelledReason *string `json:"cancelled_reason,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	AvailabilityDate *time.Time `json:"availability_date,omitempty"`
	// The fixed deadline for the cards to be printed.
	ExpectedAvailabilityDate *time.Time `json:"expected_availability_date,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object string `json:"object"`
}

CardOrder struct for CardOrder

func NewCardOrder 

func NewCardOrder(dateCreated time.Time, dateModified time.Time, object string) *CardOrder

NewCardOrder instantiates a new CardOrder object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardOrderWithDefaults 

func NewCardOrderWithDefaults() *CardOrder

NewCardOrderWithDefaults instantiates a new CardOrder object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CardOrder) GetAvailabilityDate 

func (o *CardOrder) GetAvailabilityDate() time.Time

GetAvailabilityDate returns the AvailabilityDate field value if set, zero value otherwise.

func (*CardOrder) GetAvailabilityDateOk 

func (o *CardOrder) GetAvailabilityDateOk() (*time.Time, bool)

GetAvailabilityDateOk returns a tuple with the AvailabilityDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetCancelledReason 

func (o *CardOrder) GetCancelledReason() string

GetCancelledReason returns the CancelledReason field value if set, zero value otherwise.

func (*CardOrder) GetCancelledReasonOk 

func (o *CardOrder) GetCancelledReasonOk() (*string, bool)

GetCancelledReasonOk returns a tuple with the CancelledReason field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetCardId 

func (o *CardOrder) GetCardId() string

GetCardId returns the CardId field value if set, zero value otherwise.

func (*CardOrder) GetCardIdOk 

func (o *CardOrder) GetCardIdOk() (*string, bool)

GetCardIdOk returns a tuple with the CardId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetDateCreated 

func (o *CardOrder) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*CardOrder) GetDateCreatedOk 

func (o *CardOrder) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*CardOrder) GetDateModified 

func (o *CardOrder) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*CardOrder) GetDateModifiedOk 

func (o *CardOrder) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*CardOrder) GetDeleted 

func (o *CardOrder) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*CardOrder) GetDeletedOk 

func (o *CardOrder) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetExpectedAvailabilityDate 

func (o *CardOrder) GetExpectedAvailabilityDate() time.Time

GetExpectedAvailabilityDate returns the ExpectedAvailabilityDate field value if set, zero value otherwise.

func (*CardOrder) GetExpectedAvailabilityDateOk 

func (o *CardOrder) GetExpectedAvailabilityDateOk() (*time.Time, bool)

GetExpectedAvailabilityDateOk returns a tuple with the ExpectedAvailabilityDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetId 

func (o *CardOrder) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*CardOrder) GetIdOk 

func (o *CardOrder) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetInventory 

func (o *CardOrder) GetInventory() float32

GetInventory returns the Inventory field value if set, zero value otherwise.

func (*CardOrder) GetInventoryOk 

func (o *CardOrder) GetInventoryOk() (*float32, bool)

GetInventoryOk returns a tuple with the Inventory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetObject 

func (o *CardOrder) GetObject() string

GetObject returns the Object field value

func (*CardOrder) GetObjectOk 

func (o *CardOrder) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*CardOrder) GetQuantityOrdered 

func (o *CardOrder) GetQuantityOrdered() float32

GetQuantityOrdered returns the QuantityOrdered field value if set, zero value otherwise.

func (*CardOrder) GetQuantityOrderedOk 

func (o *CardOrder) GetQuantityOrderedOk() (*float32, bool)

GetQuantityOrderedOk returns a tuple with the QuantityOrdered field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetStatus 

func (o *CardOrder) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*CardOrder) GetStatusOk 

func (o *CardOrder) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) GetUnitPrice 

func (o *CardOrder) GetUnitPrice() float32

GetUnitPrice returns the UnitPrice field value if set, zero value otherwise.

func (*CardOrder) GetUnitPriceOk 

func (o *CardOrder) GetUnitPriceOk() (*float32, bool)

GetUnitPriceOk returns a tuple with the UnitPrice field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrder) HasAvailabilityDate 

func (o *CardOrder) HasAvailabilityDate() bool

HasAvailabilityDate returns a boolean if a field has been set.

func (*CardOrder) HasCancelledReason 

func (o *CardOrder) HasCancelledReason() bool

HasCancelledReason returns a boolean if a field has been set.

func (*CardOrder) HasCardId 

func (o *CardOrder) HasCardId() bool

HasCardId returns a boolean if a field has been set.

func (*CardOrder) HasDeleted 

func (o *CardOrder) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*CardOrder) HasExpectedAvailabilityDate 

func (o *CardOrder) HasExpectedAvailabilityDate() bool

HasExpectedAvailabilityDate returns a boolean if a field has been set.

func (*CardOrder) HasId 

func (o *CardOrder) HasId() bool

HasId returns a boolean if a field has been set.

func (*CardOrder) HasInventory 

func (o *CardOrder) HasInventory() bool

HasInventory returns a boolean if a field has been set.

func (*CardOrder) HasQuantityOrdered 

func (o *CardOrder) HasQuantityOrdered() bool

HasQuantityOrdered returns a boolean if a field has been set.

func (*CardOrder) HasStatus 

func (o *CardOrder) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*CardOrder) HasUnitPrice 

func (o *CardOrder) HasUnitPrice() bool

HasUnitPrice returns a boolean if a field has been set.

func (CardOrder) MarshalJSON 

func (o CardOrder) MarshalJSON() ([]byte, error)

func (*CardOrder) SetAvailabilityDate 

func (o *CardOrder) SetAvailabilityDate(v time.Time)

SetAvailabilityDate gets a reference to the given time.Time and assigns it to the AvailabilityDate field.

func (*CardOrder) SetCancelledReason 

func (o *CardOrder) SetCancelledReason(v string)

SetCancelledReason gets a reference to the given string and assigns it to the CancelledReason field.

func (*CardOrder) SetCardId 

func (o *CardOrder) SetCardId(v string)

SetCardId gets a reference to the given string and assigns it to the CardId field.

func (*CardOrder) SetDateCreated 

func (o *CardOrder) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*CardOrder) SetDateModified 

func (o *CardOrder) SetDateModified(v time.Time)

SetDateModified sets field value

func (*CardOrder) SetDeleted 

func (o *CardOrder) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*CardOrder) SetExpectedAvailabilityDate 

func (o *CardOrder) SetExpectedAvailabilityDate(v time.Time)

SetExpectedAvailabilityDate gets a reference to the given time.Time and assigns it to the ExpectedAvailabilityDate field.

func (*CardOrder) SetId 

func (o *CardOrder) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*CardOrder) SetInventory 

func (o *CardOrder) SetInventory(v float32)

SetInventory gets a reference to the given float32 and assigns it to the Inventory field.

func (*CardOrder) SetObject 

func (o *CardOrder) SetObject(v string)

SetObject sets field value

func (*CardOrder) SetQuantityOrdered 

func (o *CardOrder) SetQuantityOrdered(v float32)

SetQuantityOrdered gets a reference to the given float32 and assigns it to the QuantityOrdered field.

func (*CardOrder) SetStatus 

func (o *CardOrder) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*CardOrder) SetUnitPrice 

func (o *CardOrder) SetUnitPrice(v float32)

SetUnitPrice gets a reference to the given float32 and assigns it to the UnitPrice field.

type CardOrderEditable 

type CardOrderEditable struct {
	Quantity int32 `json:"quantity"`
}

CardOrderEditable struct for CardOrderEditable

func NewCardOrderEditable 

func NewCardOrderEditable(quantity int32) *CardOrderEditable

NewCardOrderEditable instantiates a new CardOrderEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardOrderEditableWithDefaults 

func NewCardOrderEditableWithDefaults() *CardOrderEditable

NewCardOrderEditableWithDefaults instantiates a new CardOrderEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CardOrderEditable) GetQuantity 

func (o *CardOrderEditable) GetQuantity() int32

GetQuantity returns the Quantity field value

func (*CardOrderEditable) GetQuantityOk 

func (o *CardOrderEditable) GetQuantityOk() (*int32, bool)

GetQuantityOk returns a tuple with the Quantity field value and a boolean to check if the value has been set.

func (CardOrderEditable) MarshalJSON 

func (o CardOrderEditable) MarshalJSON() ([]byte, error)

func (*CardOrderEditable) SetQuantity 

func (o *CardOrderEditable) SetQuantity(v int32)

SetQuantity sets field value

type CardOrderList 

type CardOrderList struct {
	// list of card orders
	Data []CardOrder `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
}

CardOrderList struct for CardOrderList

func NewCardOrderList 

func NewCardOrderList() *CardOrderList

NewCardOrderList instantiates a new CardOrderList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardOrderListWithDefaults 

func NewCardOrderListWithDefaults() *CardOrderList

NewCardOrderListWithDefaults instantiates a new CardOrderList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CardOrderList) GetCount 

func (o *CardOrderList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*CardOrderList) GetCountOk 

func (o *CardOrderList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrderList) GetData 

func (o *CardOrderList) GetData() []CardOrder

GetData returns the Data field value if set, zero value otherwise.

func (*CardOrderList) GetDataOk 

func (o *CardOrderList) GetDataOk() ([]CardOrder, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrderList) GetNextUrl 

func (o *CardOrderList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CardOrderList) GetNextUrlOk 

func (o *CardOrderList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CardOrderList) GetObject 

func (o *CardOrderList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CardOrderList) GetObjectOk 

func (o *CardOrderList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardOrderList) GetPreviousUrl 

func (o *CardOrderList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CardOrderList) GetPreviousUrlOk 

func (o *CardOrderList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CardOrderList) HasCount 

func (o *CardOrderList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*CardOrderList) HasData 

func (o *CardOrderList) HasData() bool

HasData returns a boolean if a field has been set.

func (*CardOrderList) HasNextUrl 

func (o *CardOrderList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*CardOrderList) HasObject 

func (o *CardOrderList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*CardOrderList) HasPreviousUrl 

func (o *CardOrderList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (CardOrderList) MarshalJSON 

func (o CardOrderList) MarshalJSON() ([]byte, error)

func (*CardOrderList) SetCount 

func (o *CardOrderList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*CardOrderList) SetData 

func (o *CardOrderList) SetData(v []CardOrder)

SetData gets a reference to the given []CardOrder and assigns it to the Data field.

func (*CardOrderList) SetNextUrl 

func (o *CardOrderList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*CardOrderList) SetNextUrlNil 

func (o *CardOrderList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*CardOrderList) SetObject 

func (o *CardOrderList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*CardOrderList) SetPreviousUrl 

func (o *CardOrderList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*CardOrderList) SetPreviousUrlNil 

func (o *CardOrderList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*CardOrderList) UnsetNextUrl 

func (o *CardOrderList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*CardOrderList) UnsetPreviousUrl 

func (o *CardOrderList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type CardOrdersApiService 

type CardOrdersApiService service

CardOrdersApiService CardOrdersApi service

func (*CardOrdersApiService) CardOrderCreateExecute 

func (a *CardOrdersApiService) CardOrderCreateExecute(r ApiCardOrderCreateRequest) (*CardOrder, *http.Response, error)

Execute executes the request 

@return CardOrder

func (*CardOrdersApiService) CardOrdersRetrieveExecute 

func (a *CardOrdersApiService) CardOrdersRetrieveExecute(r ApiCardOrdersRetrieveRequest) (*CardOrderList, *http.Response, error)

Execute executes the request 

@return CardOrderList

func (*CardOrdersApiService) Create 

func (a *CardOrdersApiService) Create(ctx context.Context, cardId string) ApiCardOrderCreateRequest

CardOrderCreate create

Creates a new card order given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cardId The ID of the card to which the card orders belong.
@return ApiCardOrderCreateRequest

func (*CardOrdersApiService) Get 

func (a *CardOrdersApiService) Get(ctx context.Context, cardId string) ApiCardOrdersRetrieveRequest

CardOrdersRetrieve get

Retrieves the card orders associated with the given card id. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cardId The ID of the card to which the card orders belong.
@return ApiCardOrdersRetrieveRequest

type CardUpdatable 

type CardUpdatable struct {
	// Description of the card.
	Description NullableString `json:"description,omitempty"`
	// Allows for auto reordering
	AutoReorder *bool `json:"auto_reorder,omitempty"`
	// The quantity of items to be reordered (only required when auto_reorder is true).
	ReorderQuantity *float32 `json:"reorder_quantity,omitempty"`
}

CardUpdatable struct for CardUpdatable

func NewCardUpdatable 

func NewCardUpdatable() *CardUpdatable

NewCardUpdatable instantiates a new CardUpdatable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCardUpdatableWithDefaults 

func NewCardUpdatableWithDefaults() *CardUpdatable

NewCardUpdatableWithDefaults instantiates a new CardUpdatable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CardUpdatable) GetAutoReorder 

func (o *CardUpdatable) GetAutoReorder() bool

GetAutoReorder returns the AutoReorder field value if set, zero value otherwise.

func (*CardUpdatable) GetAutoReorderOk 

func (o *CardUpdatable) GetAutoReorderOk() (*bool, bool)

GetAutoReorderOk returns a tuple with the AutoReorder field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardUpdatable) GetDescription 

func (o *CardUpdatable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CardUpdatable) GetDescriptionOk 

func (o *CardUpdatable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CardUpdatable) GetReorderQuantity 

func (o *CardUpdatable) GetReorderQuantity() float32

GetReorderQuantity returns the ReorderQuantity field value if set, zero value otherwise.

func (*CardUpdatable) GetReorderQuantityOk 

func (o *CardUpdatable) GetReorderQuantityOk() (*float32, bool)

GetReorderQuantityOk returns a tuple with the ReorderQuantity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CardUpdatable) HasAutoReorder 

func (o *CardUpdatable) HasAutoReorder() bool

HasAutoReorder returns a boolean if a field has been set.

func (*CardUpdatable) HasDescription 

func (o *CardUpdatable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CardUpdatable) HasReorderQuantity 

func (o *CardUpdatable) HasReorderQuantity() bool

HasReorderQuantity returns a boolean if a field has been set.

func (CardUpdatable) MarshalJSON 

func (o CardUpdatable) MarshalJSON() ([]byte, error)

func (*CardUpdatable) SetAutoReorder 

func (o *CardUpdatable) SetAutoReorder(v bool)

SetAutoReorder gets a reference to the given bool and assigns it to the AutoReorder field.

func (*CardUpdatable) SetDescription 

func (o *CardUpdatable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CardUpdatable) SetDescriptionNil 

func (o *CardUpdatable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CardUpdatable) SetReorderQuantity 

func (o *CardUpdatable) SetReorderQuantity(v float32)

SetReorderQuantity gets a reference to the given float32 and assigns it to the ReorderQuantity field.

func (*CardUpdatable) UnsetDescription 

func (o *CardUpdatable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type CardsApiService 

type CardsApiService service

CardsApiService CardsApi service

func (*CardsApiService) CardCreateExecute 

func (a *CardsApiService) CardCreateExecute(r ApiCardCreateRequest) (*Card, *http.Response, error)

Execute executes the request 

@return Card

func (*CardsApiService) CardDeleteExecute 

func (a *CardsApiService) CardDeleteExecute(r ApiCardDeleteRequest) (*CardDeletion, *http.Response, error)

Execute executes the request 

@return CardDeletion

func (*CardsApiService) CardRetrieveExecute 

func (a *CardsApiService) CardRetrieveExecute(r ApiCardRetrieveRequest) (*Card, *http.Response, error)

Execute executes the request 

@return Card

func (*CardsApiService) CardUpdateExecute 

func (a *CardsApiService) CardUpdateExecute(r ApiCardUpdateRequest) (*Card, *http.Response, error)

Execute executes the request 

@return Card

func (*CardsApiService) CardsListExecute 

func (a *CardsApiService) CardsListExecute(r ApiCardsListRequest) (*CardList, *http.Response, error)

Execute executes the request 

@return CardList

func (*CardsApiService) Create 

func (a *CardsApiService) Create(ctx context.Context) ApiCardCreateRequest

CardCreate create

Creates a new card given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCardCreateRequest

func (*CardsApiService) Delete 

func (a *CardsApiService) Delete(ctx context.Context, cardId string) ApiCardDeleteRequest

CardDelete delete

Delete an existing card. You need only supply the unique identifier that was returned upon card creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cardId id of the card
@return ApiCardDeleteRequest

func (*CardsApiService) Get 

func (a *CardsApiService) Get(ctx context.Context, cardId string) ApiCardRetrieveRequest

CardRetrieve get

Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cardId id of the card
@return ApiCardRetrieveRequest

func (*CardsApiService) List 

func (a *CardsApiService) List(ctx context.Context) ApiCardsListRequest

CardsList list

Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCardsListRequest

func (*CardsApiService) Update 

func (a *CardsApiService) Update(ctx context.Context, cardId string) ApiCardUpdateRequest

CardUpdate update

Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cardId id of the card
@return ApiCardUpdateRequest

type Check 

type Check struct {
	// Unique identifier prefixed with `chk_`.
	Id   string   `json:"id"`
	To   Address  `json:"to"`
	From *Address `json:"from,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time `json:"send_date,omitempty"`
	// Checks must be sent `usps_first_class`
	MailType *string `json:"mail_type,omitempty"`
	// Text to include on the memo line of the check.
	Memo NullableString `json:"memo,omitempty"`
	// An integer that designates the check number. If `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`. A provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number.
	CheckNumber *int32 `json:"check_number,omitempty"`
	// Max of 400 characters to be included at the bottom of the check page.
	Message *string `json:"message,omitempty"`
	// The payment amount to be sent in US dollars.
	Amount      float32     `json:"amount"`
	BankAccount BankAccount `json:"bank_account"`
	// Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
	CheckBottomTemplateId *string `json:"check_bottom_template_id,omitempty"`
	// Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
	AttachmentTemplateId *string `json:"attachment_template_id,omitempty"`
	// Unique identifier prefixed with `vrsn_`.
	CheckBottomTemplateVersionId *string `json:"check_bottom_template_version_id,omitempty"`
	// Unique identifier prefixed with `vrsn_`.
	AttachmentTemplateVersionId *string `json:"attachment_template_version_id,omitempty"`
	// A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
	Url        string      `json:"url"`
	Carrier    string      `json:"carrier"`
	Thumbnails []Thumbnail `json:"thumbnails,omitempty"`
	// A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.
	ExpectedDeliveryDate *string `json:"expected_delivery_date,omitempty"`
	// An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode.
	TrackingEvents []TrackingEventNormal `json:"tracking_events,omitempty"`
	Object         string                `json:"object"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool              `json:"deleted,omitempty"`
	UseType NullableChkUseType `json:"use_type"`
}

Check struct for Check

func NewCheck 

func NewCheck(id string, to Address, amount float32, bankAccount BankAccount, url string, carrier string, object string, dateCreated time.Time, dateModified time.Time, useType NullableChkUseType) *Check

NewCheck instantiates a new Check object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCheckWithDefaults 

func NewCheckWithDefaults() *Check

NewCheckWithDefaults instantiates a new Check object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Check) GetAmount 

func (o *Check) GetAmount() float32

GetAmount returns the Amount field value

func (*Check) GetAmountOk 

func (o *Check) GetAmountOk() (*float32, bool)

GetAmountOk returns a tuple with the Amount field value and a boolean to check if the value has been set.

func (*Check) GetAttachmentTemplateId 

func (o *Check) GetAttachmentTemplateId() string

GetAttachmentTemplateId returns the AttachmentTemplateId field value if set, zero value otherwise.

func (*Check) GetAttachmentTemplateIdOk 

func (o *Check) GetAttachmentTemplateIdOk() (*string, bool)

GetAttachmentTemplateIdOk returns a tuple with the AttachmentTemplateId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetAttachmentTemplateVersionId 

func (o *Check) GetAttachmentTemplateVersionId() string

GetAttachmentTemplateVersionId returns the AttachmentTemplateVersionId field value if set, zero value otherwise.

func (*Check) GetAttachmentTemplateVersionIdOk 

func (o *Check) GetAttachmentTemplateVersionIdOk() (*string, bool)

GetAttachmentTemplateVersionIdOk returns a tuple with the AttachmentTemplateVersionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetBankAccount 

func (o *Check) GetBankAccount() BankAccount

GetBankAccount returns the BankAccount field value

func (*Check) GetBankAccountOk 

func (o *Check) GetBankAccountOk() (*BankAccount, bool)

GetBankAccountOk returns a tuple with the BankAccount field value and a boolean to check if the value has been set.

func (*Check) GetCarrier 

func (o *Check) GetCarrier() string

GetCarrier returns the Carrier field value

func (*Check) GetCarrierOk 

func (o *Check) GetCarrierOk() (*string, bool)

GetCarrierOk returns a tuple with the Carrier field value and a boolean to check if the value has been set.

func (*Check) GetCheckBottomTemplateId 

func (o *Check) GetCheckBottomTemplateId() string

GetCheckBottomTemplateId returns the CheckBottomTemplateId field value if set, zero value otherwise.

func (*Check) GetCheckBottomTemplateIdOk 

func (o *Check) GetCheckBottomTemplateIdOk() (*string, bool)

GetCheckBottomTemplateIdOk returns a tuple with the CheckBottomTemplateId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetCheckBottomTemplateVersionId 

func (o *Check) GetCheckBottomTemplateVersionId() string

GetCheckBottomTemplateVersionId returns the CheckBottomTemplateVersionId field value if set, zero value otherwise.

func (*Check) GetCheckBottomTemplateVersionIdOk 

func (o *Check) GetCheckBottomTemplateVersionIdOk() (*string, bool)

GetCheckBottomTemplateVersionIdOk returns a tuple with the CheckBottomTemplateVersionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetCheckNumber 

func (o *Check) GetCheckNumber() int32

GetCheckNumber returns the CheckNumber field value if set, zero value otherwise.

func (*Check) GetCheckNumberOk 

func (o *Check) GetCheckNumberOk() (*int32, bool)

GetCheckNumberOk returns a tuple with the CheckNumber field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetDateCreated 

func (o *Check) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*Check) GetDateCreatedOk 

func (o *Check) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*Check) GetDateModified 

func (o *Check) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*Check) GetDateModifiedOk 

func (o *Check) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*Check) GetDeleted 

func (o *Check) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*Check) GetDeletedOk 

func (o *Check) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetDescription 

func (o *Check) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Check) GetDescriptionOk 

func (o *Check) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Check) GetExpectedDeliveryDate 

func (o *Check) GetExpectedDeliveryDate() string

GetExpectedDeliveryDate returns the ExpectedDeliveryDate field value if set, zero value otherwise.

func (*Check) GetExpectedDeliveryDateOk 

func (o *Check) GetExpectedDeliveryDateOk() (*string, bool)

GetExpectedDeliveryDateOk returns a tuple with the ExpectedDeliveryDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetFrom 

func (o *Check) GetFrom() Address

GetFrom returns the From field value if set, zero value otherwise.

func (*Check) GetFromOk 

func (o *Check) GetFromOk() (*Address, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetId 

func (o *Check) GetId() string

GetId returns the Id field value

func (*Check) GetIdOk 

func (o *Check) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Check) GetMailType 

func (o *Check) GetMailType() string

GetMailType returns the MailType field value if set, zero value otherwise.

func (*Check) GetMailTypeOk 

func (o *Check) GetMailTypeOk() (*string, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetMemo 

func (o *Check) GetMemo() string

GetMemo returns the Memo field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Check) GetMemoOk 

func (o *Check) GetMemoOk() (*string, bool)

GetMemoOk returns a tuple with the Memo field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Check) GetMergeVariables 

func (o *Check) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Check) GetMergeVariablesOk 

func (o *Check) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Check) GetMessage 

func (o *Check) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*Check) GetMessageOk 

func (o *Check) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetMetadata 

func (o *Check) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*Check) GetMetadataOk 

func (o *Check) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetObject 

func (o *Check) GetObject() string

GetObject returns the Object field value

func (*Check) GetObjectOk 

func (o *Check) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*Check) GetSendDate 

func (o *Check) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*Check) GetSendDateOk 

func (o *Check) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetThumbnails 

func (o *Check) GetThumbnails() []Thumbnail

GetThumbnails returns the Thumbnails field value if set, zero value otherwise.

func (*Check) GetThumbnailsOk 

func (o *Check) GetThumbnailsOk() ([]Thumbnail, bool)

GetThumbnailsOk returns a tuple with the Thumbnails field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Check) GetTo 

func (o *Check) GetTo() Address

GetTo returns the To field value

func (*Check) GetToOk 

func (o *Check) GetToOk() (*Address, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set.

func (*Check) GetTrackingEvents 

func (o *Check) GetTrackingEvents() []TrackingEventNormal

GetTrackingEvents returns the TrackingEvents field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Check) GetTrackingEventsOk 

func (o *Check) GetTrackingEventsOk() ([]TrackingEventNormal, bool)

GetTrackingEventsOk returns a tuple with the TrackingEvents field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Check) GetUrl 

func (o *Check) GetUrl() string

GetUrl returns the Url field value

func (*Check) GetUrlOk 

func (o *Check) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*Check) GetUseType 

func (o *Check) GetUseType() ChkUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for ChkUseType will be returned

func (*Check) GetUseTypeOk 

func (o *Check) GetUseTypeOk() (*ChkUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Check) HasAttachmentTemplateId 

func (o *Check) HasAttachmentTemplateId() bool

HasAttachmentTemplateId returns a boolean if a field has been set.

func (*Check) HasAttachmentTemplateVersionId 

func (o *Check) HasAttachmentTemplateVersionId() bool

HasAttachmentTemplateVersionId returns a boolean if a field has been set.

func (*Check) HasCheckBottomTemplateId 

func (o *Check) HasCheckBottomTemplateId() bool

HasCheckBottomTemplateId returns a boolean if a field has been set.

func (*Check) HasCheckBottomTemplateVersionId 

func (o *Check) HasCheckBottomTemplateVersionId() bool

HasCheckBottomTemplateVersionId returns a boolean if a field has been set.

func (*Check) HasCheckNumber 

func (o *Check) HasCheckNumber() bool

HasCheckNumber returns a boolean if a field has been set.

func (*Check) HasDeleted 

func (o *Check) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*Check) HasDescription 

func (o *Check) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Check) HasExpectedDeliveryDate 

func (o *Check) HasExpectedDeliveryDate() bool

HasExpectedDeliveryDate returns a boolean if a field has been set.

func (*Check) HasFrom 

func (o *Check) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*Check) HasMailType 

func (o *Check) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*Check) HasMemo 

func (o *Check) HasMemo() bool

HasMemo returns a boolean if a field has been set.

func (*Check) HasMergeVariables 

func (o *Check) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*Check) HasMessage 

func (o *Check) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*Check) HasMetadata 

func (o *Check) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*Check) HasSendDate 

func (o *Check) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*Check) HasThumbnails 

func (o *Check) HasThumbnails() bool

HasThumbnails returns a boolean if a field has been set.

func (*Check) HasTrackingEvents 

func (o *Check) HasTrackingEvents() bool

HasTrackingEvents returns a boolean if a field has been set.

func (Check) MarshalJSON 

func (o Check) MarshalJSON() ([]byte, error)

func (*Check) SetAmount 

func (o *Check) SetAmount(v float32)

SetAmount sets field value

func (*Check) SetAttachmentTemplateId 

func (o *Check) SetAttachmentTemplateId(v string)

SetAttachmentTemplateId gets a reference to the given string and assigns it to the AttachmentTemplateId field.

func (*Check) SetAttachmentTemplateVersionId 

func (o *Check) SetAttachmentTemplateVersionId(v string)

SetAttachmentTemplateVersionId gets a reference to the given string and assigns it to the AttachmentTemplateVersionId field.

func (*Check) SetBankAccount 

func (o *Check) SetBankAccount(v BankAccount)

SetBankAccount sets field value

func (*Check) SetCarrier 

func (o *Check) SetCarrier(v string)

SetCarrier sets field value

func (*Check) SetCheckBottomTemplateId 

func (o *Check) SetCheckBottomTemplateId(v string)

SetCheckBottomTemplateId gets a reference to the given string and assigns it to the CheckBottomTemplateId field.

func (*Check) SetCheckBottomTemplateVersionId 

func (o *Check) SetCheckBottomTemplateVersionId(v string)

SetCheckBottomTemplateVersionId gets a reference to the given string and assigns it to the CheckBottomTemplateVersionId field.

func (*Check) SetCheckNumber 

func (o *Check) SetCheckNumber(v int32)

SetCheckNumber gets a reference to the given int32 and assigns it to the CheckNumber field.

func (*Check) SetDateCreated 

func (o *Check) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*Check) SetDateModified 

func (o *Check) SetDateModified(v time.Time)

SetDateModified sets field value

func (*Check) SetDeleted 

func (o *Check) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*Check) SetDescription 

func (o *Check) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*Check) SetDescriptionNil 

func (o *Check) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*Check) SetExpectedDeliveryDate 

func (o *Check) SetExpectedDeliveryDate(v string)

SetExpectedDeliveryDate gets a reference to the given string and assigns it to the ExpectedDeliveryDate field.

func (*Check) SetFrom 

func (o *Check) SetFrom(v Address)

SetFrom gets a reference to the given Address and assigns it to the From field.

func (*Check) SetId 

func (o *Check) SetId(v string)

SetId sets field value

func (*Check) SetMailType 

func (o *Check) SetMailType(v string)

SetMailType gets a reference to the given string and assigns it to the MailType field.

func (*Check) SetMemo 

func (o *Check) SetMemo(v string)

SetMemo gets a reference to the given NullableString and assigns it to the Memo field.

func (*Check) SetMemoNil 

func (o *Check) SetMemoNil()

SetMemoNil sets the value for Memo to be an explicit nil

func (*Check) SetMergeVariables 

func (o *Check) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*Check) SetMessage 

func (o *Check) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*Check) SetMetadata 

func (o *Check) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*Check) SetObject 

func (o *Check) SetObject(v string)

SetObject sets field value

func (*Check) SetSendDate 

func (o *Check) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*Check) SetThumbnails 

func (o *Check) SetThumbnails(v []Thumbnail)

SetThumbnails gets a reference to the given []Thumbnail and assigns it to the Thumbnails field.

func (*Check) SetTo 

func (o *Check) SetTo(v Address)

SetTo sets field value

func (*Check) SetTrackingEvents 

func (o *Check) SetTrackingEvents(v []TrackingEventNormal)

SetTrackingEvents gets a reference to the given []TrackingEventNormal and assigns it to the TrackingEvents field.

func (*Check) SetUrl 

func (o *Check) SetUrl(v string)

SetUrl sets field value

func (*Check) SetUseType 

func (o *Check) SetUseType(v ChkUseType)

SetUseType sets field value

func (*Check) UnsetDescription 

func (o *Check) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*Check) UnsetMemo 

func (o *Check) UnsetMemo()

UnsetMemo ensures that no value is present for Memo, not even an explicit nil

type CheckDeletion 

type CheckDeletion struct {
	// Unique identifier prefixed with `chk_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

CheckDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewCheckDeletion 

func NewCheckDeletion() *CheckDeletion

NewCheckDeletion instantiates a new CheckDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCheckDeletionWithDefaults 

func NewCheckDeletionWithDefaults() *CheckDeletion

NewCheckDeletionWithDefaults instantiates a new CheckDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CheckDeletion) GetDeleted 

func (o *CheckDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*CheckDeletion) GetDeletedOk 

func (o *CheckDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckDeletion) GetId 

func (o *CheckDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*CheckDeletion) GetIdOk 

func (o *CheckDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckDeletion) GetObject 

func (o *CheckDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CheckDeletion) GetObjectOk 

func (o *CheckDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckDeletion) HasDeleted 

func (o *CheckDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*CheckDeletion) HasId 

func (o *CheckDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*CheckDeletion) HasObject 

func (o *CheckDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (CheckDeletion) MarshalJSON 

func (o CheckDeletion) MarshalJSON() ([]byte, error)

func (*CheckDeletion) SetDeleted 

func (o *CheckDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*CheckDeletion) SetId 

func (o *CheckDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*CheckDeletion) SetObject 

func (o *CheckDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type CheckEditable 

type CheckEditable struct {
	// Must either be an address ID or an inline object with correct address parameters.
	From interface{} `json:"from"`
	// Must either be an address ID or an inline object with correct address parameters.
	To          interface{}    `json:"to"`
	BankAccount NullableString `json:"bank_account"`
	// The payment amount to be sent in US dollars.
	Amount float32 `json:"amount"`
	Logo *string `json:"logo,omitempty"`
	// The artwork to use on the bottom of the check page.  Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5\"x11\" page. - The check bottom will always be printed in black & white. - Must conform to [this template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf).  Need more help? Consult our [HTML examples](#section/HTML-Examples).
	CheckBottom *string `json:"check_bottom,omitempty"`
	// A document to include with the check.
	Attachment *string `json:"attachment,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time `json:"send_date,omitempty"`
	// Checks must be sent `usps_first_class`
	MailType *string `json:"mail_type,omitempty"`
	// Text to include on the memo line of the check.
	Memo NullableString `json:"memo,omitempty"`
	// An integer that designates the check number.
	CheckNumber *int32 `json:"check_number,omitempty"`
	// Max of 400 characters to be included at the bottom of the check page.
	Message *string `json:"message,omitempty"`
	// An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.
	BillingGroupId *string            `json:"billing_group_id,omitempty"`
	UseType        NullableChkUseType `json:"use_type"`
}

CheckEditable struct for CheckEditable

func NewCheckEditable 

func NewCheckEditable(from interface{}, to interface{}, bankAccount NullableString, amount float32, useType NullableChkUseType) *CheckEditable

NewCheckEditable instantiates a new CheckEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCheckEditableWithDefaults 

func NewCheckEditableWithDefaults() *CheckEditable

NewCheckEditableWithDefaults instantiates a new CheckEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CheckEditable) GetAmount 

func (o *CheckEditable) GetAmount() float32

GetAmount returns the Amount field value

func (*CheckEditable) GetAmountOk 

func (o *CheckEditable) GetAmountOk() (*float32, bool)

GetAmountOk returns a tuple with the Amount field value and a boolean to check if the value has been set.

func (*CheckEditable) GetAttachment 

func (o *CheckEditable) GetAttachment() string

GetAttachment returns the Attachment field value if set, zero value otherwise.

func (*CheckEditable) GetAttachmentOk 

func (o *CheckEditable) GetAttachmentOk() (*string, bool)

GetAttachmentOk returns a tuple with the Attachment field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetBankAccount 

func (o *CheckEditable) GetBankAccount() string

GetBankAccount returns the BankAccount field value If the value is explicit nil, the zero value for string will be returned

func (*CheckEditable) GetBankAccountOk 

func (o *CheckEditable) GetBankAccountOk() (*string, bool)

GetBankAccountOk returns a tuple with the BankAccount field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckEditable) GetBillingGroupId 

func (o *CheckEditable) GetBillingGroupId() string

GetBillingGroupId returns the BillingGroupId field value if set, zero value otherwise.

func (*CheckEditable) GetBillingGroupIdOk 

func (o *CheckEditable) GetBillingGroupIdOk() (*string, bool)

GetBillingGroupIdOk returns a tuple with the BillingGroupId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetCheckBottom 

func (o *CheckEditable) GetCheckBottom() string

GetCheckBottom returns the CheckBottom field value if set, zero value otherwise.

func (*CheckEditable) GetCheckBottomOk 

func (o *CheckEditable) GetCheckBottomOk() (*string, bool)

GetCheckBottomOk returns a tuple with the CheckBottom field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetCheckNumber 

func (o *CheckEditable) GetCheckNumber() int32

GetCheckNumber returns the CheckNumber field value if set, zero value otherwise.

func (*CheckEditable) GetCheckNumberOk 

func (o *CheckEditable) GetCheckNumberOk() (*int32, bool)

GetCheckNumberOk returns a tuple with the CheckNumber field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetDescription 

func (o *CheckEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CheckEditable) GetDescriptionOk 

func (o *CheckEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckEditable) GetFrom 

func (o *CheckEditable) GetFrom() interface{}

GetFrom returns the From field value If the value is explicit nil, the zero value for interface{} will be returned

func (*CheckEditable) GetFromOk 

func (o *CheckEditable) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned 

func (o *CheckEditable) GetLogo() string

GetLogo returns the Logo field value if set, zero value otherwise.

func (*CheckEditable) GetLogoOk 

func (o *CheckEditable) GetLogoOk() (*string, bool)

GetLogoOk returns a tuple with the Logo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetMailType 

func (o *CheckEditable) GetMailType() string

GetMailType returns the MailType field value if set, zero value otherwise.

func (*CheckEditable) GetMailTypeOk 

func (o *CheckEditable) GetMailTypeOk() (*string, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetMemo 

func (o *CheckEditable) GetMemo() string

GetMemo returns the Memo field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CheckEditable) GetMemoOk 

func (o *CheckEditable) GetMemoOk() (*string, bool)

GetMemoOk returns a tuple with the Memo field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckEditable) GetMergeVariables 

func (o *CheckEditable) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CheckEditable) GetMergeVariablesOk 

func (o *CheckEditable) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckEditable) GetMessage 

func (o *CheckEditable) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*CheckEditable) GetMessageOk 

func (o *CheckEditable) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetMetadata 

func (o *CheckEditable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*CheckEditable) GetMetadataOk 

func (o *CheckEditable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetSendDate 

func (o *CheckEditable) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*CheckEditable) GetSendDateOk 

func (o *CheckEditable) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckEditable) GetTo 

func (o *CheckEditable) GetTo() interface{}

GetTo returns the To field value If the value is explicit nil, the zero value for interface{} will be returned

func (*CheckEditable) GetToOk 

func (o *CheckEditable) GetToOk() (*interface{}, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckEditable) GetUseType 

func (o *CheckEditable) GetUseType() ChkUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for ChkUseType will be returned

func (*CheckEditable) GetUseTypeOk 

func (o *CheckEditable) GetUseTypeOk() (*ChkUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckEditable) HasAttachment 

func (o *CheckEditable) HasAttachment() bool

HasAttachment returns a boolean if a field has been set.

func (*CheckEditable) HasBillingGroupId 

func (o *CheckEditable) HasBillingGroupId() bool

HasBillingGroupId returns a boolean if a field has been set.

func (*CheckEditable) HasCheckBottom 

func (o *CheckEditable) HasCheckBottom() bool

HasCheckBottom returns a boolean if a field has been set.

func (*CheckEditable) HasCheckNumber 

func (o *CheckEditable) HasCheckNumber() bool

HasCheckNumber returns a boolean if a field has been set.

func (*CheckEditable) HasDescription 

func (o *CheckEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set. 

func (o *CheckEditable) HasLogo() bool

HasLogo returns a boolean if a field has been set.

func (*CheckEditable) HasMailType 

func (o *CheckEditable) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*CheckEditable) HasMemo 

func (o *CheckEditable) HasMemo() bool

HasMemo returns a boolean if a field has been set.

func (*CheckEditable) HasMergeVariables 

func (o *CheckEditable) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*CheckEditable) HasMessage 

func (o *CheckEditable) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*CheckEditable) HasMetadata 

func (o *CheckEditable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*CheckEditable) HasSendDate 

func (o *CheckEditable) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (CheckEditable) MarshalJSON 

func (o CheckEditable) MarshalJSON() ([]byte, error)

func (*CheckEditable) SetAmount 

func (o *CheckEditable) SetAmount(v float32)

SetAmount sets field value

func (*CheckEditable) SetAttachment 

func (o *CheckEditable) SetAttachment(v string)

SetAttachment gets a reference to the given string and assigns it to the Attachment field.

func (*CheckEditable) SetBankAccount 

func (o *CheckEditable) SetBankAccount(v string)

SetBankAccount sets field value

func (*CheckEditable) SetBillingGroupId 

func (o *CheckEditable) SetBillingGroupId(v string)

SetBillingGroupId gets a reference to the given string and assigns it to the BillingGroupId field.

func (*CheckEditable) SetCheckBottom 

func (o *CheckEditable) SetCheckBottom(v string)

SetCheckBottom gets a reference to the given string and assigns it to the CheckBottom field.

func (*CheckEditable) SetCheckNumber 

func (o *CheckEditable) SetCheckNumber(v int32)

SetCheckNumber gets a reference to the given int32 and assigns it to the CheckNumber field.

func (*CheckEditable) SetDescription 

func (o *CheckEditable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CheckEditable) SetDescriptionNil 

func (o *CheckEditable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CheckEditable) SetFrom 

func (o *CheckEditable) SetFrom(v interface{})

SetFrom sets field value 

func (o *CheckEditable) SetLogo(v string)

SetLogo gets a reference to the given string and assigns it to the Logo field.

func (*CheckEditable) SetMailType 

func (o *CheckEditable) SetMailType(v string)

SetMailType gets a reference to the given string and assigns it to the MailType field.

func (*CheckEditable) SetMemo 

func (o *CheckEditable) SetMemo(v string)

SetMemo gets a reference to the given NullableString and assigns it to the Memo field.

func (*CheckEditable) SetMemoNil 

func (o *CheckEditable) SetMemoNil()

SetMemoNil sets the value for Memo to be an explicit nil

func (*CheckEditable) SetMergeVariables 

func (o *CheckEditable) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*CheckEditable) SetMessage 

func (o *CheckEditable) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*CheckEditable) SetMetadata 

func (o *CheckEditable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*CheckEditable) SetSendDate 

func (o *CheckEditable) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*CheckEditable) SetTo 

func (o *CheckEditable) SetTo(v interface{})

SetTo sets field value

func (*CheckEditable) SetUseType 

func (o *CheckEditable) SetUseType(v ChkUseType)

SetUseType sets field value

func (*CheckEditable) UnsetDescription 

func (o *CheckEditable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*CheckEditable) UnsetMemo 

func (o *CheckEditable) UnsetMemo()

UnsetMemo ensures that no value is present for Memo, not even an explicit nil

type CheckList 

type CheckList struct {
	// list of checks
	Data []Check `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

CheckList struct for CheckList

func NewCheckList 

func NewCheckList() *CheckList

NewCheckList instantiates a new CheckList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCheckListWithDefaults 

func NewCheckListWithDefaults() *CheckList

NewCheckListWithDefaults instantiates a new CheckList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CheckList) GetCount 

func (o *CheckList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*CheckList) GetCountOk 

func (o *CheckList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckList) GetData 

func (o *CheckList) GetData() []Check

GetData returns the Data field value if set, zero value otherwise.

func (*CheckList) GetDataOk 

func (o *CheckList) GetDataOk() ([]Check, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckList) GetNextPageToken 

func (o *CheckList) GetNextPageToken() string

func (*CheckList) GetNextUrl 

func (o *CheckList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CheckList) GetNextUrlOk 

func (o *CheckList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckList) GetObject 

func (o *CheckList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CheckList) GetObjectOk 

func (o *CheckList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckList) GetPrevPageToken 

func (o *CheckList) GetPrevPageToken() string

func (*CheckList) GetPreviousUrl 

func (o *CheckList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CheckList) GetPreviousUrlOk 

func (o *CheckList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CheckList) GetTotalCount 

func (o *CheckList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*CheckList) GetTotalCountOk 

func (o *CheckList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckList) HasCount 

func (o *CheckList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*CheckList) HasData 

func (o *CheckList) HasData() bool

HasData returns a boolean if a field has been set.

func (*CheckList) HasNextUrl 

func (o *CheckList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*CheckList) HasObject 

func (o *CheckList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*CheckList) HasPreviousUrl 

func (o *CheckList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*CheckList) HasTotalCount 

func (o *CheckList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (CheckList) MarshalJSON 

func (o CheckList) MarshalJSON() ([]byte, error)

func (*CheckList) SetCount 

func (o *CheckList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*CheckList) SetData 

func (o *CheckList) SetData(v []Check)

SetData gets a reference to the given []Check and assigns it to the Data field.

func (*CheckList) SetNextUrl 

func (o *CheckList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*CheckList) SetNextUrlNil 

func (o *CheckList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*CheckList) SetObject 

func (o *CheckList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*CheckList) SetPreviousUrl 

func (o *CheckList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*CheckList) SetPreviousUrlNil 

func (o *CheckList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*CheckList) SetTotalCount 

func (o *CheckList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*CheckList) UnsetNextUrl 

func (o *CheckList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*CheckList) UnsetPreviousUrl 

func (o *CheckList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type ChecksApiService 

type ChecksApiService service

ChecksApiService ChecksApi service

func (*ChecksApiService) Cancel 

func (a *ChecksApiService) Cancel(ctx context.Context, chkId string) ApiCheckCancelRequest

CheckCancel cancel

Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param chkId id of the check
@return ApiCheckCancelRequest

func (*ChecksApiService) CheckCancelExecute 

func (a *ChecksApiService) CheckCancelExecute(r ApiCheckCancelRequest) (*CheckDeletion, *http.Response, error)

Execute executes the request 

@return CheckDeletion

func (*ChecksApiService) CheckCreateExecute 

func (a *ChecksApiService) CheckCreateExecute(r ApiCheckCreateRequest) (*Check, *http.Response, error)

Execute executes the request 

@return Check

func (*ChecksApiService) CheckRetrieveExecute 

func (a *ChecksApiService) CheckRetrieveExecute(r ApiCheckRetrieveRequest) (*Check, *http.Response, error)

Execute executes the request 

@return Check

func (*ChecksApiService) ChecksListExecute 

func (a *ChecksApiService) ChecksListExecute(r ApiChecksListRequest) (*CheckList, *http.Response, error)

Execute executes the request 

@return CheckList

func (*ChecksApiService) Create 

func (a *ChecksApiService) Create(ctx context.Context) ApiCheckCreateRequest

CheckCreate create

Creates a new check with the provided properties. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCheckCreateRequest

func (*ChecksApiService) Get 

func (a *ChecksApiService) Get(ctx context.Context, chkId string) ApiCheckRetrieveRequest

CheckRetrieve get

Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param chkId id of the check
@return ApiCheckRetrieveRequest

func (*ChecksApiService) List 

func (a *ChecksApiService) List(ctx context.Context) ApiChecksListRequest

ChecksList list

Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiChecksListRequest

type ChkUseType 

type ChkUseType string

ChkUseType TThe use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). 

const (
	CHKUSETYPE_MARKETING   ChkUseType = "marketing"
	CHKUSETYPE_OPERATIONAL ChkUseType = "operational"
	CHKUSETYPE_NULL        ChkUseType = "null"
)

List of chk_use_type

func NewChkUseTypeFromValue 

func NewChkUseTypeFromValue(v string) (*ChkUseType, error)

NewChkUseTypeFromValue returns a pointer to a valid ChkUseType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (ChkUseType) IsValid 

func (v ChkUseType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (ChkUseType) Ptr 

func (v ChkUseType) Ptr() *ChkUseType

Ptr returns reference to chk_use_type value

func (*ChkUseType) UnmarshalJSON 

func (v *ChkUseType) UnmarshalJSON(src []byte) error

type CmpScheduleType 

type CmpScheduleType string

CmpScheduleType How the campaign should be scheduled. Only value available today is `immediate`. 

const (
	CMPSCHEDULETYPE_IMMEDIATE CmpScheduleType = "immediate"
)

List of cmp_schedule_type

func NewCmpScheduleTypeFromValue 

func NewCmpScheduleTypeFromValue(v string) (*CmpScheduleType, error)

NewCmpScheduleTypeFromValue returns a pointer to a valid CmpScheduleType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (CmpScheduleType) IsValid 

func (v CmpScheduleType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (CmpScheduleType) Ptr 

func (v CmpScheduleType) Ptr() *CmpScheduleType

Ptr returns reference to cmp_schedule_type value

func (*CmpScheduleType) UnmarshalJSON 

func (v *CmpScheduleType) UnmarshalJSON(src []byte) error

type CmpUseType 

type CmpUseType string

CmpUseType The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). 

const (
	CMPUSETYPE_MARKETING   CmpUseType = "marketing"
	CMPUSETYPE_OPERATIONAL CmpUseType = "operational"
	CMPUSETYPE_NULL        CmpUseType = "null"
)

List of cmp_use_type

func NewCmpUseTypeFromValue 

func NewCmpUseTypeFromValue(v string) (*CmpUseType, error)

NewCmpUseTypeFromValue returns a pointer to a valid CmpUseType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (CmpUseType) IsValid 

func (v CmpUseType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (CmpUseType) Ptr 

func (v CmpUseType) Ptr() *CmpUseType

Ptr returns reference to cmp_use_type value

func (*CmpUseType) UnmarshalJSON 

func (v *CmpUseType) UnmarshalJSON(src []byte) error

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type CountryExtended 

type CountryExtended string

CountryExtended Must be a 2 letter country short-name code (ISO 3166). 

const (
	COUNTRYEXTENDED_EMPTY CountryExtended = ""
	COUNTRYEXTENDED_AD    CountryExtended = "AD"
	COUNTRYEXTENDED_AE    CountryExtended = "AE"
	COUNTRYEXTENDED_AF    CountryExtended = "AF"
	COUNTRYEXTENDED_AG    CountryExtended = "AG"
	COUNTRYEXTENDED_AI    CountryExtended = "AI"
	COUNTRYEXTENDED_AL    CountryExtended = "AL"
	COUNTRYEXTENDED_AN    CountryExtended = "AN"
	COUNTRYEXTENDED_AO    CountryExtended = "AO"
	COUNTRYEXTENDED_AQ    CountryExtended = "AQ"
	COUNTRYEXTENDED_AR    CountryExtended = "AR"
	COUNTRYEXTENDED_AT    CountryExtended = "AT"
	COUNTRYEXTENDED_AU    CountryExtended = "AU"
	COUNTRYEXTENDED_AW    CountryExtended = "AW"
	COUNTRYEXTENDED_AZ    CountryExtended = "AZ"
	COUNTRYEXTENDED_BA    CountryExtended = "BA"
	COUNTRYEXTENDED_BB    CountryExtended = "BB"
	COUNTRYEXTENDED_BD    CountryExtended = "BD"
	COUNTRYEXTENDED_BE    CountryExtended = "BE"
	COUNTRYEXTENDED_BF    CountryExtended = "BF"
	COUNTRYEXTENDED_BG    CountryExtended = "BG"
	COUNTRYEXTENDED_BH    CountryExtended = "BH"
	COUNTRYEXTENDED_BI    CountryExtended = "BI"
	COUNTRYEXTENDED_BJ    CountryExtended = "BJ"
	COUNTRYEXTENDED_BM    CountryExtended = "BM"
	COUNTRYEXTENDED_BN    CountryExtended = "BN"
	COUNTRYEXTENDED_BO    CountryExtended = "BO"
	COUNTRYEXTENDED_BQ    CountryExtended = "BQ"
	COUNTRYEXTENDED_BR    CountryExtended = "BR"
	COUNTRYEXTENDED_BS    CountryExtended = "BS"
	COUNTRYEXTENDED_BT    CountryExtended = "BT"
	COUNTRYEXTENDED_BW    CountryExtended = "BW"
	COUNTRYEXTENDED_BY    CountryExtended = "BY"
	COUNTRYEXTENDED_BZ    CountryExtended = "BZ"
	COUNTRYEXTENDED_CA    CountryExtended = "CA"
	COUNTRYEXTENDED_CD    CountryExtended = "CD"
	COUNTRYEXTENDED_CG    CountryExtended = "CG"
	COUNTRYEXTENDED_CH    CountryExtended = "CH"
	COUNTRYEXTENDED_CI    CountryExtended = "CI"
	COUNTRYEXTENDED_CK    CountryExtended = "CK"
	COUNTRYEXTENDED_CL    CountryExtended = "CL"
	COUNTRYEXTENDED_CM    CountryExtended = "CM"
	COUNTRYEXTENDED_CN    CountryExtended = "CN"
	COUNTRYEXTENDED_CO    CountryExtended = "CO"
	COUNTRYEXTENDED_CR    CountryExtended = "CR"
	COUNTRYEXTENDED_CS    CountryExtended = "CS"
	COUNTRYEXTENDED_CU    CountryExtended = "CU"
	COUNTRYEXTENDED_CV    CountryExtended = "CV"
	COUNTRYEXTENDED_CW    CountryExtended = "CW"
	COUNTRYEXTENDED_CY    CountryExtended = "CY"
	COUNTRYEXTENDED_CZ    CountryExtended = "CZ"
	COUNTRYEXTENDED_DE    CountryExtended = "DE"
	COUNTRYEXTENDED_DJ    CountryExtended = "DJ"
	COUNTRYEXTENDED_DK    CountryExtended = "DK"
	COUNTRYEXTENDED_DM    CountryExtended = "DM"
	COUNTRYEXTENDED_DO    CountryExtended = "DO"
	COUNTRYEXTENDED_DZ    CountryExtended = "DZ"
	COUNTRYEXTENDED_EC    CountryExtended = "EC"
	COUNTRYEXTENDED_EE    CountryExtended = "EE"
	COUNTRYEXTENDED_EG    CountryExtended = "EG"
	COUNTRYEXTENDED_EH    CountryExtended = "EH"
	COUNTRYEXTENDED_ER    CountryExtended = "ER"
	COUNTRYEXTENDED_ES    CountryExtended = "ES"
	COUNTRYEXTENDED_ET    CountryExtended = "ET"
	COUNTRYEXTENDED_FI    CountryExtended = "FI"
	COUNTRYEXTENDED_FJ    CountryExtended = "FJ"
	COUNTRYEXTENDED_FK    CountryExtended = "FK"
	COUNTRYEXTENDED_FO    CountryExtended = "FO"
	COUNTRYEXTENDED_FR    CountryExtended = "FR"
	COUNTRYEXTENDED_GA    CountryExtended = "GA"
	COUNTRYEXTENDED_GB    CountryExtended = "GB"
	COUNTRYEXTENDED_GD    CountryExtended = "GD"
	COUNTRYEXTENDED_GE    CountryExtended = "GE"
	COUNTRYEXTENDED_GH    CountryExtended = "GH"
	COUNTRYEXTENDED_GI    CountryExtended = "GI"
	COUNTRYEXTENDED_GL    CountryExtended = "GL"
	COUNTRYEXTENDED_GM    CountryExtended = "GM"
	COUNTRYEXTENDED_GN    CountryExtended = "GN"
	COUNTRYEXTENDED_GQ    CountryExtended = "GQ"
	COUNTRYEXTENDED_GR    CountryExtended = "GR"
	COUNTRYEXTENDED_GS    CountryExtended = "GS"
	COUNTRYEXTENDED_GT    CountryExtended = "GT"
	COUNTRYEXTENDED_GW    CountryExtended = "GW"
	COUNTRYEXTENDED_GY    CountryExtended = "GY"
	COUNTRYEXTENDED_HK    CountryExtended = "HK"
	COUNTRYEXTENDED_HN    CountryExtended = "HN"
	COUNTRYEXTENDED_HR    CountryExtended = "HR"
	COUNTRYEXTENDED_HT    CountryExtended = "HT"
	COUNTRYEXTENDED_HU    CountryExtended = "HU"
	COUNTRYEXTENDED_ID    CountryExtended = "ID"
	COUNTRYEXTENDED_IE    CountryExtended = "IE"
	COUNTRYEXTENDED_IL    CountryExtended = "IL"
	COUNTRYEXTENDED_IN    CountryExtended = "IN"
	COUNTRYEXTENDED_IO    CountryExtended = "IO"
	COUNTRYEXTENDED_IQ    CountryExtended = "IQ"
	COUNTRYEXTENDED_IR    CountryExtended = "IR"
	COUNTRYEXTENDED_IS    CountryExtended = "IS"
	COUNTRYEXTENDED_IT    CountryExtended = "IT"
	COUNTRYEXTENDED_JM    CountryExtended = "JM"
	COUNTRYEXTENDED_JO    CountryExtended = "JO"
	COUNTRYEXTENDED_JP    CountryExtended = "JP"
	COUNTRYEXTENDED_KE    CountryExtended = "KE"
	COUNTRYEXTENDED_KG    CountryExtended = "KG"
	COUNTRYEXTENDED_KH    CountryExtended = "KH"
	COUNTRYEXTENDED_KI    CountryExtended = "KI"
	COUNTRYEXTENDED_KM    CountryExtended = "KM"
	COUNTRYEXTENDED_KN    CountryExtended = "KN"
	COUNTRYEXTENDED_KP    CountryExtended = "KP"
	COUNTRYEXTENDED_KR    CountryExtended = "KR"
	COUNTRYEXTENDED_KW    CountryExtended = "KW"
	COUNTRYEXTENDED_KY    CountryExtended = "KY"
	COUNTRYEXTENDED_KZ    CountryExtended = "KZ"
	COUNTRYEXTENDED_LA    CountryExtended = "LA"
	COUNTRYEXTENDED_LB    CountryExtended = "LB"
	COUNTRYEXTENDED_LC    CountryExtended = "LC"
	COUNTRYEXTENDED_LI    CountryExtended = "LI"
	COUNTRYEXTENDED_LK    CountryExtended = "LK"
	COUNTRYEXTENDED_LR    CountryExtended = "LR"
	COUNTRYEXTENDED_LS    CountryExtended = "LS"
	COUNTRYEXTENDED_LT    CountryExtended = "LT"
	COUNTRYEXTENDED_LU    CountryExtended = "LU"
	COUNTRYEXTENDED_LV    CountryExtended = "LV"
	COUNTRYEXTENDED_LY    CountryExtended = "LY"
	COUNTRYEXTENDED_MA    CountryExtended = "MA"
	COUNTRYEXTENDED_MC    CountryExtended = "MC"
	COUNTRYEXTENDED_MD    CountryExtended = "MD"
	COUNTRYEXTENDED_ME    CountryExtended = "ME"
	COUNTRYEXTENDED_MG    CountryExtended = "MG"
	COUNTRYEXTENDED_MK    CountryExtended = "MK"
	COUNTRYEXTENDED_ML    CountryExtended = "ML"
	COUNTRYEXTENDED_MM    CountryExtended = "MM"
	COUNTRYEXTENDED_MN    CountryExtended = "MN"
	COUNTRYEXTENDED_MO    CountryExtended = "MO"
	COUNTRYEXTENDED_MR    CountryExtended = "MR"
	COUNTRYEXTENDED_MS    CountryExtended = "MS"
	COUNTRYEXTENDED_MT    CountryExtended = "MT"
	COUNTRYEXTENDED_MU    CountryExtended = "MU"
	COUNTRYEXTENDED_MV    CountryExtended = "MV"
	COUNTRYEXTENDED_MW    CountryExtended = "MW"
	COUNTRYEXTENDED_MX    CountryExtended = "MX"
	COUNTRYEXTENDED_MY    CountryExtended = "MY"
	COUNTRYEXTENDED_MZ    CountryExtended = "MZ"
	COUNTRYEXTENDED_NA    CountryExtended = "NA"
	COUNTRYEXTENDED_NE    CountryExtended = "NE"
	COUNTRYEXTENDED_NF    CountryExtended = "NF"
	COUNTRYEXTENDED_NG    CountryExtended = "NG"
	COUNTRYEXTENDED_NI    CountryExtended = "NI"
	COUNTRYEXTENDED_NL    CountryExtended = "NL"
	COUNTRYEXTENDED_NO    CountryExtended = "NO"
	COUNTRYEXTENDED_NP    CountryExtended = "NP"
	COUNTRYEXTENDED_NR    CountryExtended = "NR"
	COUNTRYEXTENDED_NU    CountryExtended = "NU"
	COUNTRYEXTENDED_NZ    CountryExtended = "NZ"
	COUNTRYEXTENDED_OM    CountryExtended = "OM"
	COUNTRYEXTENDED_PA    CountryExtended = "PA"
	COUNTRYEXTENDED_PE    CountryExtended = "PE"
	COUNTRYEXTENDED_PG    CountryExtended = "PG"
	COUNTRYEXTENDED_PH    CountryExtended = "PH"
	COUNTRYEXTENDED_PK    CountryExtended = "PK"
	COUNTRYEXTENDED_PL    CountryExtended = "PL"
	COUNTRYEXTENDED_PN    CountryExtended = "PN"
	COUNTRYEXTENDED_PT    CountryExtended = "PT"
	COUNTRYEXTENDED_PY    CountryExtended = "PY"
	COUNTRYEXTENDED_QA    CountryExtended = "QA"
	COUNTRYEXTENDED_RO    CountryExtended = "RO"
	COUNTRYEXTENDED_RS    CountryExtended = "RS"
	COUNTRYEXTENDED_RU    CountryExtended = "RU"
	COUNTRYEXTENDED_RW    CountryExtended = "RW"
	COUNTRYEXTENDED_SA    CountryExtended = "SA"
	COUNTRYEXTENDED_SB    CountryExtended = "SB"
	COUNTRYEXTENDED_SC    CountryExtended = "SC"
	COUNTRYEXTENDED_SD    CountryExtended = "SD"
	COUNTRYEXTENDED_SE    CountryExtended = "SE"
	COUNTRYEXTENDED_SG    CountryExtended = "SG"
	COUNTRYEXTENDED_SH    CountryExtended = "SH"
	COUNTRYEXTENDED_SI    CountryExtended = "SI"
	COUNTRYEXTENDED_SK    CountryExtended = "SK"
	COUNTRYEXTENDED_SL    CountryExtended = "SL"
	COUNTRYEXTENDED_SM    CountryExtended = "SM"
	COUNTRYEXTENDED_SN    CountryExtended = "SN"
	COUNTRYEXTENDED_SO    CountryExtended = "SO"
	COUNTRYEXTENDED_SR    CountryExtended = "SR"
	COUNTRYEXTENDED_SS    CountryExtended = "SS"
	COUNTRYEXTENDED_ST    CountryExtended = "ST"
	COUNTRYEXTENDED_SV    CountryExtended = "SV"
	COUNTRYEXTENDED_SX    CountryExtended = "SX"
	COUNTRYEXTENDED_SY    CountryExtended = "SY"
	COUNTRYEXTENDED_SZ    CountryExtended = "SZ"
	COUNTRYEXTENDED_TC    CountryExtended = "TC"
	COUNTRYEXTENDED_TD    CountryExtended = "TD"
	COUNTRYEXTENDED_TG    CountryExtended = "TG"
	COUNTRYEXTENDED_TH    CountryExtended = "TH"
	COUNTRYEXTENDED_TJ    CountryExtended = "TJ"
	COUNTRYEXTENDED_TK    CountryExtended = "TK"
	COUNTRYEXTENDED_TL    CountryExtended = "TL"
	COUNTRYEXTENDED_TM    CountryExtended = "TM"
	COUNTRYEXTENDED_TN    CountryExtended = "TN"
	COUNTRYEXTENDED_TO    CountryExtended = "TO"
	COUNTRYEXTENDED_TR    CountryExtended = "TR"
	COUNTRYEXTENDED_TT    CountryExtended = "TT"
	COUNTRYEXTENDED_TV    CountryExtended = "TV"
	COUNTRYEXTENDED_TW    CountryExtended = "TW"
	COUNTRYEXTENDED_TZ    CountryExtended = "TZ"
	COUNTRYEXTENDED_UA    CountryExtended = "UA"
	COUNTRYEXTENDED_UG    CountryExtended = "UG"
	COUNTRYEXTENDED_US    CountryExtended = "US"
	COUNTRYEXTENDED_UY    CountryExtended = "UY"
	COUNTRYEXTENDED_UZ    CountryExtended = "UZ"
	COUNTRYEXTENDED_VA    CountryExtended = "VA"
	COUNTRYEXTENDED_VC    CountryExtended = "VC"
	COUNTRYEXTENDED_VE    CountryExtended = "VE"
	COUNTRYEXTENDED_VG    CountryExtended = "VG"
	COUNTRYEXTENDED_VN    CountryExtended = "VN"
	COUNTRYEXTENDED_VU    CountryExtended = "VU"
	COUNTRYEXTENDED_WS    CountryExtended = "WS"
	COUNTRYEXTENDED_YE    CountryExtended = "YE"
	COUNTRYEXTENDED_ZA    CountryExtended = "ZA"
	COUNTRYEXTENDED_ZM    CountryExtended = "ZM"
	COUNTRYEXTENDED_ZW    CountryExtended = "ZW"
)

List of country_extended

func NewCountryExtendedFromValue 

func NewCountryExtendedFromValue(v string) (*CountryExtended, error)

NewCountryExtendedFromValue returns a pointer to a valid CountryExtended for the value passed as argument, or an error if the value passed is not allowed by the enum

func (CountryExtended) IsValid 

func (v CountryExtended) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (CountryExtended) Ptr 

func (v CountryExtended) Ptr() *CountryExtended

Ptr returns reference to country_extended value

func (*CountryExtended) UnmarshalJSON 

func (v *CountryExtended) UnmarshalJSON(src []byte) error

type CountryExtendedExpanded 

type CountryExtendedExpanded string

CountryExtendedExpanded Full name of country 

const (
	COUNTRYEXTENDEDEXPANDED_EMPTY                                        CountryExtendedExpanded = ""
	COUNTRYEXTENDEDEXPANDED_AFGHANISTAN                                  CountryExtendedExpanded = "AFGHANISTAN"
	COUNTRYEXTENDEDEXPANDED_ALBANIA                                      CountryExtendedExpanded = "ALBANIA"
	COUNTRYEXTENDEDEXPANDED_ALGERIA                                      CountryExtendedExpanded = "ALGERIA"
	COUNTRYEXTENDEDEXPANDED_AMERICAN_SAMOA                               CountryExtendedExpanded = "AMERICAN SAMOA"
	COUNTRYEXTENDEDEXPANDED_ANDORRA                                      CountryExtendedExpanded = "ANDORRA"
	COUNTRYEXTENDEDEXPANDED_ANGOLA                                       CountryExtendedExpanded = "ANGOLA"
	COUNTRYEXTENDEDEXPANDED_ANGUILLA                                     CountryExtendedExpanded = "ANGUILLA"
	COUNTRYEXTENDEDEXPANDED_ANTARCTICA                                   CountryExtendedExpanded = "ANTARCTICA"
	COUNTRYEXTENDEDEXPANDED_ANTIGUA_AND_BARBUDA                          CountryExtendedExpanded = "ANTIGUA AND BARBUDA"
	COUNTRYEXTENDEDEXPANDED_ARGENTINA                                    CountryExtendedExpanded = "ARGENTINA"
	COUNTRYEXTENDEDEXPANDED_ARUBA                                        CountryExtendedExpanded = "ARUBA"
	COUNTRYEXTENDEDEXPANDED_AUSTRALIA                                    CountryExtendedExpanded = "AUSTRALIA"
	COUNTRYEXTENDEDEXPANDED_AUSTRIA                                      CountryExtendedExpanded = "AUSTRIA"
	COUNTRYEXTENDEDEXPANDED_AZERBAIJAN                                   CountryExtendedExpanded = "AZERBAIJAN"
	COUNTRYEXTENDEDEXPANDED_BAHRAIN                                      CountryExtendedExpanded = "BAHRAIN"
	COUNTRYEXTENDEDEXPANDED_BANGLADESH                                   CountryExtendedExpanded = "BANGLADESH"
	COUNTRYEXTENDEDEXPANDED_BARBADOS                                     CountryExtendedExpanded = "BARBADOS"
	COUNTRYEXTENDEDEXPANDED_BELARUS                                      CountryExtendedExpanded = "BELARUS"
	COUNTRYEXTENDEDEXPANDED_BELGIUM                                      CountryExtendedExpanded = "BELGIUM"
	COUNTRYEXTENDEDEXPANDED_BELIZE                                       CountryExtendedExpanded = "BELIZE"
	COUNTRYEXTENDEDEXPANDED_BENIN                                        CountryExtendedExpanded = "BENIN"
	COUNTRYEXTENDEDEXPANDED_BERMUDA                                      CountryExtendedExpanded = "BERMUDA"
	COUNTRYEXTENDEDEXPANDED_BHUTAN                                       CountryExtendedExpanded = "BHUTAN"
	COUNTRYEXTENDEDEXPANDED_BOLIVIA__PLURINATIONAL_STATE_OF              CountryExtendedExpanded = "BOLIVIA (PLURINATIONAL STATE OF)"
	COUNTRYEXTENDEDEXPANDED_BONAIRE_SAINT_EUSTATIUS_AND_SABA             CountryExtendedExpanded = "BONAIRE, SAINT EUSTATIUS AND SABA"
	COUNTRYEXTENDEDEXPANDED_BOSNIA_AND_HERZEGOVINA                       CountryExtendedExpanded = "BOSNIA AND HERZEGOVINA"
	COUNTRYEXTENDEDEXPANDED_BOTSWANA                                     CountryExtendedExpanded = "BOTSWANA"
	COUNTRYEXTENDEDEXPANDED_BRAZIL                                       CountryExtendedExpanded = "BRAZIL"
	COUNTRYEXTENDEDEXPANDED_BRITISH_INDIAN_OCEAN_TERRITORY               CountryExtendedExpanded = "BRITISH INDIAN OCEAN TERRITORY"
	COUNTRYEXTENDEDEXPANDED_BRITISH_VIRGIN_ISLANDS                       CountryExtendedExpanded = "BRITISH VIRGIN ISLANDS"
	COUNTRYEXTENDEDEXPANDED_BRUNEI_DARUSSALAM                            CountryExtendedExpanded = "BRUNEI DARUSSALAM"
	COUNTRYEXTENDEDEXPANDED_BULGARIA                                     CountryExtendedExpanded = "BULGARIA"
	COUNTRYEXTENDEDEXPANDED_BURKINA_FASO                                 CountryExtendedExpanded = "BURKINA FASO"
	COUNTRYEXTENDEDEXPANDED_BURUNDI                                      CountryExtendedExpanded = "BURUNDI"
	COUNTRYEXTENDEDEXPANDED_CABO_VERDE                                   CountryExtendedExpanded = "CABO VERDE"
	COUNTRYEXTENDEDEXPANDED_CAMBODIA                                     CountryExtendedExpanded = "CAMBODIA"
	COUNTRYEXTENDEDEXPANDED_CAMEROON                                     CountryExtendedExpanded = "CAMEROON"
	COUNTRYEXTENDEDEXPANDED_CANADA                                       CountryExtendedExpanded = "CANADA"
	COUNTRYEXTENDEDEXPANDED_CAYMAN_ISLANDS                               CountryExtendedExpanded = "CAYMAN ISLANDS"
	COUNTRYEXTENDEDEXPANDED_CENTRAL_AFRICAN_REPUBLIC                     CountryExtendedExpanded = "CENTRAL AFRICAN REPUBLIC"
	COUNTRYEXTENDEDEXPANDED_CHAD                                         CountryExtendedExpanded = "CHAD"
	COUNTRYEXTENDEDEXPANDED_CHILE                                        CountryExtendedExpanded = "CHILE"
	COUNTRYEXTENDEDEXPANDED_CHINA                                        CountryExtendedExpanded = "CHINA"
	COUNTRYEXTENDEDEXPANDED_COLOMBIA                                     CountryExtendedExpanded = "COLOMBIA"
	COUNTRYEXTENDEDEXPANDED_COMOROS                                      CountryExtendedExpanded = "COMOROS"
	COUNTRYEXTENDEDEXPANDED_CONGO                                        CountryExtendedExpanded = "CONGO"
	COUNTRYEXTENDEDEXPANDED_CONGO_DEMOCRATIC_REPUBLIC_OF_THE             CountryExtendedExpanded = "CONGO, DEMOCRATIC REPUBLIC OF THE"
	COUNTRYEXTENDEDEXPANDED_COOK_ISLANDS                                 CountryExtendedExpanded = "COOK ISLANDS"
	COUNTRYEXTENDEDEXPANDED_COSTA_RICA                                   CountryExtendedExpanded = "COSTA RICA"
	COUNTRYEXTENDEDEXPANDED_CTE_DIVOIRE                                  CountryExtendedExpanded = "CÔTE D`IVOIRE"
	COUNTRYEXTENDEDEXPANDED_CROATIA                                      CountryExtendedExpanded = "CROATIA"
	COUNTRYEXTENDEDEXPANDED_CUBA                                         CountryExtendedExpanded = "CUBA"
	COUNTRYEXTENDEDEXPANDED_CURAAO                                       CountryExtendedExpanded = "CURAÇAO"
	COUNTRYEXTENDEDEXPANDED_CYPRUS                                       CountryExtendedExpanded = "CYPRUS"
	COUNTRYEXTENDEDEXPANDED_CZECH_REPUBLIC                               CountryExtendedExpanded = "CZECH REPUBLIC"
	COUNTRYEXTENDEDEXPANDED_DENMARK                                      CountryExtendedExpanded = "DENMARK"
	COUNTRYEXTENDEDEXPANDED_DJIBOUTI                                     CountryExtendedExpanded = "DJIBOUTI"
	COUNTRYEXTENDEDEXPANDED_DOMINICA                                     CountryExtendedExpanded = "DOMINICA"
	COUNTRYEXTENDEDEXPANDED_DOMINICAN_REPUBLIC                           CountryExtendedExpanded = "DOMINICAN REPUBLIC"
	COUNTRYEXTENDEDEXPANDED_ECUADOR                                      CountryExtendedExpanded = "ECUADOR"
	COUNTRYEXTENDEDEXPANDED_EGYPT                                        CountryExtendedExpanded = "EGYPT"
	COUNTRYEXTENDEDEXPANDED_EL_SALVADOR                                  CountryExtendedExpanded = "EL SALVADOR"
	COUNTRYEXTENDEDEXPANDED_EQUATORIAL_GUINEA                            CountryExtendedExpanded = "EQUATORIAL GUINEA"
	COUNTRYEXTENDEDEXPANDED_ERITREA                                      CountryExtendedExpanded = "ERITREA"
	COUNTRYEXTENDEDEXPANDED_ESTONIA                                      CountryExtendedExpanded = "ESTONIA"
	COUNTRYEXTENDEDEXPANDED_ESWATINI                                     CountryExtendedExpanded = "ESWATINI"
	COUNTRYEXTENDEDEXPANDED_ETHIOPIA                                     CountryExtendedExpanded = "ETHIOPIA"
	COUNTRYEXTENDEDEXPANDED_FALKLAND_ISLANDS__MALVINAS                   CountryExtendedExpanded = "FALKLAND ISLANDS (MALVINAS)"
	COUNTRYEXTENDEDEXPANDED_FAROE_ISLANDS                                CountryExtendedExpanded = "FAROE ISLANDS"
	COUNTRYEXTENDEDEXPANDED_FIJI                                         CountryExtendedExpanded = "FIJI"
	COUNTRYEXTENDEDEXPANDED_FINLAND                                      CountryExtendedExpanded = "FINLAND"
	COUNTRYEXTENDEDEXPANDED_FRANCE                                       CountryExtendedExpanded = "FRANCE"
	COUNTRYEXTENDEDEXPANDED_GABON                                        CountryExtendedExpanded = "GABON"
	COUNTRYEXTENDEDEXPANDED_GAMBIA                                       CountryExtendedExpanded = "GAMBIA"
	COUNTRYEXTENDEDEXPANDED_GEORGIA                                      CountryExtendedExpanded = "GEORGIA"
	COUNTRYEXTENDEDEXPANDED_GERMANY                                      CountryExtendedExpanded = "GERMANY"
	COUNTRYEXTENDEDEXPANDED_GHANA                                        CountryExtendedExpanded = "GHANA"
	COUNTRYEXTENDEDEXPANDED_GIBRALTAR                                    CountryExtendedExpanded = "GIBRALTAR"
	COUNTRYEXTENDEDEXPANDED_GREECE                                       CountryExtendedExpanded = "GREECE"
	COUNTRYEXTENDEDEXPANDED_GREENLAND                                    CountryExtendedExpanded = "GREENLAND"
	COUNTRYEXTENDEDEXPANDED_GRENADA                                      CountryExtendedExpanded = "GRENADA"
	COUNTRYEXTENDEDEXPANDED_GUATEMALA                                    CountryExtendedExpanded = "GUATEMALA"
	COUNTRYEXTENDEDEXPANDED_GUINEA                                       CountryExtendedExpanded = "GUINEA"
	COUNTRYEXTENDEDEXPANDED_GUINEA_BISSAU                                CountryExtendedExpanded = "GUINEA-BISSAU"
	COUNTRYEXTENDEDEXPANDED_GUYANA                                       CountryExtendedExpanded = "GUYANA"
	COUNTRYEXTENDEDEXPANDED_HAITI                                        CountryExtendedExpanded = "HAITI"
	COUNTRYEXTENDEDEXPANDED_HOLY_SEE                                     CountryExtendedExpanded = "HOLY SEE"
	COUNTRYEXTENDEDEXPANDED_HONDURAS                                     CountryExtendedExpanded = "HONDURAS"
	COUNTRYEXTENDEDEXPANDED_HONG_KONG                                    CountryExtendedExpanded = "HONG KONG"
	COUNTRYEXTENDEDEXPANDED_HUNGARY                                      CountryExtendedExpanded = "HUNGARY"
	COUNTRYEXTENDEDEXPANDED_ICELAND                                      CountryExtendedExpanded = "ICELAND"
	COUNTRYEXTENDEDEXPANDED_INDIA                                        CountryExtendedExpanded = "INDIA"
	COUNTRYEXTENDEDEXPANDED_INDONESIA                                    CountryExtendedExpanded = "INDONESIA"
	COUNTRYEXTENDEDEXPANDED_IRAN__ISLAMIC_REPUBLIC_OF                    CountryExtendedExpanded = "IRAN (ISLAMIC REPUBLIC OF)"
	COUNTRYEXTENDEDEXPANDED_IRAQ                                         CountryExtendedExpanded = "IRAQ"
	COUNTRYEXTENDEDEXPANDED_IRELAND                                      CountryExtendedExpanded = "IRELAND"
	COUNTRYEXTENDEDEXPANDED_ISRAEL                                       CountryExtendedExpanded = "ISRAEL"
	COUNTRYEXTENDEDEXPANDED_ITALY                                        CountryExtendedExpanded = "ITALY"
	COUNTRYEXTENDEDEXPANDED_JAMAICA                                      CountryExtendedExpanded = "JAMAICA"
	COUNTRYEXTENDEDEXPANDED_JAPAN                                        CountryExtendedExpanded = "JAPAN"
	COUNTRYEXTENDEDEXPANDED_JORDAN                                       CountryExtendedExpanded = "JORDAN"
	COUNTRYEXTENDEDEXPANDED_KAZAKHSTAN                                   CountryExtendedExpanded = "KAZAKHSTAN"
	COUNTRYEXTENDEDEXPANDED_KENYA                                        CountryExtendedExpanded = "KENYA"
	COUNTRYEXTENDEDEXPANDED_KIRIBATI                                     CountryExtendedExpanded = "KIRIBATI"
	COUNTRYEXTENDEDEXPANDED_KOREA__DEMOCRATIC_PEOPLES_REPUBLIC_OF        CountryExtendedExpanded = "KOREA (DEMOCRATIC PEOPLE’S REPUBLIC OF)"
	COUNTRYEXTENDEDEXPANDED_KOREA_REPUBLIC_OF                            CountryExtendedExpanded = "KOREA, REPUBLIC OF"
	COUNTRYEXTENDEDEXPANDED_KUWAIT                                       CountryExtendedExpanded = "KUWAIT"
	COUNTRYEXTENDEDEXPANDED_KYRGYZSTAN                                   CountryExtendedExpanded = "KYRGYZSTAN"
	COUNTRYEXTENDEDEXPANDED_LAO_PEOPLES_DEMOCRATIC_REPUBLIC              CountryExtendedExpanded = "LAO PEOPLE’S DEMOCRATIC REPUBLIC"
	COUNTRYEXTENDEDEXPANDED_LATVIA                                       CountryExtendedExpanded = "LATVIA"
	COUNTRYEXTENDEDEXPANDED_LEBANON                                      CountryExtendedExpanded = "LEBANON"
	COUNTRYEXTENDEDEXPANDED_LESOTHO                                      CountryExtendedExpanded = "LESOTHO"
	COUNTRYEXTENDEDEXPANDED_LIBERIA                                      CountryExtendedExpanded = "LIBERIA"
	COUNTRYEXTENDEDEXPANDED_LIBYA                                        CountryExtendedExpanded = "LIBYA"
	COUNTRYEXTENDEDEXPANDED_LIECHTENSTEIN                                CountryExtendedExpanded = "LIECHTENSTEIN"
	COUNTRYEXTENDEDEXPANDED_LITHUANIA                                    CountryExtendedExpanded = "LITHUANIA"
	COUNTRYEXTENDEDEXPANDED_LUXEMBOURG                                   CountryExtendedExpanded = "LUXEMBOURG"
	COUNTRYEXTENDEDEXPANDED_MACAO                                        CountryExtendedExpanded = "MACAO"
	COUNTRYEXTENDEDEXPANDED_MACEDONIA                                    CountryExtendedExpanded = "MACEDONIA"
	COUNTRYEXTENDEDEXPANDED_MADAGASCAR                                   CountryExtendedExpanded = "MADAGASCAR"
	COUNTRYEXTENDEDEXPANDED_MALAWI                                       CountryExtendedExpanded = "MALAWI"
	COUNTRYEXTENDEDEXPANDED_MALAYSIA                                     CountryExtendedExpanded = "MALAYSIA"
	COUNTRYEXTENDEDEXPANDED_MALDIVES                                     CountryExtendedExpanded = "MALDIVES"
	COUNTRYEXTENDEDEXPANDED_MALI                                         CountryExtendedExpanded = "MALI"
	COUNTRYEXTENDEDEXPANDED_MALTA                                        CountryExtendedExpanded = "MALTA"
	COUNTRYEXTENDEDEXPANDED_MAURITANIA                                   CountryExtendedExpanded = "MAURITANIA"
	COUNTRYEXTENDEDEXPANDED_MAURITIUS                                    CountryExtendedExpanded = "MAURITIUS"
	COUNTRYEXTENDEDEXPANDED_MEXICO                                       CountryExtendedExpanded = "MEXICO"
	COUNTRYEXTENDEDEXPANDED_MOLDOVA_REPUBLIC_OF                          CountryExtendedExpanded = "MOLDOVA, REPUBLIC OF"
	COUNTRYEXTENDEDEXPANDED_MONACO                                       CountryExtendedExpanded = "MONACO"
	COUNTRYEXTENDEDEXPANDED_MONGOLIA                                     CountryExtendedExpanded = "MONGOLIA"
	COUNTRYEXTENDEDEXPANDED_MONTENEGRO                                   CountryExtendedExpanded = "MONTENEGRO"
	COUNTRYEXTENDEDEXPANDED_MONTSERRAT                                   CountryExtendedExpanded = "MONTSERRAT"
	COUNTRYEXTENDEDEXPANDED_MOROCCO                                      CountryExtendedExpanded = "MOROCCO"
	COUNTRYEXTENDEDEXPANDED_MOZAMBIQUE                                   CountryExtendedExpanded = "MOZAMBIQUE"
	COUNTRYEXTENDEDEXPANDED_MYANMAR                                      CountryExtendedExpanded = "MYANMAR"
	COUNTRYEXTENDEDEXPANDED_NAMIBIA                                      CountryExtendedExpanded = "NAMIBIA"
	COUNTRYEXTENDEDEXPANDED_NAURU                                        CountryExtendedExpanded = "NAURU"
	COUNTRYEXTENDEDEXPANDED_NEPAL                                        CountryExtendedExpanded = "NEPAL"
	COUNTRYEXTENDEDEXPANDED_NETHERLAND_ANTILLES                          CountryExtendedExpanded = "NETHERLAND ANTILLES"
	COUNTRYEXTENDEDEXPANDED_NETHERLANDS                                  CountryExtendedExpanded = "NETHERLANDS"
	COUNTRYEXTENDEDEXPANDED_NEW_ZEALAND                                  CountryExtendedExpanded = "NEW ZEALAND"
	COUNTRYEXTENDEDEXPANDED_NICARAGUA                                    CountryExtendedExpanded = "NICARAGUA"
	COUNTRYEXTENDEDEXPANDED_NIGER                                        CountryExtendedExpanded = "NIGER"
	COUNTRYEXTENDEDEXPANDED_NIGERIA                                      CountryExtendedExpanded = "NIGERIA"
	COUNTRYEXTENDEDEXPANDED_NIUE                                         CountryExtendedExpanded = "NIUE"
	COUNTRYEXTENDEDEXPANDED_NORFOLK_ISLAND                               CountryExtendedExpanded = "NORFOLK ISLAND"
	COUNTRYEXTENDEDEXPANDED_NORWAY                                       CountryExtendedExpanded = "NORWAY"
	COUNTRYEXTENDEDEXPANDED_OMAN                                         CountryExtendedExpanded = "OMAN"
	COUNTRYEXTENDEDEXPANDED_PAKISTAN                                     CountryExtendedExpanded = "PAKISTAN"
	COUNTRYEXTENDEDEXPANDED_PANAMA                                       CountryExtendedExpanded = "PANAMA"
	COUNTRYEXTENDEDEXPANDED_PAPUA_NEW_GUINEA                             CountryExtendedExpanded = "PAPUA NEW GUINEA"
	COUNTRYEXTENDEDEXPANDED_PARAGUAY                                     CountryExtendedExpanded = "PARAGUAY"
	COUNTRYEXTENDEDEXPANDED_PERU                                         CountryExtendedExpanded = "PERU"
	COUNTRYEXTENDEDEXPANDED_PHILIPPINES                                  CountryExtendedExpanded = "PHILIPPINES"
	COUNTRYEXTENDEDEXPANDED_PITCAIRN                                     CountryExtendedExpanded = "PITCAIRN"
	COUNTRYEXTENDEDEXPANDED_POLAND                                       CountryExtendedExpanded = "POLAND"
	COUNTRYEXTENDEDEXPANDED_PORTUGAL                                     CountryExtendedExpanded = "PORTUGAL"
	COUNTRYEXTENDEDEXPANDED_QATAR                                        CountryExtendedExpanded = "QATAR"
	COUNTRYEXTENDEDEXPANDED_ROMANIA                                      CountryExtendedExpanded = "ROMANIA"
	COUNTRYEXTENDEDEXPANDED_RUSSIAN_FEDERATION                           CountryExtendedExpanded = "RUSSIAN FEDERATION"
	COUNTRYEXTENDEDEXPANDED_RWANDA                                       CountryExtendedExpanded = "RWANDA"
	COUNTRYEXTENDEDEXPANDED_SAINT_HELENA                                 CountryExtendedExpanded = "SAINT HELENA"
	COUNTRYEXTENDEDEXPANDED_SAINT_KITTS_AND_NEVIS                        CountryExtendedExpanded = "SAINT KITTS AND NEVIS"
	COUNTRYEXTENDEDEXPANDED_SAINT_LUCIA                                  CountryExtendedExpanded = "SAINT LUCIA"
	COUNTRYEXTENDEDEXPANDED_SAINT_VINCENT_AND_THE_GRENADINES             CountryExtendedExpanded = "SAINT VINCENT AND THE GRENADINES"
	COUNTRYEXTENDEDEXPANDED_SAMOA                                        CountryExtendedExpanded = "SAMOA"
	COUNTRYEXTENDEDEXPANDED_SAN_MARINO                                   CountryExtendedExpanded = "SAN MARINO"
	COUNTRYEXTENDEDEXPANDED_SAO_TOME_AND_PRINCIPE                        CountryExtendedExpanded = "SAO TOME AND PRINCIPE"
	COUNTRYEXTENDEDEXPANDED_SAUDI_ARABIA                                 CountryExtendedExpanded = "SAUDI ARABIA"
	COUNTRYEXTENDEDEXPANDED_SENEGAL                                      CountryExtendedExpanded = "SENEGAL"
	COUNTRYEXTENDEDEXPANDED_SERBIA                                       CountryExtendedExpanded = "SERBIA"
	COUNTRYEXTENDEDEXPANDED_SEYCHELLES                                   CountryExtendedExpanded = "SEYCHELLES"
	COUNTRYEXTENDEDEXPANDED_SIERRA_LEONE                                 CountryExtendedExpanded = "SIERRA LEONE"
	COUNTRYEXTENDEDEXPANDED_SINGAPORE                                    CountryExtendedExpanded = "SINGAPORE"
	COUNTRYEXTENDEDEXPANDED_SINT_MAARTEN                                 CountryExtendedExpanded = "SINT MAARTEN"
	COUNTRYEXTENDEDEXPANDED_SLOVAKIA                                     CountryExtendedExpanded = "SLOVAKIA"
	COUNTRYEXTENDEDEXPANDED_SLOVENIA                                     CountryExtendedExpanded = "SLOVENIA"
	COUNTRYEXTENDEDEXPANDED_SOLOMON_ISLANDS                              CountryExtendedExpanded = "SOLOMON ISLANDS"
	COUNTRYEXTENDEDEXPANDED_SOMALIA                                      CountryExtendedExpanded = "SOMALIA"
	COUNTRYEXTENDEDEXPANDED_SOUTH_AFRICA                                 CountryExtendedExpanded = "SOUTH AFRICA"
	COUNTRYEXTENDEDEXPANDED_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS CountryExtendedExpanded = "SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS"
	COUNTRYEXTENDEDEXPANDED_SOUTH_SUDAN                                  CountryExtendedExpanded = "SOUTH SUDAN"
	COUNTRYEXTENDEDEXPANDED_SPAIN                                        CountryExtendedExpanded = "SPAIN"
	COUNTRYEXTENDEDEXPANDED_SRI_LANKA                                    CountryExtendedExpanded = "SRI LANKA"
	COUNTRYEXTENDEDEXPANDED_SUDAN                                        CountryExtendedExpanded = "SUDAN"
	COUNTRYEXTENDEDEXPANDED_SURINAME                                     CountryExtendedExpanded = "SURINAME"
	COUNTRYEXTENDEDEXPANDED_SWEDEN                                       CountryExtendedExpanded = "SWEDEN"
	COUNTRYEXTENDEDEXPANDED_SWITZERLAND                                  CountryExtendedExpanded = "SWITZERLAND"
	COUNTRYEXTENDEDEXPANDED_SYRIAN_ARAB_REPUBLIC                         CountryExtendedExpanded = "SYRIAN ARAB REPUBLIC"
	COUNTRYEXTENDEDEXPANDED_TAIWAN                                       CountryExtendedExpanded = "TAIWAN"
	COUNTRYEXTENDEDEXPANDED_TAJIKISTAN                                   CountryExtendedExpanded = "TAJIKISTAN"
	COUNTRYEXTENDEDEXPANDED_TANZANIA                                     CountryExtendedExpanded = "TANZANIA"
	COUNTRYEXTENDEDEXPANDED_THAILAND                                     CountryExtendedExpanded = "THAILAND"
	COUNTRYEXTENDEDEXPANDED_THE_BAHAMAS                                  CountryExtendedExpanded = "THE BAHAMAS"
	COUNTRYEXTENDEDEXPANDED_TIMOR_LESTE                                  CountryExtendedExpanded = "TIMOR-LESTE"
	COUNTRYEXTENDEDEXPANDED_TOGO                                         CountryExtendedExpanded = "TOGO"
	COUNTRYEXTENDEDEXPANDED_TOKELAU                                      CountryExtendedExpanded = "TOKELAU"
	COUNTRYEXTENDEDEXPANDED_TONGA                                        CountryExtendedExpanded = "TONGA"
	COUNTRYEXTENDEDEXPANDED_TRINIDAD_AND_TOBAGO                          CountryExtendedExpanded = "TRINIDAD AND TOBAGO"
	COUNTRYEXTENDEDEXPANDED_TUNISIA                                      CountryExtendedExpanded = "TUNISIA"
	COUNTRYEXTENDEDEXPANDED_TURKEY                                       CountryExtendedExpanded = "TURKEY"
	COUNTRYEXTENDEDEXPANDED_TURKMENISTAN                                 CountryExtendedExpanded = "TURKMENISTAN"
	COUNTRYEXTENDEDEXPANDED_TURKS_AND_CAICOS_ISLANDS                     CountryExtendedExpanded = "TURKS AND CAICOS ISLANDS"
	COUNTRYEXTENDEDEXPANDED_TUVALU                                       CountryExtendedExpanded = "TUVALU"
	COUNTRYEXTENDEDEXPANDED_UGANDA                                       CountryExtendedExpanded = "UGANDA"
	COUNTRYEXTENDEDEXPANDED_UKRAINE                                      CountryExtendedExpanded = "UKRAINE"
	COUNTRYEXTENDEDEXPANDED_UNITED_ARAB_EMIRATES                         CountryExtendedExpanded = "UNITED ARAB EMIRATES"
	COUNTRYEXTENDEDEXPANDED_UNITED_KINGDOM                               CountryExtendedExpanded = "UNITED KINGDOM"
	COUNTRYEXTENDEDEXPANDED_UNITED_STATES                                CountryExtendedExpanded = "UNITED STATES"
	COUNTRYEXTENDEDEXPANDED_URUGUAY                                      CountryExtendedExpanded = "URUGUAY"
	COUNTRYEXTENDEDEXPANDED_UZBEKISTAN                                   CountryExtendedExpanded = "UZBEKISTAN"
	COUNTRYEXTENDEDEXPANDED_VANUATU                                      CountryExtendedExpanded = "VANUATU"
	COUNTRYEXTENDEDEXPANDED_VENEZUELA                                    CountryExtendedExpanded = "VENEZUELA"
	COUNTRYEXTENDEDEXPANDED_VIET_NAM                                     CountryExtendedExpanded = "VIET NAM"
	COUNTRYEXTENDEDEXPANDED_WESTERN_SAHARA                               CountryExtendedExpanded = "WESTERN SAHARA"
	COUNTRYEXTENDEDEXPANDED_YEMEN                                        CountryExtendedExpanded = "YEMEN"
	COUNTRYEXTENDEDEXPANDED_ZAMBIA                                       CountryExtendedExpanded = "ZAMBIA"
	COUNTRYEXTENDEDEXPANDED_ZIMBABWE                                     CountryExtendedExpanded = "ZIMBABWE"
)

List of country_extended_expanded

func NewCountryExtendedExpandedFromValue 

func NewCountryExtendedExpandedFromValue(v string) (*CountryExtendedExpanded, error)

NewCountryExtendedExpandedFromValue returns a pointer to a valid CountryExtendedExpanded for the value passed as argument, or an error if the value passed is not allowed by the enum

func (CountryExtendedExpanded) IsValid 

func (v CountryExtendedExpanded) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (CountryExtendedExpanded) Ptr 

func (v CountryExtendedExpanded) Ptr() *CountryExtendedExpanded

Ptr returns reference to country_extended_expanded value

func (*CountryExtendedExpanded) UnmarshalJSON 

func (v *CountryExtendedExpanded) UnmarshalJSON(src []byte) error

type CreativePatch 

type CreativePatch struct {
	// Must either be an address ID or an inline object with correct address parameters.
	From interface{} `json:"from,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
}

CreativePatch struct for CreativePatch

func NewCreativePatch 

func NewCreativePatch() *CreativePatch

NewCreativePatch instantiates a new CreativePatch object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreativePatchWithDefaults 

func NewCreativePatchWithDefaults() *CreativePatch

NewCreativePatchWithDefaults instantiates a new CreativePatch object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreativePatch) GetDescription 

func (o *CreativePatch) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreativePatch) GetDescriptionOk 

func (o *CreativePatch) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativePatch) GetFrom 

func (o *CreativePatch) GetFrom() interface{}

GetFrom returns the From field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreativePatch) GetFromOk 

func (o *CreativePatch) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativePatch) GetMetadata 

func (o *CreativePatch) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*CreativePatch) GetMetadataOk 

func (o *CreativePatch) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativePatch) HasDescription 

func (o *CreativePatch) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CreativePatch) HasFrom 

func (o *CreativePatch) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*CreativePatch) HasMetadata 

func (o *CreativePatch) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (CreativePatch) MarshalJSON 

func (o CreativePatch) MarshalJSON() ([]byte, error)

func (*CreativePatch) SetDescription 

func (o *CreativePatch) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CreativePatch) SetDescriptionNil 

func (o *CreativePatch) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CreativePatch) SetFrom 

func (o *CreativePatch) SetFrom(v interface{})

SetFrom gets a reference to the given interface{} and assigns it to the From field.

func (*CreativePatch) SetMetadata 

func (o *CreativePatch) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*CreativePatch) UnsetDescription 

func (o *CreativePatch) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type CreativeResponse 

type CreativeResponse struct {
	// Unique identifier prefixed with `crv_`.
	Id *string `json:"id,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Must either be an address ID or an inline object with correct address parameters.
	From interface{} `json:"from,omitempty"`
	// Mailpiece type for the creative
	ResourceType *string `json:"resource_type,omitempty"`
	// Either PostcardDetailsReturned or LetterDetailsReturned
	Details interface{} `json:"details,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// Preview URLs associated with a creative's artwork asset(s) if the creative uses HTML templates as assets.
	TemplatePreviewUrls map[string]interface{} `json:"template_preview_urls,omitempty"`
	// A list of template preview objects if the creative uses HTML template(s) as artwork asset(s).
	TemplatePreviews []map[string]interface{} `json:"template_previews,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Array of campaigns associated with the creative ID
	Campaigns []Campaign `json:"campaigns,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified *time.Time `json:"date_modified,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

CreativeResponse struct for CreativeResponse

func NewCreativeResponse 

func NewCreativeResponse() *CreativeResponse

NewCreativeResponse instantiates a new CreativeResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreativeResponseWithDefaults 

func NewCreativeResponseWithDefaults() *CreativeResponse

NewCreativeResponseWithDefaults instantiates a new CreativeResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreativeResponse) GetCampaigns 

func (o *CreativeResponse) GetCampaigns() []Campaign

GetCampaigns returns the Campaigns field value if set, zero value otherwise.

func (*CreativeResponse) GetCampaignsOk 

func (o *CreativeResponse) GetCampaignsOk() ([]Campaign, bool)

GetCampaignsOk returns a tuple with the Campaigns field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetDateCreated 

func (o *CreativeResponse) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*CreativeResponse) GetDateCreatedOk 

func (o *CreativeResponse) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetDateModified 

func (o *CreativeResponse) GetDateModified() time.Time

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*CreativeResponse) GetDateModifiedOk 

func (o *CreativeResponse) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetDeleted 

func (o *CreativeResponse) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*CreativeResponse) GetDeletedOk 

func (o *CreativeResponse) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetDescription 

func (o *CreativeResponse) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreativeResponse) GetDescriptionOk 

func (o *CreativeResponse) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativeResponse) GetDetails 

func (o *CreativeResponse) GetDetails() interface{}

GetDetails returns the Details field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreativeResponse) GetDetailsOk 

func (o *CreativeResponse) GetDetailsOk() (*interface{}, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativeResponse) GetFrom 

func (o *CreativeResponse) GetFrom() interface{}

GetFrom returns the From field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreativeResponse) GetFromOk 

func (o *CreativeResponse) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativeResponse) GetId 

func (o *CreativeResponse) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*CreativeResponse) GetIdOk 

func (o *CreativeResponse) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetMetadata 

func (o *CreativeResponse) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*CreativeResponse) GetMetadataOk 

func (o *CreativeResponse) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetObject 

func (o *CreativeResponse) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*CreativeResponse) GetObjectOk 

func (o *CreativeResponse) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetResourceType 

func (o *CreativeResponse) GetResourceType() string

GetResourceType returns the ResourceType field value if set, zero value otherwise.

func (*CreativeResponse) GetResourceTypeOk 

func (o *CreativeResponse) GetResourceTypeOk() (*string, bool)

GetResourceTypeOk returns a tuple with the ResourceType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetTemplatePreviewUrls 

func (o *CreativeResponse) GetTemplatePreviewUrls() map[string]interface{}

GetTemplatePreviewUrls returns the TemplatePreviewUrls field value if set, zero value otherwise.

func (*CreativeResponse) GetTemplatePreviewUrlsOk 

func (o *CreativeResponse) GetTemplatePreviewUrlsOk() (map[string]interface{}, bool)

GetTemplatePreviewUrlsOk returns a tuple with the TemplatePreviewUrls field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) GetTemplatePreviews 

func (o *CreativeResponse) GetTemplatePreviews() []map[string]interface{}

GetTemplatePreviews returns the TemplatePreviews field value if set, zero value otherwise.

func (*CreativeResponse) GetTemplatePreviewsOk 

func (o *CreativeResponse) GetTemplatePreviewsOk() ([]map[string]interface{}, bool)

GetTemplatePreviewsOk returns a tuple with the TemplatePreviews field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeResponse) HasCampaigns 

func (o *CreativeResponse) HasCampaigns() bool

HasCampaigns returns a boolean if a field has been set.

func (*CreativeResponse) HasDateCreated 

func (o *CreativeResponse) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*CreativeResponse) HasDateModified 

func (o *CreativeResponse) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (*CreativeResponse) HasDeleted 

func (o *CreativeResponse) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*CreativeResponse) HasDescription 

func (o *CreativeResponse) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CreativeResponse) HasDetails 

func (o *CreativeResponse) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*CreativeResponse) HasFrom 

func (o *CreativeResponse) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*CreativeResponse) HasId 

func (o *CreativeResponse) HasId() bool

HasId returns a boolean if a field has been set.

func (*CreativeResponse) HasMetadata 

func (o *CreativeResponse) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*CreativeResponse) HasObject 

func (o *CreativeResponse) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*CreativeResponse) HasResourceType 

func (o *CreativeResponse) HasResourceType() bool

HasResourceType returns a boolean if a field has been set.

func (*CreativeResponse) HasTemplatePreviewUrls 

func (o *CreativeResponse) HasTemplatePreviewUrls() bool

HasTemplatePreviewUrls returns a boolean if a field has been set.

func (*CreativeResponse) HasTemplatePreviews 

func (o *CreativeResponse) HasTemplatePreviews() bool

HasTemplatePreviews returns a boolean if a field has been set.

func (CreativeResponse) MarshalJSON 

func (o CreativeResponse) MarshalJSON() ([]byte, error)

func (*CreativeResponse) SetCampaigns 

func (o *CreativeResponse) SetCampaigns(v []Campaign)

SetCampaigns gets a reference to the given []Campaign and assigns it to the Campaigns field.

func (*CreativeResponse) SetDateCreated 

func (o *CreativeResponse) SetDateCreated(v time.Time)

SetDateCreated gets a reference to the given time.Time and assigns it to the DateCreated field.

func (*CreativeResponse) SetDateModified 

func (o *CreativeResponse) SetDateModified(v time.Time)

SetDateModified gets a reference to the given time.Time and assigns it to the DateModified field.

func (*CreativeResponse) SetDeleted 

func (o *CreativeResponse) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*CreativeResponse) SetDescription 

func (o *CreativeResponse) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CreativeResponse) SetDescriptionNil 

func (o *CreativeResponse) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CreativeResponse) SetDetails 

func (o *CreativeResponse) SetDetails(v interface{})

SetDetails gets a reference to the given interface{} and assigns it to the Details field.

func (*CreativeResponse) SetFrom 

func (o *CreativeResponse) SetFrom(v interface{})

SetFrom gets a reference to the given interface{} and assigns it to the From field.

func (*CreativeResponse) SetId 

func (o *CreativeResponse) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*CreativeResponse) SetMetadata 

func (o *CreativeResponse) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*CreativeResponse) SetObject 

func (o *CreativeResponse) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*CreativeResponse) SetResourceType 

func (o *CreativeResponse) SetResourceType(v string)

SetResourceType gets a reference to the given string and assigns it to the ResourceType field.

func (*CreativeResponse) SetTemplatePreviewUrls 

func (o *CreativeResponse) SetTemplatePreviewUrls(v map[string]interface{})

SetTemplatePreviewUrls gets a reference to the given map[string]interface{} and assigns it to the TemplatePreviewUrls field.

func (*CreativeResponse) SetTemplatePreviews 

func (o *CreativeResponse) SetTemplatePreviews(v []map[string]interface{})

SetTemplatePreviews gets a reference to the given []map[string]interface{} and assigns it to the TemplatePreviews field.

func (*CreativeResponse) UnsetDescription 

func (o *CreativeResponse) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type CreativeWritable 

type CreativeWritable struct {
	// Must either be an address ID or an inline object with correct address parameters.
	From interface{} `json:"from"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// Mailpiece type for the creative
	ResourceType string `json:"resource_type"`
	// Unique identifier prefixed with `cmp_`.
	CampaignId string `json:"campaign_id"`
	// Either PostcardDetailsWritable or LetterDetailsWritable
	Details interface{} `json:"details,omitempty"`
	// PDF file containing the letter's formatting. Do not include for resource_type = postcard.
	File *string `json:"file,omitempty"`
	// The artwork to use as the front of your postcard. Do not include for resource_type = letter.
	Front *string `json:"front,omitempty"`
	// The artwork to use as the back of your postcard. Do not include for resource_type = letter.
	Back *string `json:"back,omitempty"`
}

CreativeWritable struct for CreativeWritable

func NewCreativeWritable 

func NewCreativeWritable(from interface{}, resourceType string, campaignId string) *CreativeWritable

NewCreativeWritable instantiates a new CreativeWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreativeWritableWithDefaults 

func NewCreativeWritableWithDefaults() *CreativeWritable

NewCreativeWritableWithDefaults instantiates a new CreativeWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreativeWritable) GetBack 

func (o *CreativeWritable) GetBack() string

GetBack returns the Back field value if set, zero value otherwise.

func (*CreativeWritable) GetBackOk 

func (o *CreativeWritable) GetBackOk() (*string, bool)

GetBackOk returns a tuple with the Back field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeWritable) GetCampaignId 

func (o *CreativeWritable) GetCampaignId() string

GetCampaignId returns the CampaignId field value

func (*CreativeWritable) GetCampaignIdOk 

func (o *CreativeWritable) GetCampaignIdOk() (*string, bool)

GetCampaignIdOk returns a tuple with the CampaignId field value and a boolean to check if the value has been set.

func (*CreativeWritable) GetDescription 

func (o *CreativeWritable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreativeWritable) GetDescriptionOk 

func (o *CreativeWritable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativeWritable) GetDetails 

func (o *CreativeWritable) GetDetails() interface{}

GetDetails returns the Details field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreativeWritable) GetDetailsOk 

func (o *CreativeWritable) GetDetailsOk() (*interface{}, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativeWritable) GetFile 

func (o *CreativeWritable) GetFile() string

GetFile returns the File field value if set, zero value otherwise.

func (*CreativeWritable) GetFileOk 

func (o *CreativeWritable) GetFileOk() (*string, bool)

GetFileOk returns a tuple with the File field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeWritable) GetFrom 

func (o *CreativeWritable) GetFrom() interface{}

GetFrom returns the From field value If the value is explicit nil, the zero value for interface{} will be returned

func (*CreativeWritable) GetFromOk 

func (o *CreativeWritable) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreativeWritable) GetFront 

func (o *CreativeWritable) GetFront() string

GetFront returns the Front field value if set, zero value otherwise.

func (*CreativeWritable) GetFrontOk 

func (o *CreativeWritable) GetFrontOk() (*string, bool)

GetFrontOk returns a tuple with the Front field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeWritable) GetMetadata 

func (o *CreativeWritable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*CreativeWritable) GetMetadataOk 

func (o *CreativeWritable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreativeWritable) GetResourceType 

func (o *CreativeWritable) GetResourceType() string

GetResourceType returns the ResourceType field value

func (*CreativeWritable) GetResourceTypeOk 

func (o *CreativeWritable) GetResourceTypeOk() (*string, bool)

GetResourceTypeOk returns a tuple with the ResourceType field value and a boolean to check if the value has been set.

func (*CreativeWritable) HasBack 

func (o *CreativeWritable) HasBack() bool

HasBack returns a boolean if a field has been set.

func (*CreativeWritable) HasDescription 

func (o *CreativeWritable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CreativeWritable) HasDetails 

func (o *CreativeWritable) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*CreativeWritable) HasFile 

func (o *CreativeWritable) HasFile() bool

HasFile returns a boolean if a field has been set.

func (*CreativeWritable) HasFront 

func (o *CreativeWritable) HasFront() bool

HasFront returns a boolean if a field has been set.

func (*CreativeWritable) HasMetadata 

func (o *CreativeWritable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (CreativeWritable) MarshalJSON 

func (o CreativeWritable) MarshalJSON() ([]byte, error)

func (*CreativeWritable) SetBack 

func (o *CreativeWritable) SetBack(v string)

SetBack gets a reference to the given string and assigns it to the Back field.

func (*CreativeWritable) SetCampaignId 

func (o *CreativeWritable) SetCampaignId(v string)

SetCampaignId sets field value

func (*CreativeWritable) SetDescription 

func (o *CreativeWritable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CreativeWritable) SetDescriptionNil 

func (o *CreativeWritable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CreativeWritable) SetDetails 

func (o *CreativeWritable) SetDetails(v interface{})

SetDetails gets a reference to the given interface{} and assigns it to the Details field.

func (*CreativeWritable) SetFile 

func (o *CreativeWritable) SetFile(v string)

SetFile gets a reference to the given string and assigns it to the File field.

func (*CreativeWritable) SetFrom 

func (o *CreativeWritable) SetFrom(v interface{})

SetFrom sets field value

func (*CreativeWritable) SetFront 

func (o *CreativeWritable) SetFront(v string)

SetFront gets a reference to the given string and assigns it to the Front field.

func (*CreativeWritable) SetMetadata 

func (o *CreativeWritable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*CreativeWritable) SetResourceType 

func (o *CreativeWritable) SetResourceType(v string)

SetResourceType sets field value

func (*CreativeWritable) UnsetDescription 

func (o *CreativeWritable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type CreativesApiService 

type CreativesApiService service

CreativesApiService CreativesApi service

func (*CreativesApiService) Create 

func (a *CreativesApiService) Create(ctx context.Context) ApiCreativeCreateRequest

CreativeCreate create

Creates a new creative with the provided properties 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreativeCreateRequest

func (*CreativesApiService) CreativeCreateExecute 

func (a *CreativesApiService) CreativeCreateExecute(r ApiCreativeCreateRequest) (*CreativeResponse, *http.Response, error)

Execute executes the request 

@return CreativeResponse

func (*CreativesApiService) CreativeRetrieveExecute 

func (a *CreativesApiService) CreativeRetrieveExecute(r ApiCreativeRetrieveRequest) (*CreativeResponse, *http.Response, error)

Execute executes the request 

@return CreativeResponse

func (*CreativesApiService) CreativeUpdateExecute 

func (a *CreativesApiService) CreativeUpdateExecute(r ApiCreativeUpdateRequest) (*CreativeResponse, *http.Response, error)

Execute executes the request 

@return CreativeResponse

func (*CreativesApiService) Get 

func (a *CreativesApiService) Get(ctx context.Context, crvId string) ApiCreativeRetrieveRequest

CreativeRetrieve get

Retrieves the details of an existing creative. You need only supply the unique creative identifier that was returned upon creative creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param crvId id of the creative
@return ApiCreativeRetrieveRequest

func (*CreativesApiService) Update 

func (a *CreativesApiService) Update(ctx context.Context, crvId string) ApiCreativeUpdateRequest

CreativeUpdate update

Update the details of an existing creative. You need only supply the unique identifier that was returned upon creative creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param crvId id of the creative
@return ApiCreativeUpdateRequest

type CustomEnvelopeReturned 

type CustomEnvelopeReturned struct {
	// The unique identifier of the custom envelope used.
	Id string `json:"id"`
	// The url of the envelope asset used.
	Url    string `json:"url"`
	Object string `json:"object"`
}

CustomEnvelopeReturned A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used.

func NewCustomEnvelopeReturned 

func NewCustomEnvelopeReturned(id string, url string, object string) *CustomEnvelopeReturned

NewCustomEnvelopeReturned instantiates a new CustomEnvelopeReturned object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCustomEnvelopeReturnedWithDefaults 

func NewCustomEnvelopeReturnedWithDefaults() *CustomEnvelopeReturned

NewCustomEnvelopeReturnedWithDefaults instantiates a new CustomEnvelopeReturned object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CustomEnvelopeReturned) GetId 

func (o *CustomEnvelopeReturned) GetId() string

GetId returns the Id field value

func (*CustomEnvelopeReturned) GetIdOk 

func (o *CustomEnvelopeReturned) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*CustomEnvelopeReturned) GetObject 

func (o *CustomEnvelopeReturned) GetObject() string

GetObject returns the Object field value

func (*CustomEnvelopeReturned) GetObjectOk 

func (o *CustomEnvelopeReturned) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*CustomEnvelopeReturned) GetUrl 

func (o *CustomEnvelopeReturned) GetUrl() string

GetUrl returns the Url field value

func (*CustomEnvelopeReturned) GetUrlOk 

func (o *CustomEnvelopeReturned) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (CustomEnvelopeReturned) MarshalJSON 

func (o CustomEnvelopeReturned) MarshalJSON() ([]byte, error)

func (*CustomEnvelopeReturned) SetId 

func (o *CustomEnvelopeReturned) SetId(v string)

SetId sets field value

func (*CustomEnvelopeReturned) SetObject 

func (o *CustomEnvelopeReturned) SetObject(v string)

SetObject sets field value

func (*CustomEnvelopeReturned) SetUrl 

func (o *CustomEnvelopeReturned) SetUrl(v string)

SetUrl sets field value

type DefaultApiService 

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) PlaceholderExecute 

func (a *DefaultApiService) PlaceholderExecute(r ApiPlaceholderRequest) (*PlaceholderModel, *http.Response, error)

Execute executes the request 

@return PlaceholderModel

func (*DefaultApiService) Placeholder_no_call 

func (a *DefaultApiService) Placeholder_no_call(ctx context.Context) ApiPlaceholderRequest

Placeholder placeholder_no_call

Don't call this. It's so that the right models can be generated. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiPlaceholderRequest

type DeliverabilityAnalysis 

type DeliverabilityAnalysis struct {
	// Result of Delivery Point Validation (DPV), which determines whether or not the address is deliverable by the USPS. Possible values are: * `Y` –– The address is deliverable by the USPS. * `S` –– The address is deliverable by removing the provided secondary unit designator. This information may be incorrect or unnecessary. * `D` –– The address is deliverable to the building's default address but is missing a secondary unit designator and/or number.   There is a chance the mail will not reach the intended recipient. * `N` –– The address is not deliverable according to the USPS, but parts of the address are valid (such as the street and ZIP code). * `”` –– This address is not deliverable. No matching street could be found within the city or ZIP code.
	DpvConfirmation string `json:"dpv_confirmation"`
	// indicates whether or not the address is [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency). Possible values are: * `Y` –– Address is CMRA-authorized. * `N` –– Address is not CMRA-authorized. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	DpvCmra string `json:"dpv_cmra"`
	// indicates that an address was once deliverable, but has become vacant and is no longer receiving deliveries. Possible values are: * `Y` –– Address is vacant. * `N` –– Address is not vacant. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	DpvVacant string `json:"dpv_vacant"`
	// Corresponds to the USPS field `dpv_no_stat`. Indicates that an address has been vacated in the recent past, and is no longer receiving deliveries. If it's been unoccupied for 90+ days, or temporarily vacant, this will be flagged. Possible values are: * `Y` –– Address is active. * `N` –– Address is not active. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	DpvActive string `json:"dpv_active"`
	// Indicates the reason why an address is vacant or no longer receiving deliveries. Possible values are: * `01` –– Address does not receive mail from the USPS directly, but is serviced by a drop address. * `02` –– Address not yet deliverable. * `03` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). * `04` –– Address is a College, Military Zone, or other type. * `05` –– Address no longer receives deliveries. * `06` –– Address is missing required secondary information. * `”` –– A DPV match is not made or the address is active.
	DpvInactiveReason string `json:"dpv_inactive_reason"`
	// Indicates a street address for which mail is delivered to a PO Box. Possible values are: * `Y` –– Address is a PO Box throwback delivery point. * `N` –– Address is not a PO Box throwback delivery point. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	DpvThrowback string `json:"dpv_throwback"`
	// Indicates whether deliveries are not performed on one or more days of the week at an address. Possible values are: * `Y` –– Mail delivery does not occur on some days of the week. * `N` –– Mail delivery occurs every day of the week. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	DpvNonDeliveryDayFlag string `json:"dpv_non_delivery_day_flag"`
	// Indicates days of the week (starting on Sunday) deliveries are not performed at an address. For example: * `YNNNNNN` –– Mail delivery does not occur on Sunday's. * `NYNNNYN` –– Mail delivery does not occur on Monday's or Friday's. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string) or address receives mail every day of the week (`deliverability_analysis[dpv_non_delivery_day_flag]` is `N` or an empty string).
	DpvNonDeliveryDayValues string `json:"dpv_non_delivery_day_values"`
	// Indicates packages to this address will not be left due to security concerns. Possible values are: * `Y` –– Address does not have a secure mailbox. * `N` –– Address has a secure mailbox. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	DpvNoSecureLocation string `json:"dpv_no_secure_location"`
	// Indicates the door of the address is not accessible for mail delivery. Possible values are: * `Y` –– Door is not accessible. * `N` –– Door is accessible. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	DpvDoorNotAccessible string `json:"dpv_door_not_accessible"`
	// An array of 2-character strings that gives more insight into how `deliverability_analysis[dpv_confirmation]` was determined. Will always include at least 1 string, and can include up to 3. For details, see [US Verification Details](#tag/US-Verification-Types).
	DpvFootnotes []DpvFootnote `json:"dpv_footnotes"`
	// indicates whether or not an address has been flagged in the [Early Warning System](https://docs.informatica.com/data-engineering/data-engineering-quality/10-4-0/address-validator-port-reference/postal-carrier-certification-data-ports/early-warning-system-return-code.html), meaning the address is under development and not yet ready to receive mail. However, it should become available in a few months.
	EwsMatch bool `json:"ews_match"`
	// indicates whether this address has been converted by [LACS<sup>Link</sup>](https://postalpro.usps.com/address-quality/lacslink). LACS<sup>Link</sup> corrects outdated addresses into their modern counterparts. Possible values are: * `Y` –– New address produced with a matching record in LACS<sup>Link</sup>. * `N` –– New address could not be produced with a matching record in LACS<sup>Link</sup>. * `”` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
	LacsIndicator string `json:"lacs_indicator"`
	// A code indicating how `deliverability_analysis[lacs_indicator]` was determined. Possible values are: * `A` — A new address was produced because a match was found in LACS<sup>Link</sup>. * `92` — A LACS<sup>Link</sup> record was matched after dropping secondary information. * `14` — A match was found in LACS<sup>Link</sup>, but could not be converted to a deliverable address. * `00` — A match was not found in LACS<sup>Link</sup>, and no new address was produced. * `”` — LACS<sup>Link</sup> was not attempted.
	LacsReturnCode string `json:"lacs_return_code"`
	// A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `”` –– Suite<sup>Link</sup> lookup was not attempted.
	SuiteReturnCode string `json:"suite_return_code"`
}

DeliverabilityAnalysis A nested object containing a breakdown of the deliverability of an address.

func NewDeliverabilityAnalysis 

func NewDeliverabilityAnalysis(dpvConfirmation string, dpvCmra string, dpvVacant string, dpvActive string, dpvInactiveReason string, dpvThrowback string, dpvNonDeliveryDayFlag string, dpvNonDeliveryDayValues string, dpvNoSecureLocation string, dpvDoorNotAccessible string, dpvFootnotes []DpvFootnote, ewsMatch bool, lacsIndicator string, lacsReturnCode string, suiteReturnCode string) *DeliverabilityAnalysis

NewDeliverabilityAnalysis instantiates a new DeliverabilityAnalysis object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDeliverabilityAnalysisWithDefaults 

func NewDeliverabilityAnalysisWithDefaults() *DeliverabilityAnalysis

NewDeliverabilityAnalysisWithDefaults instantiates a new DeliverabilityAnalysis object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DeliverabilityAnalysis) GetDpvActive 

func (o *DeliverabilityAnalysis) GetDpvActive() string

GetDpvActive returns the DpvActive field value

func (*DeliverabilityAnalysis) GetDpvActiveOk 

func (o *DeliverabilityAnalysis) GetDpvActiveOk() (*string, bool)

GetDpvActiveOk returns a tuple with the DpvActive field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvCmra 

func (o *DeliverabilityAnalysis) GetDpvCmra() string

GetDpvCmra returns the DpvCmra field value

func (*DeliverabilityAnalysis) GetDpvCmraOk 

func (o *DeliverabilityAnalysis) GetDpvCmraOk() (*string, bool)

GetDpvCmraOk returns a tuple with the DpvCmra field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvConfirmation 

func (o *DeliverabilityAnalysis) GetDpvConfirmation() string

GetDpvConfirmation returns the DpvConfirmation field value

func (*DeliverabilityAnalysis) GetDpvConfirmationOk 

func (o *DeliverabilityAnalysis) GetDpvConfirmationOk() (*string, bool)

GetDpvConfirmationOk returns a tuple with the DpvConfirmation field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvDoorNotAccessible added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvDoorNotAccessible() string

GetDpvDoorNotAccessible returns the DpvDoorNotAccessible field value

func (*DeliverabilityAnalysis) GetDpvDoorNotAccessibleOk added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvDoorNotAccessibleOk() (*string, bool)

GetDpvDoorNotAccessibleOk returns a tuple with the DpvDoorNotAccessible field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvFootnotes 

func (o *DeliverabilityAnalysis) GetDpvFootnotes() []DpvFootnote

GetDpvFootnotes returns the DpvFootnotes field value

func (*DeliverabilityAnalysis) GetDpvFootnotesOk 

func (o *DeliverabilityAnalysis) GetDpvFootnotesOk() ([]DpvFootnote, bool)

GetDpvFootnotesOk returns a tuple with the DpvFootnotes field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvInactiveReason added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvInactiveReason() string

GetDpvInactiveReason returns the DpvInactiveReason field value

func (*DeliverabilityAnalysis) GetDpvInactiveReasonOk added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvInactiveReasonOk() (*string, bool)

GetDpvInactiveReasonOk returns a tuple with the DpvInactiveReason field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvNoSecureLocation added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvNoSecureLocation() string

GetDpvNoSecureLocation returns the DpvNoSecureLocation field value

func (*DeliverabilityAnalysis) GetDpvNoSecureLocationOk added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvNoSecureLocationOk() (*string, bool)

GetDpvNoSecureLocationOk returns a tuple with the DpvNoSecureLocation field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvNonDeliveryDayFlag added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvNonDeliveryDayFlag() string

GetDpvNonDeliveryDayFlag returns the DpvNonDeliveryDayFlag field value

func (*DeliverabilityAnalysis) GetDpvNonDeliveryDayFlagOk added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvNonDeliveryDayFlagOk() (*string, bool)

GetDpvNonDeliveryDayFlagOk returns a tuple with the DpvNonDeliveryDayFlag field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvNonDeliveryDayValues added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvNonDeliveryDayValues() string

GetDpvNonDeliveryDayValues returns the DpvNonDeliveryDayValues field value

func (*DeliverabilityAnalysis) GetDpvNonDeliveryDayValuesOk added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvNonDeliveryDayValuesOk() (*string, bool)

GetDpvNonDeliveryDayValuesOk returns a tuple with the DpvNonDeliveryDayValues field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvThrowback added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvThrowback() string

GetDpvThrowback returns the DpvThrowback field value

func (*DeliverabilityAnalysis) GetDpvThrowbackOk added in v1.1.0 

func (o *DeliverabilityAnalysis) GetDpvThrowbackOk() (*string, bool)

GetDpvThrowbackOk returns a tuple with the DpvThrowback field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetDpvVacant 

func (o *DeliverabilityAnalysis) GetDpvVacant() string

GetDpvVacant returns the DpvVacant field value

func (*DeliverabilityAnalysis) GetDpvVacantOk 

func (o *DeliverabilityAnalysis) GetDpvVacantOk() (*string, bool)

GetDpvVacantOk returns a tuple with the DpvVacant field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetEwsMatch 

func (o *DeliverabilityAnalysis) GetEwsMatch() bool

GetEwsMatch returns the EwsMatch field value

func (*DeliverabilityAnalysis) GetEwsMatchOk 

func (o *DeliverabilityAnalysis) GetEwsMatchOk() (*bool, bool)

GetEwsMatchOk returns a tuple with the EwsMatch field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetLacsIndicator 

func (o *DeliverabilityAnalysis) GetLacsIndicator() string

GetLacsIndicator returns the LacsIndicator field value

func (*DeliverabilityAnalysis) GetLacsIndicatorOk 

func (o *DeliverabilityAnalysis) GetLacsIndicatorOk() (*string, bool)

GetLacsIndicatorOk returns a tuple with the LacsIndicator field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetLacsReturnCode 

func (o *DeliverabilityAnalysis) GetLacsReturnCode() string

GetLacsReturnCode returns the LacsReturnCode field value

func (*DeliverabilityAnalysis) GetLacsReturnCodeOk 

func (o *DeliverabilityAnalysis) GetLacsReturnCodeOk() (*string, bool)

GetLacsReturnCodeOk returns a tuple with the LacsReturnCode field value and a boolean to check if the value has been set.

func (*DeliverabilityAnalysis) GetSuiteReturnCode 

func (o *DeliverabilityAnalysis) GetSuiteReturnCode() string

GetSuiteReturnCode returns the SuiteReturnCode field value

func (*DeliverabilityAnalysis) GetSuiteReturnCodeOk 

func (o *DeliverabilityAnalysis) GetSuiteReturnCodeOk() (*string, bool)

GetSuiteReturnCodeOk returns a tuple with the SuiteReturnCode field value and a boolean to check if the value has been set.

func (DeliverabilityAnalysis) MarshalJSON 

func (o DeliverabilityAnalysis) MarshalJSON() ([]byte, error)

func (*DeliverabilityAnalysis) SetDpvActive 

func (o *DeliverabilityAnalysis) SetDpvActive(v string)

SetDpvActive sets field value

func (*DeliverabilityAnalysis) SetDpvCmra 

func (o *DeliverabilityAnalysis) SetDpvCmra(v string)

SetDpvCmra sets field value

func (*DeliverabilityAnalysis) SetDpvConfirmation 

func (o *DeliverabilityAnalysis) SetDpvConfirmation(v string)

SetDpvConfirmation sets field value

func (*DeliverabilityAnalysis) SetDpvDoorNotAccessible added in v1.1.0 

func (o *DeliverabilityAnalysis) SetDpvDoorNotAccessible(v string)

SetDpvDoorNotAccessible sets field value

func (*DeliverabilityAnalysis) SetDpvFootnotes 

func (o *DeliverabilityAnalysis) SetDpvFootnotes(v []DpvFootnote)

SetDpvFootnotes sets field value

func (*DeliverabilityAnalysis) SetDpvInactiveReason added in v1.1.0 

func (o *DeliverabilityAnalysis) SetDpvInactiveReason(v string)

SetDpvInactiveReason sets field value

func (*DeliverabilityAnalysis) SetDpvNoSecureLocation added in v1.1.0 

func (o *DeliverabilityAnalysis) SetDpvNoSecureLocation(v string)

SetDpvNoSecureLocation sets field value

func (*DeliverabilityAnalysis) SetDpvNonDeliveryDayFlag added in v1.1.0 

func (o *DeliverabilityAnalysis) SetDpvNonDeliveryDayFlag(v string)

SetDpvNonDeliveryDayFlag sets field value

func (*DeliverabilityAnalysis) SetDpvNonDeliveryDayValues added in v1.1.0 

func (o *DeliverabilityAnalysis) SetDpvNonDeliveryDayValues(v string)

SetDpvNonDeliveryDayValues sets field value

func (*DeliverabilityAnalysis) SetDpvThrowback added in v1.1.0 

func (o *DeliverabilityAnalysis) SetDpvThrowback(v string)

SetDpvThrowback sets field value

func (*DeliverabilityAnalysis) SetDpvVacant 

func (o *DeliverabilityAnalysis) SetDpvVacant(v string)

SetDpvVacant sets field value

func (*DeliverabilityAnalysis) SetEwsMatch 

func (o *DeliverabilityAnalysis) SetEwsMatch(v bool)

SetEwsMatch sets field value

func (*DeliverabilityAnalysis) SetLacsIndicator 

func (o *DeliverabilityAnalysis) SetLacsIndicator(v string)

SetLacsIndicator sets field value

func (*DeliverabilityAnalysis) SetLacsReturnCode 

func (o *DeliverabilityAnalysis) SetLacsReturnCode(v string)

SetLacsReturnCode sets field value

func (*DeliverabilityAnalysis) SetSuiteReturnCode 

func (o *DeliverabilityAnalysis) SetSuiteReturnCode(v string)

SetSuiteReturnCode sets field value

type DpvFootnote 

type DpvFootnote string

DpvFootnote the model 'DpvFootnote' 

const (
	DPVFOOTNOTE_AA DpvFootnote = "AA"
	DPVFOOTNOTE_A1 DpvFootnote = "A1"
	DPVFOOTNOTE_BB DpvFootnote = "BB"
	DPVFOOTNOTE_CC DpvFootnote = "CC"
	DPVFOOTNOTE_C1 DpvFootnote = "C1"
	DPVFOOTNOTE_F1 DpvFootnote = "F1"
	DPVFOOTNOTE_G1 DpvFootnote = "G1"
	DPVFOOTNOTE_IA DpvFootnote = "IA"
	DPVFOOTNOTE_M1 DpvFootnote = "M1"
	DPVFOOTNOTE_M3 DpvFootnote = "M3"
	DPVFOOTNOTE_N1 DpvFootnote = "N1"
	DPVFOOTNOTE_PB DpvFootnote = "PB"
	DPVFOOTNOTE_P1 DpvFootnote = "P1"
	DPVFOOTNOTE_P3 DpvFootnote = "P3"
	DPVFOOTNOTE_R1 DpvFootnote = "R1"
	DPVFOOTNOTE_R7 DpvFootnote = "R7"
	DPVFOOTNOTE_RR DpvFootnote = "RR"
	DPVFOOTNOTE_TA DpvFootnote = "TA"
	DPVFOOTNOTE_U1 DpvFootnote = "U1"
)

List of dpv_footnote

func NewDpvFootnoteFromValue 

func NewDpvFootnoteFromValue(v string) (*DpvFootnote, error)

NewDpvFootnoteFromValue returns a pointer to a valid DpvFootnote for the value passed as argument, or an error if the value passed is not allowed by the enum

func (DpvFootnote) IsValid 

func (v DpvFootnote) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (DpvFootnote) Ptr 

func (v DpvFootnote) Ptr() *DpvFootnote

Ptr returns reference to dpv_footnote value

func (*DpvFootnote) UnmarshalJSON 

func (v *DpvFootnote) UnmarshalJSON(src []byte) error

type EngineHtml 

type EngineHtml string

EngineHtml The engine used to combine HTML template with merge variables. * `legacy` - Lob's original engine * `handlebars` 

const (
	ENGINEHTML_LEGACY     EngineHtml = "legacy"
	ENGINEHTML_HANDLEBARS EngineHtml = "handlebars"
)

List of engine_html

func NewEngineHtmlFromValue 

func NewEngineHtmlFromValue(v string) (*EngineHtml, error)

NewEngineHtmlFromValue returns a pointer to a valid EngineHtml for the value passed as argument, or an error if the value passed is not allowed by the enum

func (EngineHtml) IsValid 

func (v EngineHtml) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (EngineHtml) Ptr 

func (v EngineHtml) Ptr() *EngineHtml

Ptr returns reference to engine_html value

func (*EngineHtml) UnmarshalJSON 

func (v *EngineHtml) UnmarshalJSON(src []byte) error

type EventType 

type EventType struct {
	Id string `json:"id"`
	// Value is `true` if the event type is enabled in both the test and live environments.
	EnabledForTest bool   `json:"enabled_for_test"`
	Resource       string `json:"resource"`
	// Value is resource type.
	Object string `json:"object"`
}

EventType struct for EventType

func NewEventType 

func NewEventType(id string, enabledForTest bool, resource string, object string) *EventType

NewEventType instantiates a new EventType object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEventTypeWithDefaults 

func NewEventTypeWithDefaults() *EventType

NewEventTypeWithDefaults instantiates a new EventType object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EventType) GetEnabledForTest 

func (o *EventType) GetEnabledForTest() bool

GetEnabledForTest returns the EnabledForTest field value

func (*EventType) GetEnabledForTestOk 

func (o *EventType) GetEnabledForTestOk() (*bool, bool)

GetEnabledForTestOk returns a tuple with the EnabledForTest field value and a boolean to check if the value has been set.

func (*EventType) GetId 

func (o *EventType) GetId() string

GetId returns the Id field value

func (*EventType) GetIdOk 

func (o *EventType) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*EventType) GetObject 

func (o *EventType) GetObject() string

GetObject returns the Object field value

func (*EventType) GetObjectOk 

func (o *EventType) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*EventType) GetResource 

func (o *EventType) GetResource() string

GetResource returns the Resource field value

func (*EventType) GetResourceOk 

func (o *EventType) GetResourceOk() (*string, bool)

GetResourceOk returns a tuple with the Resource field value and a boolean to check if the value has been set.

func (EventType) MarshalJSON 

func (o EventType) MarshalJSON() ([]byte, error)

func (*EventType) SetEnabledForTest 

func (o *EventType) SetEnabledForTest(v bool)

SetEnabledForTest sets field value

func (*EventType) SetId 

func (o *EventType) SetId(v string)

SetId sets field value

func (*EventType) SetObject 

func (o *EventType) SetObject(v string)

SetObject sets field value

func (*EventType) SetResource 

func (o *EventType) SetResource(v string)

SetResource sets field value

type Events 

type Events struct {
	// Unique identifier prefixed with `evt_`.
	Id string `json:"id"`
	// The body of the associated resource as they were at the time of the event, i.e. the [postcard object](https://docs.lob.com/#tag/Postcards/operation/postcard_retrieve), [the letter object](https://docs.lob.com/#tag/Letters/operation/letter_retrieve), [the check object](https://docs.lob.com/#tag/Checks/operation/check_retrieve), [the address object](https://docs.lob.com/#tag/Addresses/operation/address_retrieve), or [the bank account object](https://docs.lob.com/#tag/Bank-Accounts/operation/bank_account_retrieve). For `.deleted` events, the body matches the response for the corresponding delete endpoint for that resource (e.g. the [postcard cancel response](https://docs.lob.com/#tag/Postcards/operation/postcard_delete)).
	Body map[string]interface{} `json:"body"`
	// Unique identifier of the related resource for the event.
	ReferenceId string    `json:"reference_id"`
	EventType   EventType `json:"event_type"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// Value is resource type.
	Object string `json:"object"`
}

Events struct for Events

func NewEvents 

func NewEvents(id string, body map[string]interface{}, referenceId string, eventType EventType, dateCreated time.Time, object string) *Events

NewEvents instantiates a new Events object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEventsWithDefaults 

func NewEventsWithDefaults() *Events

NewEventsWithDefaults instantiates a new Events object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Events) GetBody 

func (o *Events) GetBody() map[string]interface{}

GetBody returns the Body field value

func (*Events) GetBodyOk 

func (o *Events) GetBodyOk() (map[string]interface{}, bool)

GetBodyOk returns a tuple with the Body field value and a boolean to check if the value has been set.

func (*Events) GetDateCreated 

func (o *Events) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*Events) GetDateCreatedOk 

func (o *Events) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*Events) GetEventType 

func (o *Events) GetEventType() EventType

GetEventType returns the EventType field value

func (*Events) GetEventTypeOk 

func (o *Events) GetEventTypeOk() (*EventType, bool)

GetEventTypeOk returns a tuple with the EventType field value and a boolean to check if the value has been set.

func (*Events) GetId 

func (o *Events) GetId() string

GetId returns the Id field value

func (*Events) GetIdOk 

func (o *Events) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Events) GetObject 

func (o *Events) GetObject() string

GetObject returns the Object field value

func (*Events) GetObjectOk 

func (o *Events) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*Events) GetReferenceId 

func (o *Events) GetReferenceId() string

GetReferenceId returns the ReferenceId field value

func (*Events) GetReferenceIdOk 

func (o *Events) GetReferenceIdOk() (*string, bool)

GetReferenceIdOk returns a tuple with the ReferenceId field value and a boolean to check if the value has been set.

func (Events) MarshalJSON 

func (o Events) MarshalJSON() ([]byte, error)

func (*Events) SetBody 

func (o *Events) SetBody(v map[string]interface{})

SetBody sets field value

func (*Events) SetDateCreated 

func (o *Events) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*Events) SetEventType 

func (o *Events) SetEventType(v EventType)

SetEventType sets field value

func (*Events) SetId 

func (o *Events) SetId(v string)

SetId sets field value

func (*Events) SetObject 

func (o *Events) SetObject(v string)

SetObject sets field value

func (*Events) SetReferenceId 

func (o *Events) SetReferenceId(v string)

SetReferenceId sets field value

type Export 

type Export struct {
	// Unique identifier prefixed with `ex_`.
	Id string `json:"id"`
	// A timestamp in ISO 8601 format of the date the export was created
	DateCreated time.Time `json:"dateCreated"`
	// A timestamp in ISO 8601 format of the date the export was last modified
	DateModified time.Time `json:"dateModified"`
	// Returns as `true` if the resource has been successfully deleted.
	Deleted bool `json:"deleted"`
	// The URL for the generated export file.
	S3Url *string `json:"s3Url,omitempty"`
	// The state of the export file, which can be `in_progress`, `failed` or `succeeded`.
	State string `json:"state"`
	// The export file type, which can be `all`, `failures` or `successes`.
	Type string `json:"type"`
	// Unique identifier prefixed with `upl_`.
	UploadId string `json:"uploadId"`
}

Export struct for Export

func NewExport 

func NewExport(id string, dateCreated time.Time, dateModified time.Time, deleted bool, state string, type_ string, uploadId string) *Export

NewExport instantiates a new Export object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewExportWithDefaults 

func NewExportWithDefaults() *Export

NewExportWithDefaults instantiates a new Export object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Export) GetDateCreated 

func (o *Export) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*Export) GetDateCreatedOk 

func (o *Export) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*Export) GetDateModified 

func (o *Export) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*Export) GetDateModifiedOk 

func (o *Export) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*Export) GetDeleted 

func (o *Export) GetDeleted() bool

GetDeleted returns the Deleted field value

func (*Export) GetDeletedOk 

func (o *Export) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value and a boolean to check if the value has been set.

func (*Export) GetId 

func (o *Export) GetId() string

GetId returns the Id field value

func (*Export) GetIdOk 

func (o *Export) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Export) GetS3Url 

func (o *Export) GetS3Url() string

GetS3Url returns the S3Url field value if set, zero value otherwise.

func (*Export) GetS3UrlOk 

func (o *Export) GetS3UrlOk() (*string, bool)

GetS3UrlOk returns a tuple with the S3Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Export) GetState 

func (o *Export) GetState() string

GetState returns the State field value

func (*Export) GetStateOk 

func (o *Export) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value and a boolean to check if the value has been set.

func (*Export) GetType 

func (o *Export) GetType() string

GetType returns the Type field value

func (*Export) GetTypeOk 

func (o *Export) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*Export) GetUploadId 

func (o *Export) GetUploadId() string

GetUploadId returns the UploadId field value

func (*Export) GetUploadIdOk 

func (o *Export) GetUploadIdOk() (*string, bool)

GetUploadIdOk returns a tuple with the UploadId field value and a boolean to check if the value has been set.

func (*Export) HasS3Url 

func (o *Export) HasS3Url() bool

HasS3Url returns a boolean if a field has been set.

func (Export) MarshalJSON 

func (o Export) MarshalJSON() ([]byte, error)

func (*Export) SetDateCreated 

func (o *Export) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*Export) SetDateModified 

func (o *Export) SetDateModified(v time.Time)

SetDateModified sets field value

func (*Export) SetDeleted 

func (o *Export) SetDeleted(v bool)

SetDeleted sets field value

func (*Export) SetId 

func (o *Export) SetId(v string)

SetId sets field value

func (*Export) SetS3Url 

func (o *Export) SetS3Url(v string)

SetS3Url gets a reference to the given string and assigns it to the S3Url field.

func (*Export) SetState 

func (o *Export) SetState(v string)

SetState sets field value

func (*Export) SetType 

func (o *Export) SetType(v string)

SetType sets field value

func (*Export) SetUploadId 

func (o *Export) SetUploadId(v string)

SetUploadId sets field value

type ExportModel 

type ExportModel struct {
	Type *string `json:"type,omitempty"`
}

ExportModel struct for ExportModel

func NewExportModel 

func NewExportModel() *ExportModel

NewExportModel instantiates a new ExportModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewExportModelWithDefaults 

func NewExportModelWithDefaults() *ExportModel

NewExportModelWithDefaults instantiates a new ExportModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ExportModel) GetType 

func (o *ExportModel) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ExportModel) GetTypeOk 

func (o *ExportModel) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ExportModel) HasType 

func (o *ExportModel) HasType() bool

HasType returns a boolean if a field has been set.

func (ExportModel) MarshalJSON 

func (o ExportModel) MarshalJSON() ([]byte, error)

func (*ExportModel) SetType 

func (o *ExportModel) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GeocodeAddresses 

type GeocodeAddresses struct {
	Components       *GeocodeComponents `json:"components,omitempty"`
	LocationAnalysis *LocationAnalysis  `json:"location_analysis,omitempty"`
}

GeocodeAddresses struct for GeocodeAddresses

func NewGeocodeAddresses 

func NewGeocodeAddresses() *GeocodeAddresses

NewGeocodeAddresses instantiates a new GeocodeAddresses object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGeocodeAddressesWithDefaults 

func NewGeocodeAddressesWithDefaults() *GeocodeAddresses

NewGeocodeAddressesWithDefaults instantiates a new GeocodeAddresses object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GeocodeAddresses) GetComponents 

func (o *GeocodeAddresses) GetComponents() GeocodeComponents

GetComponents returns the Components field value if set, zero value otherwise.

func (*GeocodeAddresses) GetComponentsOk 

func (o *GeocodeAddresses) GetComponentsOk() (*GeocodeComponents, bool)

GetComponentsOk returns a tuple with the Components field value if set, nil otherwise and a boolean to check if the value has been set.

func (*GeocodeAddresses) GetLocationAnalysis 

func (o *GeocodeAddresses) GetLocationAnalysis() LocationAnalysis

GetLocationAnalysis returns the LocationAnalysis field value if set, zero value otherwise.

func (*GeocodeAddresses) GetLocationAnalysisOk 

func (o *GeocodeAddresses) GetLocationAnalysisOk() (*LocationAnalysis, bool)

GetLocationAnalysisOk returns a tuple with the LocationAnalysis field value if set, nil otherwise and a boolean to check if the value has been set.

func (*GeocodeAddresses) HasComponents 

func (o *GeocodeAddresses) HasComponents() bool

HasComponents returns a boolean if a field has been set.

func (*GeocodeAddresses) HasLocationAnalysis 

func (o *GeocodeAddresses) HasLocationAnalysis() bool

HasLocationAnalysis returns a boolean if a field has been set.

func (GeocodeAddresses) MarshalJSON 

func (o GeocodeAddresses) MarshalJSON() ([]byte, error)

func (*GeocodeAddresses) SetComponents 

func (o *GeocodeAddresses) SetComponents(v GeocodeComponents)

SetComponents gets a reference to the given GeocodeComponents and assigns it to the Components field.

func (*GeocodeAddresses) SetLocationAnalysis 

func (o *GeocodeAddresses) SetLocationAnalysis(v LocationAnalysis)

SetLocationAnalysis gets a reference to the given LocationAnalysis and assigns it to the LocationAnalysis field.

type GeocodeComponents 

type GeocodeComponents struct {
	// The 5-digit ZIP code
	ZipCode      string `json:"zip_code"`
	ZipCodePlus4 string `json:"zip_code_plus_4"`
}

GeocodeComponents A nested object containing a breakdown of each component of a reverse geocoded response.

func NewGeocodeComponents 

func NewGeocodeComponents(zipCode string, zipCodePlus4 string) *GeocodeComponents

NewGeocodeComponents instantiates a new GeocodeComponents object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGeocodeComponentsWithDefaults 

func NewGeocodeComponentsWithDefaults() *GeocodeComponents

NewGeocodeComponentsWithDefaults instantiates a new GeocodeComponents object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GeocodeComponents) GetZipCode 

func (o *GeocodeComponents) GetZipCode() string

GetZipCode returns the ZipCode field value

func (*GeocodeComponents) GetZipCodeOk 

func (o *GeocodeComponents) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value and a boolean to check if the value has been set.

func (*GeocodeComponents) GetZipCodePlus4 

func (o *GeocodeComponents) GetZipCodePlus4() string

GetZipCodePlus4 returns the ZipCodePlus4 field value

func (*GeocodeComponents) GetZipCodePlus4Ok 

func (o *GeocodeComponents) GetZipCodePlus4Ok() (*string, bool)

GetZipCodePlus4Ok returns a tuple with the ZipCodePlus4 field value and a boolean to check if the value has been set.

func (GeocodeComponents) MarshalJSON 

func (o GeocodeComponents) MarshalJSON() ([]byte, error)

func (*GeocodeComponents) SetZipCode 

func (o *GeocodeComponents) SetZipCode(v string)

SetZipCode sets field value

func (*GeocodeComponents) SetZipCodePlus4 

func (o *GeocodeComponents) SetZipCodePlus4(v string)

SetZipCodePlus4 sets field value

type IdentityValidation 

type IdentityValidation struct {
	// Unique identifier prefixed with `id_validation_`.
	Id *string `json:"id,omitempty"`
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine *string `json:"primary_line,omitempty"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	// Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
	Urbanization *string `json:"urbanization,omitempty"`
	// Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)
	LastLine *string `json:"last_line,omitempty"`
	// A numerical score between 0 and 100 that represents the likelihood the provided name is associated with a physical address.
	Score NullableFloat32 `json:"score,omitempty"`
	// Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are: - `high` — Has a Lob confidence score greater than 70. - `medium` — Has a Lob confidence score between 40 and 70. - `low` — Has a Lob confidence score less than 40. - `\"\"` — No tracking data exists for this address.
	Confidence *string `json:"confidence,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

IdentityValidation struct for IdentityValidation

func NewIdentityValidation 

func NewIdentityValidation() *IdentityValidation

NewIdentityValidation instantiates a new IdentityValidation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIdentityValidationWithDefaults 

func NewIdentityValidationWithDefaults() *IdentityValidation

NewIdentityValidationWithDefaults instantiates a new IdentityValidation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IdentityValidation) GetConfidence 

func (o *IdentityValidation) GetConfidence() string

GetConfidence returns the Confidence field value if set, zero value otherwise.

func (*IdentityValidation) GetConfidenceOk 

func (o *IdentityValidation) GetConfidenceOk() (*string, bool)

GetConfidenceOk returns a tuple with the Confidence field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IdentityValidation) GetId 

func (o *IdentityValidation) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*IdentityValidation) GetIdOk 

func (o *IdentityValidation) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IdentityValidation) GetLastLine 

func (o *IdentityValidation) GetLastLine() string

GetLastLine returns the LastLine field value if set, zero value otherwise.

func (*IdentityValidation) GetLastLineOk 

func (o *IdentityValidation) GetLastLineOk() (*string, bool)

GetLastLineOk returns a tuple with the LastLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IdentityValidation) GetObject 

func (o *IdentityValidation) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*IdentityValidation) GetObjectOk 

func (o *IdentityValidation) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IdentityValidation) GetPrimaryLine 

func (o *IdentityValidation) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value if set, zero value otherwise.

func (*IdentityValidation) GetPrimaryLineOk 

func (o *IdentityValidation) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IdentityValidation) GetRecipient 

func (o *IdentityValidation) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*IdentityValidation) GetRecipientOk 

func (o *IdentityValidation) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*IdentityValidation) GetScore 

func (o *IdentityValidation) GetScore() float32

GetScore returns the Score field value if set, zero value otherwise (both if not set or set to explicit null).

func (*IdentityValidation) GetScoreOk 

func (o *IdentityValidation) GetScoreOk() (*float32, bool)

GetScoreOk returns a tuple with the Score field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*IdentityValidation) GetSecondaryLine 

func (o *IdentityValidation) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*IdentityValidation) GetSecondaryLineOk 

func (o *IdentityValidation) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IdentityValidation) GetUrbanization 

func (o *IdentityValidation) GetUrbanization() string

GetUrbanization returns the Urbanization field value if set, zero value otherwise.

func (*IdentityValidation) GetUrbanizationOk 

func (o *IdentityValidation) GetUrbanizationOk() (*string, bool)

GetUrbanizationOk returns a tuple with the Urbanization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IdentityValidation) HasConfidence 

func (o *IdentityValidation) HasConfidence() bool

HasConfidence returns a boolean if a field has been set.

func (*IdentityValidation) HasId 

func (o *IdentityValidation) HasId() bool

HasId returns a boolean if a field has been set.

func (*IdentityValidation) HasLastLine 

func (o *IdentityValidation) HasLastLine() bool

HasLastLine returns a boolean if a field has been set.

func (*IdentityValidation) HasObject 

func (o *IdentityValidation) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*IdentityValidation) HasPrimaryLine 

func (o *IdentityValidation) HasPrimaryLine() bool

HasPrimaryLine returns a boolean if a field has been set.

func (*IdentityValidation) HasRecipient 

func (o *IdentityValidation) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*IdentityValidation) HasScore 

func (o *IdentityValidation) HasScore() bool

HasScore returns a boolean if a field has been set.

func (*IdentityValidation) HasSecondaryLine 

func (o *IdentityValidation) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*IdentityValidation) HasUrbanization 

func (o *IdentityValidation) HasUrbanization() bool

HasUrbanization returns a boolean if a field has been set.

func (IdentityValidation) MarshalJSON 

func (o IdentityValidation) MarshalJSON() ([]byte, error)

func (*IdentityValidation) SetConfidence 

func (o *IdentityValidation) SetConfidence(v string)

SetConfidence gets a reference to the given string and assigns it to the Confidence field.

func (*IdentityValidation) SetId 

func (o *IdentityValidation) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*IdentityValidation) SetLastLine 

func (o *IdentityValidation) SetLastLine(v string)

SetLastLine gets a reference to the given string and assigns it to the LastLine field.

func (*IdentityValidation) SetObject 

func (o *IdentityValidation) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*IdentityValidation) SetPrimaryLine 

func (o *IdentityValidation) SetPrimaryLine(v string)

SetPrimaryLine gets a reference to the given string and assigns it to the PrimaryLine field.

func (*IdentityValidation) SetRecipient 

func (o *IdentityValidation) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*IdentityValidation) SetRecipientNil 

func (o *IdentityValidation) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*IdentityValidation) SetScore 

func (o *IdentityValidation) SetScore(v float32)

SetScore gets a reference to the given NullableFloat32 and assigns it to the Score field.

func (*IdentityValidation) SetScoreNil 

func (o *IdentityValidation) SetScoreNil()

SetScoreNil sets the value for Score to be an explicit nil

func (*IdentityValidation) SetSecondaryLine 

func (o *IdentityValidation) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*IdentityValidation) SetUrbanization 

func (o *IdentityValidation) SetUrbanization(v string)

SetUrbanization gets a reference to the given string and assigns it to the Urbanization field.

func (*IdentityValidation) UnsetRecipient 

func (o *IdentityValidation) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

func (*IdentityValidation) UnsetScore 

func (o *IdentityValidation) UnsetScore()

UnsetScore ensures that no value is present for Score, not even an explicit nil

type IdentityValidationApiService 

type IdentityValidationApiService service

IdentityValidationApiService IdentityValidationApi service

func (*IdentityValidationApiService) IdentityValidationExecute 

func (a *IdentityValidationApiService) IdentityValidationExecute(r ApiIdentityValidationRequest) (*IdentityValidation, *http.Response, error)

Execute executes the request 

@return IdentityValidation

func (*IdentityValidationApiService) Validate 

func (a *IdentityValidationApiService) Validate(ctx context.Context) ApiIdentityValidationRequest

IdentityValidation validate

Validates whether a given name is associated with an address. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiIdentityValidationRequest

type InlineObject 

type InlineObject struct {
	File interface{} `json:"file"`
}

InlineObject struct for InlineObject

func NewInlineObject 

func NewInlineObject(file interface{}) *InlineObject

NewInlineObject instantiates a new InlineObject object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewInlineObjectWithDefaults 

func NewInlineObjectWithDefaults() *InlineObject

NewInlineObjectWithDefaults instantiates a new InlineObject object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*InlineObject) GetFile 

func (o *InlineObject) GetFile() interface{}

GetFile returns the File field value If the value is explicit nil, the zero value for interface{} will be returned

func (*InlineObject) GetFileOk 

func (o *InlineObject) GetFileOk() (*interface{}, bool)

GetFileOk returns a tuple with the File field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (InlineObject) MarshalJSON 

func (o InlineObject) MarshalJSON() ([]byte, error)

func (*InlineObject) SetFile 

func (o *InlineObject) SetFile(v interface{})

SetFile sets field value

type IntlAutocompletions 

type IntlAutocompletions struct {
	// Unique identifier prefixed with `intl_auto_`.
	Id *string `json:"id,omitempty"`
	// An array of objects representing suggested addresses.
	Suggestions []IntlSuggestions `json:"suggestions,omitempty"`
}

IntlAutocompletions struct for IntlAutocompletions

func NewIntlAutocompletions 

func NewIntlAutocompletions() *IntlAutocompletions

NewIntlAutocompletions instantiates a new IntlAutocompletions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlAutocompletionsWithDefaults 

func NewIntlAutocompletionsWithDefaults() *IntlAutocompletions

NewIntlAutocompletionsWithDefaults instantiates a new IntlAutocompletions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlAutocompletions) GetId 

func (o *IntlAutocompletions) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*IntlAutocompletions) GetIdOk 

func (o *IntlAutocompletions) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlAutocompletions) GetSuggestions 

func (o *IntlAutocompletions) GetSuggestions() []IntlSuggestions

GetSuggestions returns the Suggestions field value if set, zero value otherwise.

func (*IntlAutocompletions) GetSuggestionsOk 

func (o *IntlAutocompletions) GetSuggestionsOk() ([]IntlSuggestions, bool)

GetSuggestionsOk returns a tuple with the Suggestions field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlAutocompletions) HasId 

func (o *IntlAutocompletions) HasId() bool

HasId returns a boolean if a field has been set.

func (*IntlAutocompletions) HasSuggestions 

func (o *IntlAutocompletions) HasSuggestions() bool

HasSuggestions returns a boolean if a field has been set.

func (IntlAutocompletions) MarshalJSON 

func (o IntlAutocompletions) MarshalJSON() ([]byte, error)

func (*IntlAutocompletions) SetId 

func (o *IntlAutocompletions) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*IntlAutocompletions) SetSuggestions 

func (o *IntlAutocompletions) SetSuggestions(v []IntlSuggestions)

SetSuggestions gets a reference to the given []IntlSuggestions and assigns it to the Suggestions field.

type IntlAutocompletionsApiService 

type IntlAutocompletionsApiService service

IntlAutocompletionsApiService IntlAutocompletionsApi service

func (*IntlAutocompletionsApiService) Autocomplete 

func (a *IntlAutocompletionsApiService) Autocomplete(ctx context.Context) ApiIntlAutocompletionRequest

IntlAutocompletion autocomplete

Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiIntlAutocompletionRequest

func (*IntlAutocompletionsApiService) IntlAutocompletionExecute 

func (a *IntlAutocompletionsApiService) IntlAutocompletionExecute(r ApiIntlAutocompletionRequest) (*IntlAutocompletions, *http.Response, error)

Execute executes the request 

@return IntlAutocompletions

type IntlAutocompletionsWritable 

type IntlAutocompletionsWritable struct {
	// Only accepts numbers and street names in an alphanumeric format.
	AddressPrefix string `json:"address_prefix"`
	// An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations.
	City *string `json:"city,omitempty"`
	// An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations.
	State *string `json:"state,omitempty"`
	// An optional Zip Code input used to filter suggestions. Matches partial entries.
	ZipCode *string         `json:"zip_code,omitempty"`
	Country CountryExtended `json:"country"`
}

IntlAutocompletionsWritable struct for IntlAutocompletionsWritable

func NewIntlAutocompletionsWritable 

func NewIntlAutocompletionsWritable(addressPrefix string, country CountryExtended) *IntlAutocompletionsWritable

NewIntlAutocompletionsWritable instantiates a new IntlAutocompletionsWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlAutocompletionsWritableWithDefaults 

func NewIntlAutocompletionsWritableWithDefaults() *IntlAutocompletionsWritable

NewIntlAutocompletionsWritableWithDefaults instantiates a new IntlAutocompletionsWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlAutocompletionsWritable) GetAddressPrefix 

func (o *IntlAutocompletionsWritable) GetAddressPrefix() string

GetAddressPrefix returns the AddressPrefix field value

func (*IntlAutocompletionsWritable) GetAddressPrefixOk 

func (o *IntlAutocompletionsWritable) GetAddressPrefixOk() (*string, bool)

GetAddressPrefixOk returns a tuple with the AddressPrefix field value and a boolean to check if the value has been set.

func (*IntlAutocompletionsWritable) GetCity 

func (o *IntlAutocompletionsWritable) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*IntlAutocompletionsWritable) GetCityOk 

func (o *IntlAutocompletionsWritable) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlAutocompletionsWritable) GetCountry 

func (o *IntlAutocompletionsWritable) GetCountry() CountryExtended

GetCountry returns the Country field value

func (*IntlAutocompletionsWritable) GetCountryOk 

func (o *IntlAutocompletionsWritable) GetCountryOk() (*CountryExtended, bool)

GetCountryOk returns a tuple with the Country field value and a boolean to check if the value has been set.

func (*IntlAutocompletionsWritable) GetState 

func (o *IntlAutocompletionsWritable) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*IntlAutocompletionsWritable) GetStateOk 

func (o *IntlAutocompletionsWritable) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlAutocompletionsWritable) GetZipCode 

func (o *IntlAutocompletionsWritable) GetZipCode() string

GetZipCode returns the ZipCode field value if set, zero value otherwise.

func (*IntlAutocompletionsWritable) GetZipCodeOk 

func (o *IntlAutocompletionsWritable) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlAutocompletionsWritable) HasCity 

func (o *IntlAutocompletionsWritable) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*IntlAutocompletionsWritable) HasState 

func (o *IntlAutocompletionsWritable) HasState() bool

HasState returns a boolean if a field has been set.

func (*IntlAutocompletionsWritable) HasZipCode 

func (o *IntlAutocompletionsWritable) HasZipCode() bool

HasZipCode returns a boolean if a field has been set.

func (IntlAutocompletionsWritable) MarshalJSON 

func (o IntlAutocompletionsWritable) MarshalJSON() ([]byte, error)

func (*IntlAutocompletionsWritable) SetAddressPrefix 

func (o *IntlAutocompletionsWritable) SetAddressPrefix(v string)

SetAddressPrefix sets field value

func (*IntlAutocompletionsWritable) SetCity 

func (o *IntlAutocompletionsWritable) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*IntlAutocompletionsWritable) SetCountry 

func (o *IntlAutocompletionsWritable) SetCountry(v CountryExtended)

SetCountry sets field value

func (*IntlAutocompletionsWritable) SetState 

func (o *IntlAutocompletionsWritable) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*IntlAutocompletionsWritable) SetZipCode 

func (o *IntlAutocompletionsWritable) SetZipCode(v string)

SetZipCode gets a reference to the given string and assigns it to the ZipCode field.

type IntlComponents 

type IntlComponents struct {
	// The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number.
	PrimaryNumber *string `json:"primary_number,omitempty"`
	// The name of the street.
	StreetName *string `json:"street_name,omitempty"`
	City       *string `json:"city,omitempty"`
	// The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.
	State *string `json:"state,omitempty"`
	// The postal code.
	PostalCode *string `json:"postal_code,omitempty"`
}

IntlComponents A nested object containing a breakdown of each component of an address.

func NewIntlComponents 

func NewIntlComponents() *IntlComponents

NewIntlComponents instantiates a new IntlComponents object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlComponentsWithDefaults 

func NewIntlComponentsWithDefaults() *IntlComponents

NewIntlComponentsWithDefaults instantiates a new IntlComponents object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlComponents) GetCity 

func (o *IntlComponents) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*IntlComponents) GetCityOk 

func (o *IntlComponents) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlComponents) GetPostalCode 

func (o *IntlComponents) GetPostalCode() string

GetPostalCode returns the PostalCode field value if set, zero value otherwise.

func (*IntlComponents) GetPostalCodeOk 

func (o *IntlComponents) GetPostalCodeOk() (*string, bool)

GetPostalCodeOk returns a tuple with the PostalCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlComponents) GetPrimaryNumber 

func (o *IntlComponents) GetPrimaryNumber() string

GetPrimaryNumber returns the PrimaryNumber field value if set, zero value otherwise.

func (*IntlComponents) GetPrimaryNumberOk 

func (o *IntlComponents) GetPrimaryNumberOk() (*string, bool)

GetPrimaryNumberOk returns a tuple with the PrimaryNumber field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlComponents) GetState 

func (o *IntlComponents) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*IntlComponents) GetStateOk 

func (o *IntlComponents) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlComponents) GetStreetName 

func (o *IntlComponents) GetStreetName() string

GetStreetName returns the StreetName field value if set, zero value otherwise.

func (*IntlComponents) GetStreetNameOk 

func (o *IntlComponents) GetStreetNameOk() (*string, bool)

GetStreetNameOk returns a tuple with the StreetName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlComponents) HasCity 

func (o *IntlComponents) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*IntlComponents) HasPostalCode 

func (o *IntlComponents) HasPostalCode() bool

HasPostalCode returns a boolean if a field has been set.

func (*IntlComponents) HasPrimaryNumber 

func (o *IntlComponents) HasPrimaryNumber() bool

HasPrimaryNumber returns a boolean if a field has been set.

func (*IntlComponents) HasState 

func (o *IntlComponents) HasState() bool

HasState returns a boolean if a field has been set.

func (*IntlComponents) HasStreetName 

func (o *IntlComponents) HasStreetName() bool

HasStreetName returns a boolean if a field has been set.

func (IntlComponents) MarshalJSON 

func (o IntlComponents) MarshalJSON() ([]byte, error)

func (*IntlComponents) SetCity 

func (o *IntlComponents) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*IntlComponents) SetPostalCode 

func (o *IntlComponents) SetPostalCode(v string)

SetPostalCode gets a reference to the given string and assigns it to the PostalCode field.

func (*IntlComponents) SetPrimaryNumber 

func (o *IntlComponents) SetPrimaryNumber(v string)

SetPrimaryNumber gets a reference to the given string and assigns it to the PrimaryNumber field.

func (*IntlComponents) SetState 

func (o *IntlComponents) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*IntlComponents) SetStreetName 

func (o *IntlComponents) SetStreetName(v string)

SetStreetName gets a reference to the given string and assigns it to the StreetName field.

type IntlSuggestions 

type IntlSuggestions struct {
	// The primary number range of the address that identifies a building at street level.
	PrimaryNumberRange string `json:"primary_number_range"`
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine string `json:"primary_line"`
	City        string `json:"city"`
	// The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.
	State   string          `json:"state"`
	Country CountryExtended `json:"country"`
	// A 5-digit zip code. Left empty if a test key is used.
	ZipCode string `json:"zip_code"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

IntlSuggestions struct for IntlSuggestions

func NewIntlSuggestions 

func NewIntlSuggestions(primaryNumberRange string, primaryLine string, city string, state string, country CountryExtended, zipCode string) *IntlSuggestions

NewIntlSuggestions instantiates a new IntlSuggestions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlSuggestionsWithDefaults 

func NewIntlSuggestionsWithDefaults() *IntlSuggestions

NewIntlSuggestionsWithDefaults instantiates a new IntlSuggestions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlSuggestions) GetCity 

func (o *IntlSuggestions) GetCity() string

GetCity returns the City field value

func (*IntlSuggestions) GetCityOk 

func (o *IntlSuggestions) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value and a boolean to check if the value has been set.

func (*IntlSuggestions) GetCountry 

func (o *IntlSuggestions) GetCountry() CountryExtended

GetCountry returns the Country field value

func (*IntlSuggestions) GetCountryOk 

func (o *IntlSuggestions) GetCountryOk() (*CountryExtended, bool)

GetCountryOk returns a tuple with the Country field value and a boolean to check if the value has been set.

func (*IntlSuggestions) GetObject 

func (o *IntlSuggestions) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*IntlSuggestions) GetObjectOk 

func (o *IntlSuggestions) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlSuggestions) GetPrimaryLine 

func (o *IntlSuggestions) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value

func (*IntlSuggestions) GetPrimaryLineOk 

func (o *IntlSuggestions) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value and a boolean to check if the value has been set.

func (*IntlSuggestions) GetPrimaryNumberRange 

func (o *IntlSuggestions) GetPrimaryNumberRange() string

GetPrimaryNumberRange returns the PrimaryNumberRange field value

func (*IntlSuggestions) GetPrimaryNumberRangeOk 

func (o *IntlSuggestions) GetPrimaryNumberRangeOk() (*string, bool)

GetPrimaryNumberRangeOk returns a tuple with the PrimaryNumberRange field value and a boolean to check if the value has been set.

func (*IntlSuggestions) GetState 

func (o *IntlSuggestions) GetState() string

GetState returns the State field value

func (*IntlSuggestions) GetStateOk 

func (o *IntlSuggestions) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value and a boolean to check if the value has been set.

func (*IntlSuggestions) GetZipCode 

func (o *IntlSuggestions) GetZipCode() string

GetZipCode returns the ZipCode field value

func (*IntlSuggestions) GetZipCodeOk 

func (o *IntlSuggestions) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value and a boolean to check if the value has been set.

func (*IntlSuggestions) HasObject 

func (o *IntlSuggestions) HasObject() bool

HasObject returns a boolean if a field has been set.

func (IntlSuggestions) MarshalJSON 

func (o IntlSuggestions) MarshalJSON() ([]byte, error)

func (*IntlSuggestions) SetCity 

func (o *IntlSuggestions) SetCity(v string)

SetCity sets field value

func (*IntlSuggestions) SetCountry 

func (o *IntlSuggestions) SetCountry(v CountryExtended)

SetCountry sets field value

func (*IntlSuggestions) SetObject 

func (o *IntlSuggestions) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*IntlSuggestions) SetPrimaryLine 

func (o *IntlSuggestions) SetPrimaryLine(v string)

SetPrimaryLine sets field value

func (*IntlSuggestions) SetPrimaryNumberRange 

func (o *IntlSuggestions) SetPrimaryNumberRange(v string)

SetPrimaryNumberRange sets field value

func (*IntlSuggestions) SetState 

func (o *IntlSuggestions) SetState(v string)

SetState sets field value

func (*IntlSuggestions) SetZipCode 

func (o *IntlSuggestions) SetZipCode(v string)

SetZipCode sets field value

type IntlVerification 

type IntlVerification struct {
	// Unique identifier prefixed with `intl_ver_`.
	Id *string `json:"id,omitempty"`
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address.
	PrimaryLine *string `json:"primary_line,omitempty"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	// Combination of the following applicable `components`: * `city` * `state` * `zip_code` * `zip_code_plus_4`
	LastLine *string `json:"last_line,omitempty"`
	// The country of the address. Will be returned as a 2 letter country short-name code (ISO 3166).
	Country *string `json:"country,omitempty"`
	// The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to.  * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases
	Coverage *string `json:"coverage,omitempty"`
	// Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code.
	Deliverability *string `json:"deliverability,omitempty"`
	// The status level for the country. This represents the maximum level of accuracy an input address can be verified to.  * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched.
	Status     *string         `json:"status,omitempty"`
	Components *IntlComponents `json:"components,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

IntlVerification struct for IntlVerification

func NewIntlVerification 

func NewIntlVerification() *IntlVerification

NewIntlVerification instantiates a new IntlVerification object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlVerificationWithDefaults 

func NewIntlVerificationWithDefaults() *IntlVerification

NewIntlVerificationWithDefaults instantiates a new IntlVerification object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlVerification) GetComponents 

func (o *IntlVerification) GetComponents() IntlComponents

GetComponents returns the Components field value if set, zero value otherwise.

func (*IntlVerification) GetComponentsOk 

func (o *IntlVerification) GetComponentsOk() (*IntlComponents, bool)

GetComponentsOk returns a tuple with the Components field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetCountry 

func (o *IntlVerification) GetCountry() string

GetCountry returns the Country field value if set, zero value otherwise.

func (*IntlVerification) GetCountryOk 

func (o *IntlVerification) GetCountryOk() (*string, bool)

GetCountryOk returns a tuple with the Country field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetCoverage 

func (o *IntlVerification) GetCoverage() string

GetCoverage returns the Coverage field value if set, zero value otherwise.

func (*IntlVerification) GetCoverageOk 

func (o *IntlVerification) GetCoverageOk() (*string, bool)

GetCoverageOk returns a tuple with the Coverage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetDeliverability 

func (o *IntlVerification) GetDeliverability() string

GetDeliverability returns the Deliverability field value if set, zero value otherwise.

func (*IntlVerification) GetDeliverabilityOk 

func (o *IntlVerification) GetDeliverabilityOk() (*string, bool)

GetDeliverabilityOk returns a tuple with the Deliverability field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetId 

func (o *IntlVerification) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*IntlVerification) GetIdOk 

func (o *IntlVerification) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetLastLine 

func (o *IntlVerification) GetLastLine() string

GetLastLine returns the LastLine field value if set, zero value otherwise.

func (*IntlVerification) GetLastLineOk 

func (o *IntlVerification) GetLastLineOk() (*string, bool)

GetLastLineOk returns a tuple with the LastLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetObject 

func (o *IntlVerification) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*IntlVerification) GetObjectOk 

func (o *IntlVerification) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetPrimaryLine 

func (o *IntlVerification) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value if set, zero value otherwise.

func (*IntlVerification) GetPrimaryLineOk 

func (o *IntlVerification) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetRecipient 

func (o *IntlVerification) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*IntlVerification) GetRecipientOk 

func (o *IntlVerification) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*IntlVerification) GetSecondaryLine 

func (o *IntlVerification) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*IntlVerification) GetSecondaryLineOk 

func (o *IntlVerification) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) GetStatus 

func (o *IntlVerification) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*IntlVerification) GetStatusOk 

func (o *IntlVerification) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerification) HasComponents 

func (o *IntlVerification) HasComponents() bool

HasComponents returns a boolean if a field has been set.

func (*IntlVerification) HasCountry 

func (o *IntlVerification) HasCountry() bool

HasCountry returns a boolean if a field has been set.

func (*IntlVerification) HasCoverage 

func (o *IntlVerification) HasCoverage() bool

HasCoverage returns a boolean if a field has been set.

func (*IntlVerification) HasDeliverability 

func (o *IntlVerification) HasDeliverability() bool

HasDeliverability returns a boolean if a field has been set.

func (*IntlVerification) HasId 

func (o *IntlVerification) HasId() bool

HasId returns a boolean if a field has been set.

func (*IntlVerification) HasLastLine 

func (o *IntlVerification) HasLastLine() bool

HasLastLine returns a boolean if a field has been set.

func (*IntlVerification) HasObject 

func (o *IntlVerification) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*IntlVerification) HasPrimaryLine 

func (o *IntlVerification) HasPrimaryLine() bool

HasPrimaryLine returns a boolean if a field has been set.

func (*IntlVerification) HasRecipient 

func (o *IntlVerification) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*IntlVerification) HasSecondaryLine 

func (o *IntlVerification) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*IntlVerification) HasStatus 

func (o *IntlVerification) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (IntlVerification) MarshalJSON 

func (o IntlVerification) MarshalJSON() ([]byte, error)

func (*IntlVerification) SetComponents 

func (o *IntlVerification) SetComponents(v IntlComponents)

SetComponents gets a reference to the given IntlComponents and assigns it to the Components field.

func (*IntlVerification) SetCountry 

func (o *IntlVerification) SetCountry(v string)

SetCountry gets a reference to the given string and assigns it to the Country field.

func (*IntlVerification) SetCoverage 

func (o *IntlVerification) SetCoverage(v string)

SetCoverage gets a reference to the given string and assigns it to the Coverage field.

func (*IntlVerification) SetDeliverability 

func (o *IntlVerification) SetDeliverability(v string)

SetDeliverability gets a reference to the given string and assigns it to the Deliverability field.

func (*IntlVerification) SetId 

func (o *IntlVerification) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*IntlVerification) SetLastLine 

func (o *IntlVerification) SetLastLine(v string)

SetLastLine gets a reference to the given string and assigns it to the LastLine field.

func (*IntlVerification) SetObject 

func (o *IntlVerification) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*IntlVerification) SetPrimaryLine 

func (o *IntlVerification) SetPrimaryLine(v string)

SetPrimaryLine gets a reference to the given string and assigns it to the PrimaryLine field.

func (*IntlVerification) SetRecipient 

func (o *IntlVerification) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*IntlVerification) SetRecipientNil 

func (o *IntlVerification) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*IntlVerification) SetSecondaryLine 

func (o *IntlVerification) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*IntlVerification) SetStatus 

func (o *IntlVerification) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*IntlVerification) UnsetRecipient 

func (o *IntlVerification) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type IntlVerificationOrError 

type IntlVerificationOrError struct {
	// Unique identifier prefixed with `intl_ver_`.
	Id *string `json:"id,omitempty"`
	// The intended recipient, typically a person's or firm's name.
	Recipient   NullableString `json:"recipient,omitempty"`
	PrimaryLine *string        `json:"primary_line,omitempty"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine  *string         `json:"secondary_line,omitempty"`
	LastLine       *string         `json:"last_line,omitempty"`
	Country        *string         `json:"country,omitempty"`
	Coverage       *string         `json:"coverage,omitempty"`
	Deliverability *string         `json:"deliverability,omitempty"`
	Status         *string         `json:"status,omitempty"`
	Components     *IntlComponents `json:"components,omitempty"`
	Object         *string         `json:"object,omitempty"`
	Error          *BulkError      `json:"error,omitempty"`
}

IntlVerificationOrError A model used to represent an entry in a result list where the entry can either be a intl_verification or an Error. The SDK will perform necessary casting into the correct corresponding type.

func NewIntlVerificationOrError 

func NewIntlVerificationOrError() *IntlVerificationOrError

NewIntlVerificationOrError instantiates a new IntlVerificationOrError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlVerificationOrErrorWithDefaults 

func NewIntlVerificationOrErrorWithDefaults() *IntlVerificationOrError

NewIntlVerificationOrErrorWithDefaults instantiates a new IntlVerificationOrError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlVerificationOrError) GetComponents 

func (o *IntlVerificationOrError) GetComponents() IntlComponents

GetComponents returns the Components field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetComponentsOk 

func (o *IntlVerificationOrError) GetComponentsOk() (*IntlComponents, bool)

GetComponentsOk returns a tuple with the Components field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetCountry 

func (o *IntlVerificationOrError) GetCountry() string

GetCountry returns the Country field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetCountryOk 

func (o *IntlVerificationOrError) GetCountryOk() (*string, bool)

GetCountryOk returns a tuple with the Country field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetCoverage 

func (o *IntlVerificationOrError) GetCoverage() string

GetCoverage returns the Coverage field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetCoverageOk 

func (o *IntlVerificationOrError) GetCoverageOk() (*string, bool)

GetCoverageOk returns a tuple with the Coverage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetDeliverability 

func (o *IntlVerificationOrError) GetDeliverability() string

GetDeliverability returns the Deliverability field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetDeliverabilityOk 

func (o *IntlVerificationOrError) GetDeliverabilityOk() (*string, bool)

GetDeliverabilityOk returns a tuple with the Deliverability field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetError 

func (o *IntlVerificationOrError) GetError() BulkError

GetError returns the Error field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetErrorOk 

func (o *IntlVerificationOrError) GetErrorOk() (*BulkError, bool)

GetErrorOk returns a tuple with the Error field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetId 

func (o *IntlVerificationOrError) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetIdOk 

func (o *IntlVerificationOrError) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetLastLine 

func (o *IntlVerificationOrError) GetLastLine() string

GetLastLine returns the LastLine field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetLastLineOk 

func (o *IntlVerificationOrError) GetLastLineOk() (*string, bool)

GetLastLineOk returns a tuple with the LastLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetObject 

func (o *IntlVerificationOrError) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetObjectOk 

func (o *IntlVerificationOrError) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetPrimaryLine 

func (o *IntlVerificationOrError) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetPrimaryLineOk 

func (o *IntlVerificationOrError) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetRecipient 

func (o *IntlVerificationOrError) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*IntlVerificationOrError) GetRecipientOk 

func (o *IntlVerificationOrError) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*IntlVerificationOrError) GetSecondaryLine 

func (o *IntlVerificationOrError) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetSecondaryLineOk 

func (o *IntlVerificationOrError) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) GetStatus 

func (o *IntlVerificationOrError) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*IntlVerificationOrError) GetStatusOk 

func (o *IntlVerificationOrError) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationOrError) HasComponents 

func (o *IntlVerificationOrError) HasComponents() bool

HasComponents returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasCountry 

func (o *IntlVerificationOrError) HasCountry() bool

HasCountry returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasCoverage 

func (o *IntlVerificationOrError) HasCoverage() bool

HasCoverage returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasDeliverability 

func (o *IntlVerificationOrError) HasDeliverability() bool

HasDeliverability returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasError 

func (o *IntlVerificationOrError) HasError() bool

HasError returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasId 

func (o *IntlVerificationOrError) HasId() bool

HasId returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasLastLine 

func (o *IntlVerificationOrError) HasLastLine() bool

HasLastLine returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasObject 

func (o *IntlVerificationOrError) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasPrimaryLine 

func (o *IntlVerificationOrError) HasPrimaryLine() bool

HasPrimaryLine returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasRecipient 

func (o *IntlVerificationOrError) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasSecondaryLine 

func (o *IntlVerificationOrError) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*IntlVerificationOrError) HasStatus 

func (o *IntlVerificationOrError) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (IntlVerificationOrError) MarshalJSON 

func (o IntlVerificationOrError) MarshalJSON() ([]byte, error)

func (*IntlVerificationOrError) SetComponents 

func (o *IntlVerificationOrError) SetComponents(v IntlComponents)

SetComponents gets a reference to the given IntlComponents and assigns it to the Components field.

func (*IntlVerificationOrError) SetCountry 

func (o *IntlVerificationOrError) SetCountry(v string)

SetCountry gets a reference to the given string and assigns it to the Country field.

func (*IntlVerificationOrError) SetCoverage 

func (o *IntlVerificationOrError) SetCoverage(v string)

SetCoverage gets a reference to the given string and assigns it to the Coverage field.

func (*IntlVerificationOrError) SetDeliverability 

func (o *IntlVerificationOrError) SetDeliverability(v string)

SetDeliverability gets a reference to the given string and assigns it to the Deliverability field.

func (*IntlVerificationOrError) SetError 

func (o *IntlVerificationOrError) SetError(v BulkError)

SetError gets a reference to the given BulkError and assigns it to the Error field.

func (*IntlVerificationOrError) SetId 

func (o *IntlVerificationOrError) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*IntlVerificationOrError) SetLastLine 

func (o *IntlVerificationOrError) SetLastLine(v string)

SetLastLine gets a reference to the given string and assigns it to the LastLine field.

func (*IntlVerificationOrError) SetObject 

func (o *IntlVerificationOrError) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*IntlVerificationOrError) SetPrimaryLine 

func (o *IntlVerificationOrError) SetPrimaryLine(v string)

SetPrimaryLine gets a reference to the given string and assigns it to the PrimaryLine field.

func (*IntlVerificationOrError) SetRecipient 

func (o *IntlVerificationOrError) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*IntlVerificationOrError) SetRecipientNil 

func (o *IntlVerificationOrError) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*IntlVerificationOrError) SetSecondaryLine 

func (o *IntlVerificationOrError) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*IntlVerificationOrError) SetStatus 

func (o *IntlVerificationOrError) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*IntlVerificationOrError) UnsetRecipient 

func (o *IntlVerificationOrError) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type IntlVerificationWritable 

type IntlVerificationWritable struct {
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address.
	PrimaryLine *string `json:"primary_line,omitempty"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	City          *string `json:"city,omitempty"`
	// The name of the state.
	State *string `json:"state,omitempty"`
	// The postal code.
	PostalCode *string          `json:"postal_code,omitempty"`
	Country    *CountryExtended `json:"country,omitempty"`
	// The entire address in one string (e.g., \"370 Water St C1N 1C4\").
	Address *string `json:"address,omitempty"`
}

IntlVerificationWritable struct for IntlVerificationWritable

func NewIntlVerificationWritable 

func NewIntlVerificationWritable() *IntlVerificationWritable

NewIntlVerificationWritable instantiates a new IntlVerificationWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlVerificationWritableWithDefaults 

func NewIntlVerificationWritableWithDefaults() *IntlVerificationWritable

NewIntlVerificationWritableWithDefaults instantiates a new IntlVerificationWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlVerificationWritable) GetAddress 

func (o *IntlVerificationWritable) GetAddress() string

GetAddress returns the Address field value if set, zero value otherwise.

func (*IntlVerificationWritable) GetAddressOk 

func (o *IntlVerificationWritable) GetAddressOk() (*string, bool)

GetAddressOk returns a tuple with the Address field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationWritable) GetCity 

func (o *IntlVerificationWritable) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*IntlVerificationWritable) GetCityOk 

func (o *IntlVerificationWritable) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationWritable) GetCountry 

func (o *IntlVerificationWritable) GetCountry() CountryExtended

GetCountry returns the Country field value if set, zero value otherwise.

func (*IntlVerificationWritable) GetCountryOk 

func (o *IntlVerificationWritable) GetCountryOk() (*CountryExtended, bool)

GetCountryOk returns a tuple with the Country field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationWritable) GetPostalCode 

func (o *IntlVerificationWritable) GetPostalCode() string

GetPostalCode returns the PostalCode field value if set, zero value otherwise.

func (*IntlVerificationWritable) GetPostalCodeOk 

func (o *IntlVerificationWritable) GetPostalCodeOk() (*string, bool)

GetPostalCodeOk returns a tuple with the PostalCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationWritable) GetPrimaryLine 

func (o *IntlVerificationWritable) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value if set, zero value otherwise.

func (*IntlVerificationWritable) GetPrimaryLineOk 

func (o *IntlVerificationWritable) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationWritable) GetRecipient 

func (o *IntlVerificationWritable) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*IntlVerificationWritable) GetRecipientOk 

func (o *IntlVerificationWritable) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*IntlVerificationWritable) GetSecondaryLine 

func (o *IntlVerificationWritable) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*IntlVerificationWritable) GetSecondaryLineOk 

func (o *IntlVerificationWritable) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationWritable) GetState 

func (o *IntlVerificationWritable) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*IntlVerificationWritable) GetStateOk 

func (o *IntlVerificationWritable) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IntlVerificationWritable) HasAddress 

func (o *IntlVerificationWritable) HasAddress() bool

HasAddress returns a boolean if a field has been set.

func (*IntlVerificationWritable) HasCity 

func (o *IntlVerificationWritable) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*IntlVerificationWritable) HasCountry 

func (o *IntlVerificationWritable) HasCountry() bool

HasCountry returns a boolean if a field has been set.

func (*IntlVerificationWritable) HasPostalCode 

func (o *IntlVerificationWritable) HasPostalCode() bool

HasPostalCode returns a boolean if a field has been set.

func (*IntlVerificationWritable) HasPrimaryLine 

func (o *IntlVerificationWritable) HasPrimaryLine() bool

HasPrimaryLine returns a boolean if a field has been set.

func (*IntlVerificationWritable) HasRecipient 

func (o *IntlVerificationWritable) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*IntlVerificationWritable) HasSecondaryLine 

func (o *IntlVerificationWritable) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*IntlVerificationWritable) HasState 

func (o *IntlVerificationWritable) HasState() bool

HasState returns a boolean if a field has been set.

func (IntlVerificationWritable) MarshalJSON 

func (o IntlVerificationWritable) MarshalJSON() ([]byte, error)

func (*IntlVerificationWritable) SetAddress 

func (o *IntlVerificationWritable) SetAddress(v string)

SetAddress gets a reference to the given string and assigns it to the Address field.

func (*IntlVerificationWritable) SetCity 

func (o *IntlVerificationWritable) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*IntlVerificationWritable) SetCountry 

func (o *IntlVerificationWritable) SetCountry(v CountryExtended)

SetCountry gets a reference to the given CountryExtended and assigns it to the Country field.

func (*IntlVerificationWritable) SetPostalCode 

func (o *IntlVerificationWritable) SetPostalCode(v string)

SetPostalCode gets a reference to the given string and assigns it to the PostalCode field.

func (*IntlVerificationWritable) SetPrimaryLine 

func (o *IntlVerificationWritable) SetPrimaryLine(v string)

SetPrimaryLine gets a reference to the given string and assigns it to the PrimaryLine field.

func (*IntlVerificationWritable) SetRecipient 

func (o *IntlVerificationWritable) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*IntlVerificationWritable) SetRecipientNil 

func (o *IntlVerificationWritable) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*IntlVerificationWritable) SetSecondaryLine 

func (o *IntlVerificationWritable) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*IntlVerificationWritable) SetState 

func (o *IntlVerificationWritable) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*IntlVerificationWritable) UnsetRecipient 

func (o *IntlVerificationWritable) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type IntlVerifications 

type IntlVerifications struct {
	Addresses []IntlVerificationOrError `json:"addresses"`
	// Indicates whether any errors occurred during the verification process.
	Errors bool `json:"errors"`
}

IntlVerifications struct for IntlVerifications

func NewIntlVerifications 

func NewIntlVerifications(addresses []IntlVerificationOrError, errors bool) *IntlVerifications

NewIntlVerifications instantiates a new IntlVerifications object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlVerificationsWithDefaults 

func NewIntlVerificationsWithDefaults() *IntlVerifications

NewIntlVerificationsWithDefaults instantiates a new IntlVerifications object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlVerifications) GetAddresses 

func (o *IntlVerifications) GetAddresses() []IntlVerificationOrError

GetAddresses returns the Addresses field value

func (*IntlVerifications) GetAddressesOk 

func (o *IntlVerifications) GetAddressesOk() ([]IntlVerificationOrError, bool)

GetAddressesOk returns a tuple with the Addresses field value and a boolean to check if the value has been set.

func (*IntlVerifications) GetErrors 

func (o *IntlVerifications) GetErrors() bool

GetErrors returns the Errors field value

func (*IntlVerifications) GetErrorsOk 

func (o *IntlVerifications) GetErrorsOk() (*bool, bool)

GetErrorsOk returns a tuple with the Errors field value and a boolean to check if the value has been set.

func (IntlVerifications) MarshalJSON 

func (o IntlVerifications) MarshalJSON() ([]byte, error)

func (*IntlVerifications) SetAddresses 

func (o *IntlVerifications) SetAddresses(v []IntlVerificationOrError)

SetAddresses sets field value

func (*IntlVerifications) SetErrors 

func (o *IntlVerifications) SetErrors(v bool)

SetErrors sets field value

type IntlVerificationsApiService 

type IntlVerificationsApiService service

IntlVerificationsApiService IntlVerificationsApi service

func (*IntlVerificationsApiService) BulkIntlVerificationsExecute 

func (a *IntlVerificationsApiService) BulkIntlVerificationsExecute(r ApiBulkIntlVerificationsRequest) (*IntlVerifications, *http.Response, error)

Execute executes the request 

@return IntlVerifications

func (*IntlVerificationsApiService) IntlVerificationExecute 

func (a *IntlVerificationsApiService) IntlVerificationExecute(r ApiIntlVerificationRequest) (*IntlVerification, *http.Response, error)

Execute executes the request 

@return IntlVerification

func (*IntlVerificationsApiService) VerifyBulk 

func (a *IntlVerificationsApiService) VerifyBulk(ctx context.Context) ApiBulkIntlVerificationsRequest

BulkIntlVerifications verifyBulk

Verify a list of international (except US or US territories) address with a live API key. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBulkIntlVerificationsRequest

func (*IntlVerificationsApiService) VerifySingle 

func (a *IntlVerificationsApiService) VerifySingle(ctx context.Context) ApiIntlVerificationRequest

IntlVerification verifySingle

Verify an international (except US or US territories) address with a live API key. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiIntlVerificationRequest

type IntlVerificationsPayload 

type IntlVerificationsPayload struct {
	Addresses []MultipleComponentsIntl `json:"addresses"`
}

IntlVerificationsPayload struct for IntlVerificationsPayload

func NewIntlVerificationsPayload 

func NewIntlVerificationsPayload(addresses []MultipleComponentsIntl) *IntlVerificationsPayload

NewIntlVerificationsPayload instantiates a new IntlVerificationsPayload object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIntlVerificationsPayloadWithDefaults 

func NewIntlVerificationsPayloadWithDefaults() *IntlVerificationsPayload

NewIntlVerificationsPayloadWithDefaults instantiates a new IntlVerificationsPayload object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IntlVerificationsPayload) GetAddresses 

func (o *IntlVerificationsPayload) GetAddresses() []MultipleComponentsIntl

GetAddresses returns the Addresses field value

func (*IntlVerificationsPayload) GetAddressesOk 

func (o *IntlVerificationsPayload) GetAddressesOk() ([]MultipleComponentsIntl, bool)

GetAddressesOk returns a tuple with the Addresses field value and a boolean to check if the value has been set.

func (IntlVerificationsPayload) MarshalJSON 

func (o IntlVerificationsPayload) MarshalJSON() ([]byte, error)

func (*IntlVerificationsPayload) SetAddresses 

func (o *IntlVerificationsPayload) SetAddresses(v []MultipleComponentsIntl)

SetAddresses sets field value

type Letter 

type Letter struct {
	To         Address     `json:"to"`
	From       Address     `json:"from"`
	Carrier    *string     `json:"carrier,omitempty"`
	Thumbnails []Thumbnail `json:"thumbnails,omitempty"`
	// A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.
	ExpectedDeliveryDate *string `json:"expected_delivery_date,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Unique identifier prefixed with `ltr_`.
	Id string `json:"id"`
	// Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
	TemplateId *string `json:"template_id,omitempty"`
	// Unique identifier prefixed with `vrsn_`.
	TemplateVersionId *string `json:"template_version_id,omitempty"`
	// A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
	Url    *string `json:"url,omitempty"`
	Object string  `json:"object"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time `json:"send_date,omitempty"`
	// Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred.
	ExtraService *string `json:"extra_service,omitempty"`
	// The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode.
	TrackingNumber NullableString `json:"tracking_number,omitempty"`
	// Tracking events are not populated for registered or regular (no extra service) letters.
	TrackingEvents []TrackingEventNormal `json:"tracking_events,omitempty"`
	// Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request.
	ReturnAddress interface{} `json:"return_address,omitempty"`
	MailType      *MailType   `json:"mail_type,omitempty"`
	// Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white.
	Color *bool `json:"color,omitempty"`
	// Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`.
	DoubleSided *bool `json:"double_sided,omitempty"`
	// Specifies the location of the address information that will show through the double-window envelope.
	AddressPlacement *string     `json:"address_placement,omitempty"`
	ReturnEnvelope   interface{} `json:"return_envelope"`
	// Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf).
	PerforatedPage NullableInt32                `json:"perforated_page,omitempty"`
	CustomEnvelope NullableLetterCustomEnvelope `json:"custom_envelope,omitempty"`
	// The unique ID of the associated campaign if the resource was generated from a campaign.
	CampaignId NullableString     `json:"campaign_id,omitempty"`
	UseType    NullableLtrUseType `json:"use_type"`
}

Letter struct for Letter

func NewLetter 

func NewLetter(to Address, from Address, dateCreated time.Time, dateModified time.Time, id string, object string, returnEnvelope interface{}, useType NullableLtrUseType) *Letter

NewLetter instantiates a new Letter object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLetterWithDefaults 

func NewLetterWithDefaults() *Letter

NewLetterWithDefaults instantiates a new Letter object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Letter) GetAddressPlacement 

func (o *Letter) GetAddressPlacement() string

GetAddressPlacement returns the AddressPlacement field value if set, zero value otherwise.

func (*Letter) GetAddressPlacementOk 

func (o *Letter) GetAddressPlacementOk() (*string, bool)

GetAddressPlacementOk returns a tuple with the AddressPlacement field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetCampaignId 

func (o *Letter) GetCampaignId() string

GetCampaignId returns the CampaignId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Letter) GetCampaignIdOk 

func (o *Letter) GetCampaignIdOk() (*string, bool)

GetCampaignIdOk returns a tuple with the CampaignId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetCarrier 

func (o *Letter) GetCarrier() string

GetCarrier returns the Carrier field value if set, zero value otherwise.

func (*Letter) GetCarrierOk 

func (o *Letter) GetCarrierOk() (*string, bool)

GetCarrierOk returns a tuple with the Carrier field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetColor 

func (o *Letter) GetColor() bool

GetColor returns the Color field value if set, zero value otherwise.

func (*Letter) GetColorOk 

func (o *Letter) GetColorOk() (*bool, bool)

GetColorOk returns a tuple with the Color field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetCustomEnvelope 

func (o *Letter) GetCustomEnvelope() LetterCustomEnvelope

GetCustomEnvelope returns the CustomEnvelope field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Letter) GetCustomEnvelopeOk 

func (o *Letter) GetCustomEnvelopeOk() (*LetterCustomEnvelope, bool)

GetCustomEnvelopeOk returns a tuple with the CustomEnvelope field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetDateCreated 

func (o *Letter) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*Letter) GetDateCreatedOk 

func (o *Letter) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*Letter) GetDateModified 

func (o *Letter) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*Letter) GetDateModifiedOk 

func (o *Letter) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*Letter) GetDeleted 

func (o *Letter) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*Letter) GetDeletedOk 

func (o *Letter) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetDescription 

func (o *Letter) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Letter) GetDescriptionOk 

func (o *Letter) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetDoubleSided 

func (o *Letter) GetDoubleSided() bool

GetDoubleSided returns the DoubleSided field value if set, zero value otherwise.

func (*Letter) GetDoubleSidedOk 

func (o *Letter) GetDoubleSidedOk() (*bool, bool)

GetDoubleSidedOk returns a tuple with the DoubleSided field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetExpectedDeliveryDate 

func (o *Letter) GetExpectedDeliveryDate() string

GetExpectedDeliveryDate returns the ExpectedDeliveryDate field value if set, zero value otherwise.

func (*Letter) GetExpectedDeliveryDateOk 

func (o *Letter) GetExpectedDeliveryDateOk() (*string, bool)

GetExpectedDeliveryDateOk returns a tuple with the ExpectedDeliveryDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetExtraService 

func (o *Letter) GetExtraService() string

GetExtraService returns the ExtraService field value if set, zero value otherwise.

func (*Letter) GetExtraServiceOk 

func (o *Letter) GetExtraServiceOk() (*string, bool)

GetExtraServiceOk returns a tuple with the ExtraService field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetFrom 

func (o *Letter) GetFrom() Address

GetFrom returns the From field value

func (*Letter) GetFromOk 

func (o *Letter) GetFromOk() (*Address, bool)

GetFromOk returns a tuple with the From field value and a boolean to check if the value has been set.

func (*Letter) GetId 

func (o *Letter) GetId() string

GetId returns the Id field value

func (*Letter) GetIdOk 

func (o *Letter) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Letter) GetMailType 

func (o *Letter) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*Letter) GetMailTypeOk 

func (o *Letter) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetMergeVariables 

func (o *Letter) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Letter) GetMergeVariablesOk 

func (o *Letter) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetMetadata 

func (o *Letter) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*Letter) GetMetadataOk 

func (o *Letter) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetObject 

func (o *Letter) GetObject() string

GetObject returns the Object field value

func (*Letter) GetObjectOk 

func (o *Letter) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*Letter) GetPerforatedPage 

func (o *Letter) GetPerforatedPage() int32

GetPerforatedPage returns the PerforatedPage field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Letter) GetPerforatedPageOk 

func (o *Letter) GetPerforatedPageOk() (*int32, bool)

GetPerforatedPageOk returns a tuple with the PerforatedPage field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetReturnAddress 

func (o *Letter) GetReturnAddress() interface{}

GetReturnAddress returns the ReturnAddress field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Letter) GetReturnAddressOk 

func (o *Letter) GetReturnAddressOk() (*interface{}, bool)

GetReturnAddressOk returns a tuple with the ReturnAddress field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetReturnEnvelope 

func (o *Letter) GetReturnEnvelope() interface{}

GetReturnEnvelope returns the ReturnEnvelope field value If the value is explicit nil, the zero value for interface{} will be returned

func (*Letter) GetReturnEnvelopeOk 

func (o *Letter) GetReturnEnvelopeOk() (*interface{}, bool)

GetReturnEnvelopeOk returns a tuple with the ReturnEnvelope field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetSendDate 

func (o *Letter) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*Letter) GetSendDateOk 

func (o *Letter) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetTemplateId 

func (o *Letter) GetTemplateId() string

GetTemplateId returns the TemplateId field value if set, zero value otherwise.

func (*Letter) GetTemplateIdOk 

func (o *Letter) GetTemplateIdOk() (*string, bool)

GetTemplateIdOk returns a tuple with the TemplateId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetTemplateVersionId 

func (o *Letter) GetTemplateVersionId() string

GetTemplateVersionId returns the TemplateVersionId field value if set, zero value otherwise.

func (*Letter) GetTemplateVersionIdOk 

func (o *Letter) GetTemplateVersionIdOk() (*string, bool)

GetTemplateVersionIdOk returns a tuple with the TemplateVersionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetThumbnails 

func (o *Letter) GetThumbnails() []Thumbnail

GetThumbnails returns the Thumbnails field value if set, zero value otherwise.

func (*Letter) GetThumbnailsOk 

func (o *Letter) GetThumbnailsOk() ([]Thumbnail, bool)

GetThumbnailsOk returns a tuple with the Thumbnails field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetTo 

func (o *Letter) GetTo() Address

GetTo returns the To field value

func (*Letter) GetToOk 

func (o *Letter) GetToOk() (*Address, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set.

func (*Letter) GetTrackingEvents 

func (o *Letter) GetTrackingEvents() []TrackingEventNormal

GetTrackingEvents returns the TrackingEvents field value if set, zero value otherwise.

func (*Letter) GetTrackingEventsOk 

func (o *Letter) GetTrackingEventsOk() ([]TrackingEventNormal, bool)

GetTrackingEventsOk returns a tuple with the TrackingEvents field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetTrackingNumber 

func (o *Letter) GetTrackingNumber() string

GetTrackingNumber returns the TrackingNumber field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Letter) GetTrackingNumberOk 

func (o *Letter) GetTrackingNumberOk() (*string, bool)

GetTrackingNumberOk returns a tuple with the TrackingNumber field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) GetUrl 

func (o *Letter) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*Letter) GetUrlOk 

func (o *Letter) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Letter) GetUseType 

func (o *Letter) GetUseType() LtrUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for LtrUseType will be returned

func (*Letter) GetUseTypeOk 

func (o *Letter) GetUseTypeOk() (*LtrUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Letter) HasAddressPlacement 

func (o *Letter) HasAddressPlacement() bool

HasAddressPlacement returns a boolean if a field has been set.

func (*Letter) HasCampaignId 

func (o *Letter) HasCampaignId() bool

HasCampaignId returns a boolean if a field has been set.

func (*Letter) HasCarrier 

func (o *Letter) HasCarrier() bool

HasCarrier returns a boolean if a field has been set.

func (*Letter) HasColor 

func (o *Letter) HasColor() bool

HasColor returns a boolean if a field has been set.

func (*Letter) HasCustomEnvelope 

func (o *Letter) HasCustomEnvelope() bool

HasCustomEnvelope returns a boolean if a field has been set.

func (*Letter) HasDeleted 

func (o *Letter) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*Letter) HasDescription 

func (o *Letter) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Letter) HasDoubleSided 

func (o *Letter) HasDoubleSided() bool

HasDoubleSided returns a boolean if a field has been set.

func (*Letter) HasExpectedDeliveryDate 

func (o *Letter) HasExpectedDeliveryDate() bool

HasExpectedDeliveryDate returns a boolean if a field has been set.

func (*Letter) HasExtraService 

func (o *Letter) HasExtraService() bool

HasExtraService returns a boolean if a field has been set.

func (*Letter) HasMailType 

func (o *Letter) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*Letter) HasMergeVariables 

func (o *Letter) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*Letter) HasMetadata 

func (o *Letter) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*Letter) HasPerforatedPage 

func (o *Letter) HasPerforatedPage() bool

HasPerforatedPage returns a boolean if a field has been set.

func (*Letter) HasReturnAddress 

func (o *Letter) HasReturnAddress() bool

HasReturnAddress returns a boolean if a field has been set.

func (*Letter) HasSendDate 

func (o *Letter) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*Letter) HasTemplateId 

func (o *Letter) HasTemplateId() bool

HasTemplateId returns a boolean if a field has been set.

func (*Letter) HasTemplateVersionId 

func (o *Letter) HasTemplateVersionId() bool

HasTemplateVersionId returns a boolean if a field has been set.

func (*Letter) HasThumbnails 

func (o *Letter) HasThumbnails() bool

HasThumbnails returns a boolean if a field has been set.

func (*Letter) HasTrackingEvents 

func (o *Letter) HasTrackingEvents() bool

HasTrackingEvents returns a boolean if a field has been set.

func (*Letter) HasTrackingNumber 

func (o *Letter) HasTrackingNumber() bool

HasTrackingNumber returns a boolean if a field has been set.

func (*Letter) HasUrl 

func (o *Letter) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (Letter) MarshalJSON 

func (o Letter) MarshalJSON() ([]byte, error)

func (*Letter) SetAddressPlacement 

func (o *Letter) SetAddressPlacement(v string)

SetAddressPlacement gets a reference to the given string and assigns it to the AddressPlacement field.

func (*Letter) SetCampaignId 

func (o *Letter) SetCampaignId(v string)

SetCampaignId gets a reference to the given NullableString and assigns it to the CampaignId field.

func (*Letter) SetCampaignIdNil 

func (o *Letter) SetCampaignIdNil()

SetCampaignIdNil sets the value for CampaignId to be an explicit nil

func (*Letter) SetCarrier 

func (o *Letter) SetCarrier(v string)

SetCarrier gets a reference to the given string and assigns it to the Carrier field.

func (*Letter) SetColor 

func (o *Letter) SetColor(v bool)

SetColor gets a reference to the given bool and assigns it to the Color field.

func (*Letter) SetCustomEnvelope 

func (o *Letter) SetCustomEnvelope(v LetterCustomEnvelope)

SetCustomEnvelope gets a reference to the given NullableLetterCustomEnvelope and assigns it to the CustomEnvelope field.

func (*Letter) SetCustomEnvelopeNil 

func (o *Letter) SetCustomEnvelopeNil()

SetCustomEnvelopeNil sets the value for CustomEnvelope to be an explicit nil

func (*Letter) SetDateCreated 

func (o *Letter) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*Letter) SetDateModified 

func (o *Letter) SetDateModified(v time.Time)

SetDateModified sets field value

func (*Letter) SetDeleted 

func (o *Letter) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*Letter) SetDescription 

func (o *Letter) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*Letter) SetDescriptionNil 

func (o *Letter) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*Letter) SetDoubleSided 

func (o *Letter) SetDoubleSided(v bool)

SetDoubleSided gets a reference to the given bool and assigns it to the DoubleSided field.

func (*Letter) SetExpectedDeliveryDate 

func (o *Letter) SetExpectedDeliveryDate(v string)

SetExpectedDeliveryDate gets a reference to the given string and assigns it to the ExpectedDeliveryDate field.

func (*Letter) SetExtraService 

func (o *Letter) SetExtraService(v string)

SetExtraService gets a reference to the given string and assigns it to the ExtraService field.

func (*Letter) SetFrom 

func (o *Letter) SetFrom(v Address)

SetFrom sets field value

func (*Letter) SetId 

func (o *Letter) SetId(v string)

SetId sets field value

func (*Letter) SetMailType 

func (o *Letter) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*Letter) SetMergeVariables 

func (o *Letter) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*Letter) SetMetadata 

func (o *Letter) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*Letter) SetObject 

func (o *Letter) SetObject(v string)

SetObject sets field value

func (*Letter) SetPerforatedPage 

func (o *Letter) SetPerforatedPage(v int32)

SetPerforatedPage gets a reference to the given NullableInt32 and assigns it to the PerforatedPage field.

func (*Letter) SetPerforatedPageNil 

func (o *Letter) SetPerforatedPageNil()

SetPerforatedPageNil sets the value for PerforatedPage to be an explicit nil

func (*Letter) SetReturnAddress 

func (o *Letter) SetReturnAddress(v interface{})

SetReturnAddress gets a reference to the given interface{} and assigns it to the ReturnAddress field.

func (*Letter) SetReturnEnvelope 

func (o *Letter) SetReturnEnvelope(v interface{})

SetReturnEnvelope sets field value

func (*Letter) SetSendDate 

func (o *Letter) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*Letter) SetTemplateId 

func (o *Letter) SetTemplateId(v string)

SetTemplateId gets a reference to the given string and assigns it to the TemplateId field.

func (*Letter) SetTemplateVersionId 

func (o *Letter) SetTemplateVersionId(v string)

SetTemplateVersionId gets a reference to the given string and assigns it to the TemplateVersionId field.

func (*Letter) SetThumbnails 

func (o *Letter) SetThumbnails(v []Thumbnail)

SetThumbnails gets a reference to the given []Thumbnail and assigns it to the Thumbnails field.

func (*Letter) SetTo 

func (o *Letter) SetTo(v Address)

SetTo sets field value

func (*Letter) SetTrackingEvents 

func (o *Letter) SetTrackingEvents(v []TrackingEventNormal)

SetTrackingEvents gets a reference to the given []TrackingEventNormal and assigns it to the TrackingEvents field.

func (*Letter) SetTrackingNumber 

func (o *Letter) SetTrackingNumber(v string)

SetTrackingNumber gets a reference to the given NullableString and assigns it to the TrackingNumber field.

func (*Letter) SetTrackingNumberNil 

func (o *Letter) SetTrackingNumberNil()

SetTrackingNumberNil sets the value for TrackingNumber to be an explicit nil

func (*Letter) SetUrl 

func (o *Letter) SetUrl(v string)

SetUrl gets a reference to the given string and assigns it to the Url field.

func (*Letter) SetUseType 

func (o *Letter) SetUseType(v LtrUseType)

SetUseType sets field value

func (*Letter) UnsetCampaignId 

func (o *Letter) UnsetCampaignId()

UnsetCampaignId ensures that no value is present for CampaignId, not even an explicit nil

func (*Letter) UnsetCustomEnvelope 

func (o *Letter) UnsetCustomEnvelope()

UnsetCustomEnvelope ensures that no value is present for CustomEnvelope, not even an explicit nil

func (*Letter) UnsetDescription 

func (o *Letter) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*Letter) UnsetPerforatedPage 

func (o *Letter) UnsetPerforatedPage()

UnsetPerforatedPage ensures that no value is present for PerforatedPage, not even an explicit nil

func (*Letter) UnsetTrackingNumber 

func (o *Letter) UnsetTrackingNumber()

UnsetTrackingNumber ensures that no value is present for TrackingNumber, not even an explicit nil

type LetterCustomEnvelope 

type LetterCustomEnvelope struct {
	// The unique identifier of the custom envelope used.
	Id *string `json:"id,omitempty"`
	// The url of the envelope asset used.
	Url    *string `json:"url,omitempty"`
	Object *string `json:"object,omitempty"`
}

LetterCustomEnvelope A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used. Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access.

func NewLetterCustomEnvelope 

func NewLetterCustomEnvelope() *LetterCustomEnvelope

NewLetterCustomEnvelope instantiates a new LetterCustomEnvelope object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLetterCustomEnvelopeWithDefaults 

func NewLetterCustomEnvelopeWithDefaults() *LetterCustomEnvelope

NewLetterCustomEnvelopeWithDefaults instantiates a new LetterCustomEnvelope object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LetterCustomEnvelope) GetId 

func (o *LetterCustomEnvelope) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*LetterCustomEnvelope) GetIdOk 

func (o *LetterCustomEnvelope) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterCustomEnvelope) GetObject 

func (o *LetterCustomEnvelope) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*LetterCustomEnvelope) GetObjectOk 

func (o *LetterCustomEnvelope) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterCustomEnvelope) GetUrl 

func (o *LetterCustomEnvelope) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*LetterCustomEnvelope) GetUrlOk 

func (o *LetterCustomEnvelope) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterCustomEnvelope) HasId 

func (o *LetterCustomEnvelope) HasId() bool

HasId returns a boolean if a field has been set.

func (*LetterCustomEnvelope) HasObject 

func (o *LetterCustomEnvelope) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*LetterCustomEnvelope) HasUrl 

func (o *LetterCustomEnvelope) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (LetterCustomEnvelope) MarshalJSON 

func (o LetterCustomEnvelope) MarshalJSON() ([]byte, error)

func (*LetterCustomEnvelope) SetId 

func (o *LetterCustomEnvelope) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*LetterCustomEnvelope) SetObject 

func (o *LetterCustomEnvelope) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*LetterCustomEnvelope) SetUrl 

func (o *LetterCustomEnvelope) SetUrl(v string)

SetUrl gets a reference to the given string and assigns it to the Url field.

type LetterDeletion 

type LetterDeletion struct {
	// Unique identifier prefixed with `ltr_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

LetterDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewLetterDeletion 

func NewLetterDeletion() *LetterDeletion

NewLetterDeletion instantiates a new LetterDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLetterDeletionWithDefaults 

func NewLetterDeletionWithDefaults() *LetterDeletion

NewLetterDeletionWithDefaults instantiates a new LetterDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LetterDeletion) GetDeleted 

func (o *LetterDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*LetterDeletion) GetDeletedOk 

func (o *LetterDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDeletion) GetId 

func (o *LetterDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*LetterDeletion) GetIdOk 

func (o *LetterDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDeletion) GetObject 

func (o *LetterDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*LetterDeletion) GetObjectOk 

func (o *LetterDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDeletion) HasDeleted 

func (o *LetterDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*LetterDeletion) HasId 

func (o *LetterDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*LetterDeletion) HasObject 

func (o *LetterDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (LetterDeletion) MarshalJSON 

func (o LetterDeletion) MarshalJSON() ([]byte, error)

func (*LetterDeletion) SetDeleted 

func (o *LetterDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*LetterDeletion) SetId 

func (o *LetterDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*LetterDeletion) SetObject 

func (o *LetterDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type LetterDetailsReturned 

type LetterDetailsReturned struct {
	// Set this key to `true` if you would like to print in color, false for black and white.
	Color bool `json:"color"`
	// A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information.
	Cards []string `json:"cards"`
	// Specifies the location of the address information that will show through the double-window envelope.
	AddressPlacement *string                        `json:"address_placement,omitempty"`
	CustomEnvelope   NullableCustomEnvelopeReturned `json:"custom_envelope,omitempty"`
	// Set this attribute to `true` for double sided printing,  `false` for for single sided printing.
	DoubleSided *bool `json:"double_sided,omitempty"`
	// Add an extra service to your letter.
	ExtraService   *string     `json:"extra_service,omitempty"`
	MailType       *MailType   `json:"mail_type,omitempty"`
	ReturnEnvelope interface{} `json:"return_envelope,omitempty"`
	// Allows for letter bleed. Enabled only with specific feature flags.
	Bleed           *bool          `json:"bleed,omitempty"`
	FileOriginalUrl NullableString `json:"file_original_url,omitempty"`
}

LetterDetailsReturned Properties that the letters in your Creative should have.

func NewLetterDetailsReturned 

func NewLetterDetailsReturned(color bool, cards []string) *LetterDetailsReturned

NewLetterDetailsReturned instantiates a new LetterDetailsReturned object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLetterDetailsReturnedWithDefaults 

func NewLetterDetailsReturnedWithDefaults() *LetterDetailsReturned

NewLetterDetailsReturnedWithDefaults instantiates a new LetterDetailsReturned object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LetterDetailsReturned) GetAddressPlacement 

func (o *LetterDetailsReturned) GetAddressPlacement() string

GetAddressPlacement returns the AddressPlacement field value if set, zero value otherwise.

func (*LetterDetailsReturned) GetAddressPlacementOk 

func (o *LetterDetailsReturned) GetAddressPlacementOk() (*string, bool)

GetAddressPlacementOk returns a tuple with the AddressPlacement field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsReturned) GetBleed 

func (o *LetterDetailsReturned) GetBleed() bool

GetBleed returns the Bleed field value if set, zero value otherwise.

func (*LetterDetailsReturned) GetBleedOk 

func (o *LetterDetailsReturned) GetBleedOk() (*bool, bool)

GetBleedOk returns a tuple with the Bleed field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsReturned) GetCards 

func (o *LetterDetailsReturned) GetCards() []string

GetCards returns the Cards field value If the value is explicit nil, the zero value for []string will be returned

func (*LetterDetailsReturned) GetCardsOk 

func (o *LetterDetailsReturned) GetCardsOk() ([]string, bool)

GetCardsOk returns a tuple with the Cards field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterDetailsReturned) GetColor 

func (o *LetterDetailsReturned) GetColor() bool

GetColor returns the Color field value

func (*LetterDetailsReturned) GetColorOk 

func (o *LetterDetailsReturned) GetColorOk() (*bool, bool)

GetColorOk returns a tuple with the Color field value and a boolean to check if the value has been set.

func (*LetterDetailsReturned) GetCustomEnvelope 

func (o *LetterDetailsReturned) GetCustomEnvelope() CustomEnvelopeReturned

GetCustomEnvelope returns the CustomEnvelope field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterDetailsReturned) GetCustomEnvelopeOk 

func (o *LetterDetailsReturned) GetCustomEnvelopeOk() (*CustomEnvelopeReturned, bool)

GetCustomEnvelopeOk returns a tuple with the CustomEnvelope field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterDetailsReturned) GetDoubleSided 

func (o *LetterDetailsReturned) GetDoubleSided() bool

GetDoubleSided returns the DoubleSided field value if set, zero value otherwise.

func (*LetterDetailsReturned) GetDoubleSidedOk 

func (o *LetterDetailsReturned) GetDoubleSidedOk() (*bool, bool)

GetDoubleSidedOk returns a tuple with the DoubleSided field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsReturned) GetExtraService 

func (o *LetterDetailsReturned) GetExtraService() string

GetExtraService returns the ExtraService field value if set, zero value otherwise.

func (*LetterDetailsReturned) GetExtraServiceOk 

func (o *LetterDetailsReturned) GetExtraServiceOk() (*string, bool)

GetExtraServiceOk returns a tuple with the ExtraService field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsReturned) GetFileOriginalUrl 

func (o *LetterDetailsReturned) GetFileOriginalUrl() string

GetFileOriginalUrl returns the FileOriginalUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterDetailsReturned) GetFileOriginalUrlOk 

func (o *LetterDetailsReturned) GetFileOriginalUrlOk() (*string, bool)

GetFileOriginalUrlOk returns a tuple with the FileOriginalUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterDetailsReturned) GetMailType 

func (o *LetterDetailsReturned) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*LetterDetailsReturned) GetMailTypeOk 

func (o *LetterDetailsReturned) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsReturned) GetReturnEnvelope 

func (o *LetterDetailsReturned) GetReturnEnvelope() interface{}

GetReturnEnvelope returns the ReturnEnvelope field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterDetailsReturned) GetReturnEnvelopeOk 

func (o *LetterDetailsReturned) GetReturnEnvelopeOk() (*interface{}, bool)

GetReturnEnvelopeOk returns a tuple with the ReturnEnvelope field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterDetailsReturned) HasAddressPlacement 

func (o *LetterDetailsReturned) HasAddressPlacement() bool

HasAddressPlacement returns a boolean if a field has been set.

func (*LetterDetailsReturned) HasBleed 

func (o *LetterDetailsReturned) HasBleed() bool

HasBleed returns a boolean if a field has been set.

func (*LetterDetailsReturned) HasCustomEnvelope 

func (o *LetterDetailsReturned) HasCustomEnvelope() bool

HasCustomEnvelope returns a boolean if a field has been set.

func (*LetterDetailsReturned) HasDoubleSided 

func (o *LetterDetailsReturned) HasDoubleSided() bool

HasDoubleSided returns a boolean if a field has been set.

func (*LetterDetailsReturned) HasExtraService 

func (o *LetterDetailsReturned) HasExtraService() bool

HasExtraService returns a boolean if a field has been set.

func (*LetterDetailsReturned) HasFileOriginalUrl 

func (o *LetterDetailsReturned) HasFileOriginalUrl() bool

HasFileOriginalUrl returns a boolean if a field has been set.

func (*LetterDetailsReturned) HasMailType 

func (o *LetterDetailsReturned) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*LetterDetailsReturned) HasReturnEnvelope 

func (o *LetterDetailsReturned) HasReturnEnvelope() bool

HasReturnEnvelope returns a boolean if a field has been set.

func (LetterDetailsReturned) MarshalJSON 

func (o LetterDetailsReturned) MarshalJSON() ([]byte, error)

func (*LetterDetailsReturned) SetAddressPlacement 

func (o *LetterDetailsReturned) SetAddressPlacement(v string)

SetAddressPlacement gets a reference to the given string and assigns it to the AddressPlacement field.

func (*LetterDetailsReturned) SetBleed 

func (o *LetterDetailsReturned) SetBleed(v bool)

SetBleed gets a reference to the given bool and assigns it to the Bleed field.

func (*LetterDetailsReturned) SetCards 

func (o *LetterDetailsReturned) SetCards(v []string)

SetCards sets field value

func (*LetterDetailsReturned) SetColor 

func (o *LetterDetailsReturned) SetColor(v bool)

SetColor sets field value

func (*LetterDetailsReturned) SetCustomEnvelope 

func (o *LetterDetailsReturned) SetCustomEnvelope(v CustomEnvelopeReturned)

SetCustomEnvelope gets a reference to the given NullableCustomEnvelopeReturned and assigns it to the CustomEnvelope field.

func (*LetterDetailsReturned) SetCustomEnvelopeNil 

func (o *LetterDetailsReturned) SetCustomEnvelopeNil()

SetCustomEnvelopeNil sets the value for CustomEnvelope to be an explicit nil

func (*LetterDetailsReturned) SetDoubleSided 

func (o *LetterDetailsReturned) SetDoubleSided(v bool)

SetDoubleSided gets a reference to the given bool and assigns it to the DoubleSided field.

func (*LetterDetailsReturned) SetExtraService 

func (o *LetterDetailsReturned) SetExtraService(v string)

SetExtraService gets a reference to the given string and assigns it to the ExtraService field.

func (*LetterDetailsReturned) SetFileOriginalUrl 

func (o *LetterDetailsReturned) SetFileOriginalUrl(v string)

SetFileOriginalUrl gets a reference to the given NullableString and assigns it to the FileOriginalUrl field.

func (*LetterDetailsReturned) SetFileOriginalUrlNil 

func (o *LetterDetailsReturned) SetFileOriginalUrlNil()

SetFileOriginalUrlNil sets the value for FileOriginalUrl to be an explicit nil

func (*LetterDetailsReturned) SetMailType 

func (o *LetterDetailsReturned) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*LetterDetailsReturned) SetReturnEnvelope 

func (o *LetterDetailsReturned) SetReturnEnvelope(v interface{})

SetReturnEnvelope gets a reference to the given interface{} and assigns it to the ReturnEnvelope field.

func (*LetterDetailsReturned) UnsetCustomEnvelope 

func (o *LetterDetailsReturned) UnsetCustomEnvelope()

UnsetCustomEnvelope ensures that no value is present for CustomEnvelope, not even an explicit nil

func (*LetterDetailsReturned) UnsetFileOriginalUrl 

func (o *LetterDetailsReturned) UnsetFileOriginalUrl()

UnsetFileOriginalUrl ensures that no value is present for FileOriginalUrl, not even an explicit nil

type LetterDetailsWritable 

type LetterDetailsWritable struct {
	// Specifies the location of the address information that will show through the double-window envelope.
	AddressPlacement *string `json:"address_placement,omitempty"`
	// A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information.
	Cards []string `json:"cards"`
	// Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white.
	Color bool `json:"color"`
	// Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`.
	DoubleSided *bool `json:"double_sided,omitempty"`
	// Add an extra service to your letter.
	ExtraService   *string   `json:"extra_service,omitempty"`
	MailType       *MailType `json:"mail_type,omitempty"`
	ReturnEnvelope *bool     `json:"return_envelope,omitempty"`
	// Accepts an envelope ID for any customized envelope with available inventory.
	CustomEnvelope NullableString `json:"custom_envelope,omitempty"`
}

LetterDetailsWritable Properties that the letters in your Creative should have.

func NewLetterDetailsWritable 

func NewLetterDetailsWritable(cards []string, color bool) *LetterDetailsWritable

NewLetterDetailsWritable instantiates a new LetterDetailsWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLetterDetailsWritableWithDefaults 

func NewLetterDetailsWritableWithDefaults() *LetterDetailsWritable

NewLetterDetailsWritableWithDefaults instantiates a new LetterDetailsWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LetterDetailsWritable) GetAddressPlacement 

func (o *LetterDetailsWritable) GetAddressPlacement() string

GetAddressPlacement returns the AddressPlacement field value if set, zero value otherwise.

func (*LetterDetailsWritable) GetAddressPlacementOk 

func (o *LetterDetailsWritable) GetAddressPlacementOk() (*string, bool)

GetAddressPlacementOk returns a tuple with the AddressPlacement field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsWritable) GetCards 

func (o *LetterDetailsWritable) GetCards() []string

GetCards returns the Cards field value If the value is explicit nil, the zero value for []string will be returned

func (*LetterDetailsWritable) GetCardsOk 

func (o *LetterDetailsWritable) GetCardsOk() ([]string, bool)

GetCardsOk returns a tuple with the Cards field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterDetailsWritable) GetColor 

func (o *LetterDetailsWritable) GetColor() bool

GetColor returns the Color field value

func (*LetterDetailsWritable) GetColorOk 

func (o *LetterDetailsWritable) GetColorOk() (*bool, bool)

GetColorOk returns a tuple with the Color field value and a boolean to check if the value has been set.

func (*LetterDetailsWritable) GetCustomEnvelope 

func (o *LetterDetailsWritable) GetCustomEnvelope() string

GetCustomEnvelope returns the CustomEnvelope field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterDetailsWritable) GetCustomEnvelopeOk 

func (o *LetterDetailsWritable) GetCustomEnvelopeOk() (*string, bool)

GetCustomEnvelopeOk returns a tuple with the CustomEnvelope field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterDetailsWritable) GetDoubleSided 

func (o *LetterDetailsWritable) GetDoubleSided() bool

GetDoubleSided returns the DoubleSided field value if set, zero value otherwise.

func (*LetterDetailsWritable) GetDoubleSidedOk 

func (o *LetterDetailsWritable) GetDoubleSidedOk() (*bool, bool)

GetDoubleSidedOk returns a tuple with the DoubleSided field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsWritable) GetExtraService 

func (o *LetterDetailsWritable) GetExtraService() string

GetExtraService returns the ExtraService field value if set, zero value otherwise.

func (*LetterDetailsWritable) GetExtraServiceOk 

func (o *LetterDetailsWritable) GetExtraServiceOk() (*string, bool)

GetExtraServiceOk returns a tuple with the ExtraService field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsWritable) GetMailType 

func (o *LetterDetailsWritable) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*LetterDetailsWritable) GetMailTypeOk 

func (o *LetterDetailsWritable) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsWritable) GetReturnEnvelope 

func (o *LetterDetailsWritable) GetReturnEnvelope() bool

GetReturnEnvelope returns the ReturnEnvelope field value if set, zero value otherwise.

func (*LetterDetailsWritable) GetReturnEnvelopeOk 

func (o *LetterDetailsWritable) GetReturnEnvelopeOk() (*bool, bool)

GetReturnEnvelopeOk returns a tuple with the ReturnEnvelope field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterDetailsWritable) HasAddressPlacement 

func (o *LetterDetailsWritable) HasAddressPlacement() bool

HasAddressPlacement returns a boolean if a field has been set.

func (*LetterDetailsWritable) HasCustomEnvelope 

func (o *LetterDetailsWritable) HasCustomEnvelope() bool

HasCustomEnvelope returns a boolean if a field has been set.

func (*LetterDetailsWritable) HasDoubleSided 

func (o *LetterDetailsWritable) HasDoubleSided() bool

HasDoubleSided returns a boolean if a field has been set.

func (*LetterDetailsWritable) HasExtraService 

func (o *LetterDetailsWritable) HasExtraService() bool

HasExtraService returns a boolean if a field has been set.

func (*LetterDetailsWritable) HasMailType 

func (o *LetterDetailsWritable) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*LetterDetailsWritable) HasReturnEnvelope 

func (o *LetterDetailsWritable) HasReturnEnvelope() bool

HasReturnEnvelope returns a boolean if a field has been set.

func (LetterDetailsWritable) MarshalJSON 

func (o LetterDetailsWritable) MarshalJSON() ([]byte, error)

func (*LetterDetailsWritable) SetAddressPlacement 

func (o *LetterDetailsWritable) SetAddressPlacement(v string)

SetAddressPlacement gets a reference to the given string and assigns it to the AddressPlacement field.

func (*LetterDetailsWritable) SetCards 

func (o *LetterDetailsWritable) SetCards(v []string)

SetCards sets field value

func (*LetterDetailsWritable) SetColor 

func (o *LetterDetailsWritable) SetColor(v bool)

SetColor sets field value

func (*LetterDetailsWritable) SetCustomEnvelope 

func (o *LetterDetailsWritable) SetCustomEnvelope(v string)

SetCustomEnvelope gets a reference to the given NullableString and assigns it to the CustomEnvelope field.

func (*LetterDetailsWritable) SetCustomEnvelopeNil 

func (o *LetterDetailsWritable) SetCustomEnvelopeNil()

SetCustomEnvelopeNil sets the value for CustomEnvelope to be an explicit nil

func (*LetterDetailsWritable) SetDoubleSided 

func (o *LetterDetailsWritable) SetDoubleSided(v bool)

SetDoubleSided gets a reference to the given bool and assigns it to the DoubleSided field.

func (*LetterDetailsWritable) SetExtraService 

func (o *LetterDetailsWritable) SetExtraService(v string)

SetExtraService gets a reference to the given string and assigns it to the ExtraService field.

func (*LetterDetailsWritable) SetMailType 

func (o *LetterDetailsWritable) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*LetterDetailsWritable) SetReturnEnvelope 

func (o *LetterDetailsWritable) SetReturnEnvelope(v bool)

SetReturnEnvelope gets a reference to the given bool and assigns it to the ReturnEnvelope field.

func (*LetterDetailsWritable) UnsetCustomEnvelope 

func (o *LetterDetailsWritable) UnsetCustomEnvelope()

UnsetCustomEnvelope ensures that no value is present for CustomEnvelope, not even an explicit nil

type LetterEditable 

type LetterEditable struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	MailType *MailType          `json:"mail_type,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time `json:"send_date,omitempty"`
	// Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white.
	Color bool `json:"color"`
	// Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`.
	DoubleSided *bool `json:"double_sided,omitempty"`
	// Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template.   * `top_first_page` - (default) print address information at the top of your provided first page   * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page)   * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page   * `bottom_first_page` - print address information at the bottom of your provided first page
	AddressPlacement *string `json:"address_placement,omitempty"`
	// indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes.  To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred.
	ReturnEnvelope interface{} `json:"return_envelope,omitempty"`
	// Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf).
	PerforatedPage NullableInt32  `json:"perforated_page,omitempty"`
	CustomEnvelope NullableString `json:"custom_envelope,omitempty"`
	// Must either be an address ID or an inline object with correct address parameters.
	To interface{} `json:"to"`
	// Must either be an address ID or an inline object with correct address parameters.
	From interface{} `json:"from"`
	// PDF file containing the letter's formatting.
	File string `json:"file"`
	// Add an extra service to your letter:   * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet.   * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter   * `registered` - provides tracking and confirmation for international addresses
	ExtraService NullableString `json:"extra_service,omitempty"`
	// A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information.
	Cards []string `json:"cards,omitempty"`
	// An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.
	BillingGroupId *string            `json:"billing_group_id,omitempty"`
	QrCode         *QrCode            `json:"qr_code,omitempty"`
	UseType        NullableLtrUseType `json:"use_type"`
}

LetterEditable struct for LetterEditable

func NewLetterEditable 

func NewLetterEditable(color bool, to interface{}, from interface{}, file string, useType NullableLtrUseType) *LetterEditable

NewLetterEditable instantiates a new LetterEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLetterEditableWithDefaults 

func NewLetterEditableWithDefaults() *LetterEditable

NewLetterEditableWithDefaults instantiates a new LetterEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LetterEditable) GetAddressPlacement 

func (o *LetterEditable) GetAddressPlacement() string

GetAddressPlacement returns the AddressPlacement field value if set, zero value otherwise.

func (*LetterEditable) GetAddressPlacementOk 

func (o *LetterEditable) GetAddressPlacementOk() (*string, bool)

GetAddressPlacementOk returns a tuple with the AddressPlacement field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterEditable) GetBillingGroupId 

func (o *LetterEditable) GetBillingGroupId() string

GetBillingGroupId returns the BillingGroupId field value if set, zero value otherwise.

func (*LetterEditable) GetBillingGroupIdOk 

func (o *LetterEditable) GetBillingGroupIdOk() (*string, bool)

GetBillingGroupIdOk returns a tuple with the BillingGroupId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterEditable) GetCards 

func (o *LetterEditable) GetCards() []string

GetCards returns the Cards field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterEditable) GetCardsOk 

func (o *LetterEditable) GetCardsOk() ([]string, bool)

GetCardsOk returns a tuple with the Cards field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetColor 

func (o *LetterEditable) GetColor() bool

GetColor returns the Color field value

func (*LetterEditable) GetColorOk 

func (o *LetterEditable) GetColorOk() (*bool, bool)

GetColorOk returns a tuple with the Color field value and a boolean to check if the value has been set.

func (*LetterEditable) GetCustomEnvelope 

func (o *LetterEditable) GetCustomEnvelope() string

GetCustomEnvelope returns the CustomEnvelope field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterEditable) GetCustomEnvelopeOk 

func (o *LetterEditable) GetCustomEnvelopeOk() (*string, bool)

GetCustomEnvelopeOk returns a tuple with the CustomEnvelope field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetDescription 

func (o *LetterEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterEditable) GetDescriptionOk 

func (o *LetterEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetDoubleSided 

func (o *LetterEditable) GetDoubleSided() bool

GetDoubleSided returns the DoubleSided field value if set, zero value otherwise.

func (*LetterEditable) GetDoubleSidedOk 

func (o *LetterEditable) GetDoubleSidedOk() (*bool, bool)

GetDoubleSidedOk returns a tuple with the DoubleSided field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterEditable) GetExtraService 

func (o *LetterEditable) GetExtraService() string

GetExtraService returns the ExtraService field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterEditable) GetExtraServiceOk 

func (o *LetterEditable) GetExtraServiceOk() (*string, bool)

GetExtraServiceOk returns a tuple with the ExtraService field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetFile 

func (o *LetterEditable) GetFile() string

GetFile returns the File field value

func (*LetterEditable) GetFileOk 

func (o *LetterEditable) GetFileOk() (*string, bool)

GetFileOk returns a tuple with the File field value and a boolean to check if the value has been set.

func (*LetterEditable) GetFrom 

func (o *LetterEditable) GetFrom() interface{}

GetFrom returns the From field value If the value is explicit nil, the zero value for interface{} will be returned

func (*LetterEditable) GetFromOk 

func (o *LetterEditable) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetMailType 

func (o *LetterEditable) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*LetterEditable) GetMailTypeOk 

func (o *LetterEditable) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterEditable) GetMergeVariables 

func (o *LetterEditable) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterEditable) GetMergeVariablesOk 

func (o *LetterEditable) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetMetadata 

func (o *LetterEditable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*LetterEditable) GetMetadataOk 

func (o *LetterEditable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterEditable) GetPerforatedPage 

func (o *LetterEditable) GetPerforatedPage() int32

GetPerforatedPage returns the PerforatedPage field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterEditable) GetPerforatedPageOk 

func (o *LetterEditable) GetPerforatedPageOk() (*int32, bool)

GetPerforatedPageOk returns a tuple with the PerforatedPage field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetQrCode 

func (o *LetterEditable) GetQrCode() QrCode

GetQrCode returns the QrCode field value if set, zero value otherwise.

func (*LetterEditable) GetQrCodeOk 

func (o *LetterEditable) GetQrCodeOk() (*QrCode, bool)

GetQrCodeOk returns a tuple with the QrCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterEditable) GetReturnEnvelope 

func (o *LetterEditable) GetReturnEnvelope() interface{}

GetReturnEnvelope returns the ReturnEnvelope field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterEditable) GetReturnEnvelopeOk 

func (o *LetterEditable) GetReturnEnvelopeOk() (*interface{}, bool)

GetReturnEnvelopeOk returns a tuple with the ReturnEnvelope field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetSendDate 

func (o *LetterEditable) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*LetterEditable) GetSendDateOk 

func (o *LetterEditable) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterEditable) GetTo 

func (o *LetterEditable) GetTo() interface{}

GetTo returns the To field value If the value is explicit nil, the zero value for interface{} will be returned

func (*LetterEditable) GetToOk 

func (o *LetterEditable) GetToOk() (*interface{}, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) GetUseType 

func (o *LetterEditable) GetUseType() LtrUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for LtrUseType will be returned

func (*LetterEditable) GetUseTypeOk 

func (o *LetterEditable) GetUseTypeOk() (*LtrUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterEditable) HasAddressPlacement 

func (o *LetterEditable) HasAddressPlacement() bool

HasAddressPlacement returns a boolean if a field has been set.

func (*LetterEditable) HasBillingGroupId 

func (o *LetterEditable) HasBillingGroupId() bool

HasBillingGroupId returns a boolean if a field has been set.

func (*LetterEditable) HasCards 

func (o *LetterEditable) HasCards() bool

HasCards returns a boolean if a field has been set.

func (*LetterEditable) HasCustomEnvelope 

func (o *LetterEditable) HasCustomEnvelope() bool

HasCustomEnvelope returns a boolean if a field has been set.

func (*LetterEditable) HasDescription 

func (o *LetterEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*LetterEditable) HasDoubleSided 

func (o *LetterEditable) HasDoubleSided() bool

HasDoubleSided returns a boolean if a field has been set.

func (*LetterEditable) HasExtraService 

func (o *LetterEditable) HasExtraService() bool

HasExtraService returns a boolean if a field has been set.

func (*LetterEditable) HasMailType 

func (o *LetterEditable) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*LetterEditable) HasMergeVariables 

func (o *LetterEditable) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*LetterEditable) HasMetadata 

func (o *LetterEditable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*LetterEditable) HasPerforatedPage 

func (o *LetterEditable) HasPerforatedPage() bool

HasPerforatedPage returns a boolean if a field has been set.

func (*LetterEditable) HasQrCode 

func (o *LetterEditable) HasQrCode() bool

HasQrCode returns a boolean if a field has been set.

func (*LetterEditable) HasReturnEnvelope 

func (o *LetterEditable) HasReturnEnvelope() bool

HasReturnEnvelope returns a boolean if a field has been set.

func (*LetterEditable) HasSendDate 

func (o *LetterEditable) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (LetterEditable) MarshalJSON 

func (o LetterEditable) MarshalJSON() ([]byte, error)

func (*LetterEditable) SetAddressPlacement 

func (o *LetterEditable) SetAddressPlacement(v string)

SetAddressPlacement gets a reference to the given string and assigns it to the AddressPlacement field.

func (*LetterEditable) SetBillingGroupId 

func (o *LetterEditable) SetBillingGroupId(v string)

SetBillingGroupId gets a reference to the given string and assigns it to the BillingGroupId field.

func (*LetterEditable) SetCards 

func (o *LetterEditable) SetCards(v []string)

SetCards gets a reference to the given []string and assigns it to the Cards field.

func (*LetterEditable) SetColor 

func (o *LetterEditable) SetColor(v bool)

SetColor sets field value

func (*LetterEditable) SetCustomEnvelope 

func (o *LetterEditable) SetCustomEnvelope(v string)

SetCustomEnvelope gets a reference to the given NullableString and assigns it to the CustomEnvelope field.

func (*LetterEditable) SetCustomEnvelopeNil 

func (o *LetterEditable) SetCustomEnvelopeNil()

SetCustomEnvelopeNil sets the value for CustomEnvelope to be an explicit nil

func (*LetterEditable) SetDescription 

func (o *LetterEditable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*LetterEditable) SetDescriptionNil 

func (o *LetterEditable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*LetterEditable) SetDoubleSided 

func (o *LetterEditable) SetDoubleSided(v bool)

SetDoubleSided gets a reference to the given bool and assigns it to the DoubleSided field.

func (*LetterEditable) SetExtraService 

func (o *LetterEditable) SetExtraService(v string)

SetExtraService gets a reference to the given NullableString and assigns it to the ExtraService field.

func (*LetterEditable) SetExtraServiceNil 

func (o *LetterEditable) SetExtraServiceNil()

SetExtraServiceNil sets the value for ExtraService to be an explicit nil

func (*LetterEditable) SetFile 

func (o *LetterEditable) SetFile(v string)

SetFile sets field value

func (*LetterEditable) SetFrom 

func (o *LetterEditable) SetFrom(v interface{})

SetFrom sets field value

func (*LetterEditable) SetMailType 

func (o *LetterEditable) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*LetterEditable) SetMergeVariables 

func (o *LetterEditable) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*LetterEditable) SetMetadata 

func (o *LetterEditable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*LetterEditable) SetPerforatedPage 

func (o *LetterEditable) SetPerforatedPage(v int32)

SetPerforatedPage gets a reference to the given NullableInt32 and assigns it to the PerforatedPage field.

func (*LetterEditable) SetPerforatedPageNil 

func (o *LetterEditable) SetPerforatedPageNil()

SetPerforatedPageNil sets the value for PerforatedPage to be an explicit nil

func (*LetterEditable) SetQrCode 

func (o *LetterEditable) SetQrCode(v QrCode)

SetQrCode gets a reference to the given QrCode and assigns it to the QrCode field.

func (*LetterEditable) SetReturnEnvelope 

func (o *LetterEditable) SetReturnEnvelope(v interface{})

SetReturnEnvelope gets a reference to the given interface{} and assigns it to the ReturnEnvelope field.

func (*LetterEditable) SetSendDate 

func (o *LetterEditable) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*LetterEditable) SetTo 

func (o *LetterEditable) SetTo(v interface{})

SetTo sets field value

func (*LetterEditable) SetUseType 

func (o *LetterEditable) SetUseType(v LtrUseType)

SetUseType sets field value

func (*LetterEditable) UnsetCustomEnvelope 

func (o *LetterEditable) UnsetCustomEnvelope()

UnsetCustomEnvelope ensures that no value is present for CustomEnvelope, not even an explicit nil

func (*LetterEditable) UnsetDescription 

func (o *LetterEditable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*LetterEditable) UnsetExtraService 

func (o *LetterEditable) UnsetExtraService()

UnsetExtraService ensures that no value is present for ExtraService, not even an explicit nil

func (*LetterEditable) UnsetPerforatedPage 

func (o *LetterEditable) UnsetPerforatedPage()

UnsetPerforatedPage ensures that no value is present for PerforatedPage, not even an explicit nil

type LetterList 

type LetterList struct {
	// list of letters
	Data []Letter `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

LetterList struct for LetterList

func NewLetterList 

func NewLetterList() *LetterList

NewLetterList instantiates a new LetterList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLetterListWithDefaults 

func NewLetterListWithDefaults() *LetterList

NewLetterListWithDefaults instantiates a new LetterList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LetterList) GetCount 

func (o *LetterList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*LetterList) GetCountOk 

func (o *LetterList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterList) GetData 

func (o *LetterList) GetData() []Letter

GetData returns the Data field value if set, zero value otherwise.

func (*LetterList) GetDataOk 

func (o *LetterList) GetDataOk() ([]Letter, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterList) GetNextPageToken 

func (o *LetterList) GetNextPageToken() string

func (*LetterList) GetNextUrl 

func (o *LetterList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterList) GetNextUrlOk 

func (o *LetterList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterList) GetObject 

func (o *LetterList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*LetterList) GetObjectOk 

func (o *LetterList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterList) GetPrevPageToken 

func (o *LetterList) GetPrevPageToken() string

func (*LetterList) GetPreviousUrl 

func (o *LetterList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LetterList) GetPreviousUrlOk 

func (o *LetterList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LetterList) GetTotalCount 

func (o *LetterList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*LetterList) GetTotalCountOk 

func (o *LetterList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LetterList) HasCount 

func (o *LetterList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*LetterList) HasData 

func (o *LetterList) HasData() bool

HasData returns a boolean if a field has been set.

func (*LetterList) HasNextUrl 

func (o *LetterList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*LetterList) HasObject 

func (o *LetterList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*LetterList) HasPreviousUrl 

func (o *LetterList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*LetterList) HasTotalCount 

func (o *LetterList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (LetterList) MarshalJSON 

func (o LetterList) MarshalJSON() ([]byte, error)

func (*LetterList) SetCount 

func (o *LetterList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*LetterList) SetData 

func (o *LetterList) SetData(v []Letter)

SetData gets a reference to the given []Letter and assigns it to the Data field.

func (*LetterList) SetNextUrl 

func (o *LetterList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*LetterList) SetNextUrlNil 

func (o *LetterList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*LetterList) SetObject 

func (o *LetterList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*LetterList) SetPreviousUrl 

func (o *LetterList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*LetterList) SetPreviousUrlNil 

func (o *LetterList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*LetterList) SetTotalCount 

func (o *LetterList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*LetterList) UnsetNextUrl 

func (o *LetterList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*LetterList) UnsetPreviousUrl 

func (o *LetterList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type LettersApiService 

type LettersApiService service

LettersApiService LettersApi service

func (*LettersApiService) Cancel 

func (a *LettersApiService) Cancel(ctx context.Context, ltrId string) ApiLetterCancelRequest

LetterCancel cancel

Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ltrId id of the letter
@return ApiLetterCancelRequest

func (*LettersApiService) Create 

func (a *LettersApiService) Create(ctx context.Context) ApiLetterCreateRequest

LetterCreate create

Creates a new letter given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiLetterCreateRequest

func (*LettersApiService) Get 

func (a *LettersApiService) Get(ctx context.Context, ltrId string) ApiLetterRetrieveRequest

LetterRetrieve get

Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ltrId id of the letter
@return ApiLetterRetrieveRequest

func (*LettersApiService) LetterCancelExecute 

func (a *LettersApiService) LetterCancelExecute(r ApiLetterCancelRequest) (*LetterDeletion, *http.Response, error)

Execute executes the request 

@return LetterDeletion

func (*LettersApiService) LetterCreateExecute 

func (a *LettersApiService) LetterCreateExecute(r ApiLetterCreateRequest) (*Letter, *http.Response, error)

Execute executes the request 

@return Letter

func (*LettersApiService) LetterRetrieveExecute 

func (a *LettersApiService) LetterRetrieveExecute(r ApiLetterRetrieveRequest) (*Letter, *http.Response, error)

Execute executes the request 

@return Letter

func (*LettersApiService) LettersListExecute 

func (a *LettersApiService) LettersListExecute(r ApiLettersListRequest) (*LetterList, *http.Response, error)

Execute executes the request 

@return LetterList

func (*LettersApiService) List 

func (a *LettersApiService) List(ctx context.Context) ApiLettersListRequest

LettersList list

Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiLettersListRequest

type LobConfidenceScore 

type LobConfidenceScore struct {
	// A numerical score between 0 and 100 that represents the percentage of mailpieces Lob has sent to this addresses that have been delivered successfully over the past 2 years. Will be `null` if no tracking data exists for this address.
	Score NullableFloat32 `json:"score,omitempty"`
	// indicates the likelihood that the address is a valid, mail-receiving address. Possible values are:   - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful.   - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully.   - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful.   - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success.
	Level *string `json:"level,omitempty"`
}

LobConfidenceScore Lob Confidence Score is a nested object that provides a numerical value between 0-100 of the likelihood that an address is deliverable based on Lob’s mail delivery data to over half of US households.

func NewLobConfidenceScore 

func NewLobConfidenceScore() *LobConfidenceScore

NewLobConfidenceScore instantiates a new LobConfidenceScore object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLobConfidenceScoreWithDefaults 

func NewLobConfidenceScoreWithDefaults() *LobConfidenceScore

NewLobConfidenceScoreWithDefaults instantiates a new LobConfidenceScore object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LobConfidenceScore) GetLevel 

func (o *LobConfidenceScore) GetLevel() string

GetLevel returns the Level field value if set, zero value otherwise.

func (*LobConfidenceScore) GetLevelOk 

func (o *LobConfidenceScore) GetLevelOk() (*string, bool)

GetLevelOk returns a tuple with the Level field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LobConfidenceScore) GetScore 

func (o *LobConfidenceScore) GetScore() float32

GetScore returns the Score field value if set, zero value otherwise (both if not set or set to explicit null).

func (*LobConfidenceScore) GetScoreOk 

func (o *LobConfidenceScore) GetScoreOk() (*float32, bool)

GetScoreOk returns a tuple with the Score field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LobConfidenceScore) HasLevel 

func (o *LobConfidenceScore) HasLevel() bool

HasLevel returns a boolean if a field has been set.

func (*LobConfidenceScore) HasScore 

func (o *LobConfidenceScore) HasScore() bool

HasScore returns a boolean if a field has been set.

func (LobConfidenceScore) MarshalJSON 

func (o LobConfidenceScore) MarshalJSON() ([]byte, error)

func (*LobConfidenceScore) SetLevel 

func (o *LobConfidenceScore) SetLevel(v string)

SetLevel gets a reference to the given string and assigns it to the Level field.

func (*LobConfidenceScore) SetScore 

func (o *LobConfidenceScore) SetScore(v float32)

SetScore gets a reference to the given NullableFloat32 and assigns it to the Score field.

func (*LobConfidenceScore) SetScoreNil 

func (o *LobConfidenceScore) SetScoreNil()

SetScoreNil sets the value for Score to be an explicit nil

func (*LobConfidenceScore) UnsetScore 

func (o *LobConfidenceScore) UnsetScore()

UnsetScore ensures that no value is present for Score, not even an explicit nil

type LobError 

type LobError struct {
	// A human-readable message with more details about the error
	Message *string `json:"message,omitempty"`
	// A conventional HTTP status code.
	StatusCode *int32 `json:"status_code,omitempty"`
	// A pre-defined string identifying an error.
	Code *string `json:"code,omitempty"`
}

LobError Lob uses RESTful HTTP response codes to indicate success or failure of an API request.

func NewLobError 

func NewLobError() *LobError

NewLobError instantiates a new LobError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLobErrorWithDefaults 

func NewLobErrorWithDefaults() *LobError

NewLobErrorWithDefaults instantiates a new LobError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LobError) GetCode 

func (o *LobError) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*LobError) GetCodeOk 

func (o *LobError) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LobError) GetMessage 

func (o *LobError) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*LobError) GetMessageOk 

func (o *LobError) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LobError) GetStatusCode 

func (o *LobError) GetStatusCode() int32

GetStatusCode returns the StatusCode field value if set, zero value otherwise.

func (*LobError) GetStatusCodeOk 

func (o *LobError) GetStatusCodeOk() (*int32, bool)

GetStatusCodeOk returns a tuple with the StatusCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LobError) HasCode 

func (o *LobError) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*LobError) HasMessage 

func (o *LobError) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*LobError) HasStatusCode 

func (o *LobError) HasStatusCode() bool

HasStatusCode returns a boolean if a field has been set.

func (LobError) MarshalJSON 

func (o LobError) MarshalJSON() ([]byte, error)

func (*LobError) SetCode 

func (o *LobError) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*LobError) SetMessage 

func (o *LobError) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*LobError) SetStatusCode 

func (o *LobError) SetStatusCode(v int32)

SetStatusCode gets a reference to the given int32 and assigns it to the StatusCode field.

type Location 

type Location struct {
	// A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be input with `longitude` to pinpoint locations on a map.
	Latitude NullableFloat32 `json:"latitude"`
	// A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be input with `latitude` to pinpoint locations on a map.
	Longitude NullableFloat32 `json:"longitude"`
}

Location struct for Location

func NewLocation 

func NewLocation(latitude NullableFloat32, longitude NullableFloat32) *Location

NewLocation instantiates a new Location object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLocationWithDefaults 

func NewLocationWithDefaults() *Location

NewLocationWithDefaults instantiates a new Location object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Location) GetLatitude 

func (o *Location) GetLatitude() float32

GetLatitude returns the Latitude field value If the value is explicit nil, the zero value for float32 will be returned

func (*Location) GetLatitudeOk 

func (o *Location) GetLatitudeOk() (*float32, bool)

GetLatitudeOk returns a tuple with the Latitude field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Location) GetLongitude 

func (o *Location) GetLongitude() float32

GetLongitude returns the Longitude field value If the value is explicit nil, the zero value for float32 will be returned

func (*Location) GetLongitudeOk 

func (o *Location) GetLongitudeOk() (*float32, bool)

GetLongitudeOk returns a tuple with the Longitude field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (Location) MarshalJSON 

func (o Location) MarshalJSON() ([]byte, error)

func (*Location) SetLatitude 

func (o *Location) SetLatitude(v float32)

SetLatitude sets field value

func (*Location) SetLongitude 

func (o *Location) SetLongitude(v float32)

SetLongitude sets field value

type LocationAnalysis 

type LocationAnalysis struct {
	// A positive or negative decimal indicating the geographic latitude of the address.
	Latitude NullableFloat32 `json:"latitude"`
	// A positive or negative decimal indicating the geographic longitude of the address.
	Longitude NullableFloat32 `json:"longitude"`
	// The distance from the input location to this exact zip code in miles.
	Distance float32 `json:"distance"`
}

LocationAnalysis A nested object containing a breakdown of the analysis of a reverse geocoded location.

func NewLocationAnalysis 

func NewLocationAnalysis(latitude NullableFloat32, longitude NullableFloat32, distance float32) *LocationAnalysis

NewLocationAnalysis instantiates a new LocationAnalysis object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLocationAnalysisWithDefaults 

func NewLocationAnalysisWithDefaults() *LocationAnalysis

NewLocationAnalysisWithDefaults instantiates a new LocationAnalysis object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LocationAnalysis) GetDistance 

func (o *LocationAnalysis) GetDistance() float32

GetDistance returns the Distance field value

func (*LocationAnalysis) GetDistanceOk 

func (o *LocationAnalysis) GetDistanceOk() (*float32, bool)

GetDistanceOk returns a tuple with the Distance field value and a boolean to check if the value has been set.

func (*LocationAnalysis) GetLatitude 

func (o *LocationAnalysis) GetLatitude() float32

GetLatitude returns the Latitude field value If the value is explicit nil, the zero value for float32 will be returned

func (*LocationAnalysis) GetLatitudeOk 

func (o *LocationAnalysis) GetLatitudeOk() (*float32, bool)

GetLatitudeOk returns a tuple with the Latitude field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*LocationAnalysis) GetLongitude 

func (o *LocationAnalysis) GetLongitude() float32

GetLongitude returns the Longitude field value If the value is explicit nil, the zero value for float32 will be returned

func (*LocationAnalysis) GetLongitudeOk 

func (o *LocationAnalysis) GetLongitudeOk() (*float32, bool)

GetLongitudeOk returns a tuple with the Longitude field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (LocationAnalysis) MarshalJSON 

func (o LocationAnalysis) MarshalJSON() ([]byte, error)

func (*LocationAnalysis) SetDistance 

func (o *LocationAnalysis) SetDistance(v float32)

SetDistance sets field value

func (*LocationAnalysis) SetLatitude 

func (o *LocationAnalysis) SetLatitude(v float32)

SetLatitude sets field value

func (*LocationAnalysis) SetLongitude 

func (o *LocationAnalysis) SetLongitude(v float32)

SetLongitude sets field value

type LtrUseType 

type LtrUseType string

LtrUseType The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). 

const (
	LTRUSETYPE_MARKETING   LtrUseType = "marketing"
	LTRUSETYPE_OPERATIONAL LtrUseType = "operational"
	LTRUSETYPE_NULL        LtrUseType = "null"
)

List of ltr_use_type

func NewLtrUseTypeFromValue 

func NewLtrUseTypeFromValue(v string) (*LtrUseType, error)

NewLtrUseTypeFromValue returns a pointer to a valid LtrUseType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (LtrUseType) IsValid 

func (v LtrUseType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (LtrUseType) Ptr 

func (v LtrUseType) Ptr() *LtrUseType

Ptr returns reference to ltr_use_type value

func (*LtrUseType) UnmarshalJSON 

func (v *LtrUseType) UnmarshalJSON(src []byte) error

type MailType 

type MailType string

MailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. 

const (
	MAILTYPE_FIRST_CLASS MailType = "usps_first_class"
	MAILTYPE_STANDARD    MailType = "usps_standard"
)

List of mail_type

func NewMailTypeFromValue 

func NewMailTypeFromValue(v string) (*MailType, error)

NewMailTypeFromValue returns a pointer to a valid MailType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (MailType) IsValid 

func (v MailType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (MailType) Ptr 

func (v MailType) Ptr() *MailType

Ptr returns reference to mail_type value

func (*MailType) UnmarshalJSON 

func (v *MailType) UnmarshalJSON(src []byte) error

type MultiLineAddress 

type MultiLineAddress struct {
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// Either `name` or `company` is required, you may also add both.
	Company NullableString `json:"company,omitempty"`
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine string `json:"primary_line"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	// Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
	Urbanization *string `json:"urbanization,omitempty"`
	City         *string `json:"city,omitempty"`
	// The <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2:US\" target=\"_blank\">ISO 3166-2</a> two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.
	State *string `json:"state,omitempty"`
	// Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`).
	ZipCode *string `json:"zip_code,omitempty"`
}

MultiLineAddress struct for MultiLineAddress

func NewMultiLineAddress 

func NewMultiLineAddress(primaryLine string) *MultiLineAddress

NewMultiLineAddress instantiates a new MultiLineAddress object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewMultiLineAddressWithDefaults 

func NewMultiLineAddressWithDefaults() *MultiLineAddress

NewMultiLineAddressWithDefaults instantiates a new MultiLineAddress object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*MultiLineAddress) GetCity 

func (o *MultiLineAddress) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*MultiLineAddress) GetCityOk 

func (o *MultiLineAddress) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultiLineAddress) GetCompany 

func (o *MultiLineAddress) GetCompany() string

GetCompany returns the Company field value if set, zero value otherwise (both if not set or set to explicit null).

func (*MultiLineAddress) GetCompanyOk 

func (o *MultiLineAddress) GetCompanyOk() (*string, bool)

GetCompanyOk returns a tuple with the Company field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*MultiLineAddress) GetPrimaryLine 

func (o *MultiLineAddress) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value

func (*MultiLineAddress) GetPrimaryLineOk 

func (o *MultiLineAddress) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value and a boolean to check if the value has been set.

func (*MultiLineAddress) GetRecipient 

func (o *MultiLineAddress) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*MultiLineAddress) GetRecipientOk 

func (o *MultiLineAddress) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*MultiLineAddress) GetSecondaryLine 

func (o *MultiLineAddress) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*MultiLineAddress) GetSecondaryLineOk 

func (o *MultiLineAddress) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultiLineAddress) GetState 

func (o *MultiLineAddress) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*MultiLineAddress) GetStateOk 

func (o *MultiLineAddress) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultiLineAddress) GetUrbanization 

func (o *MultiLineAddress) GetUrbanization() string

GetUrbanization returns the Urbanization field value if set, zero value otherwise.

func (*MultiLineAddress) GetUrbanizationOk 

func (o *MultiLineAddress) GetUrbanizationOk() (*string, bool)

GetUrbanizationOk returns a tuple with the Urbanization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultiLineAddress) GetZipCode 

func (o *MultiLineAddress) GetZipCode() string

GetZipCode returns the ZipCode field value if set, zero value otherwise.

func (*MultiLineAddress) GetZipCodeOk 

func (o *MultiLineAddress) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultiLineAddress) HasCity 

func (o *MultiLineAddress) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*MultiLineAddress) HasCompany 

func (o *MultiLineAddress) HasCompany() bool

HasCompany returns a boolean if a field has been set.

func (*MultiLineAddress) HasRecipient 

func (o *MultiLineAddress) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*MultiLineAddress) HasSecondaryLine 

func (o *MultiLineAddress) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*MultiLineAddress) HasState 

func (o *MultiLineAddress) HasState() bool

HasState returns a boolean if a field has been set.

func (*MultiLineAddress) HasUrbanization 

func (o *MultiLineAddress) HasUrbanization() bool

HasUrbanization returns a boolean if a field has been set.

func (*MultiLineAddress) HasZipCode 

func (o *MultiLineAddress) HasZipCode() bool

HasZipCode returns a boolean if a field has been set.

func (MultiLineAddress) MarshalJSON 

func (o MultiLineAddress) MarshalJSON() ([]byte, error)

func (*MultiLineAddress) SetCity 

func (o *MultiLineAddress) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*MultiLineAddress) SetCompany 

func (o *MultiLineAddress) SetCompany(v string)

SetCompany gets a reference to the given NullableString and assigns it to the Company field.

func (*MultiLineAddress) SetCompanyNil 

func (o *MultiLineAddress) SetCompanyNil()

SetCompanyNil sets the value for Company to be an explicit nil

func (*MultiLineAddress) SetPrimaryLine 

func (o *MultiLineAddress) SetPrimaryLine(v string)

SetPrimaryLine sets field value

func (*MultiLineAddress) SetRecipient 

func (o *MultiLineAddress) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*MultiLineAddress) SetRecipientNil 

func (o *MultiLineAddress) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*MultiLineAddress) SetSecondaryLine 

func (o *MultiLineAddress) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*MultiLineAddress) SetState 

func (o *MultiLineAddress) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*MultiLineAddress) SetUrbanization 

func (o *MultiLineAddress) SetUrbanization(v string)

SetUrbanization gets a reference to the given string and assigns it to the Urbanization field.

func (*MultiLineAddress) SetZipCode 

func (o *MultiLineAddress) SetZipCode(v string)

SetZipCode gets a reference to the given string and assigns it to the ZipCode field.

func (*MultiLineAddress) UnsetCompany 

func (o *MultiLineAddress) UnsetCompany()

UnsetCompany ensures that no value is present for Company, not even an explicit nil

func (*MultiLineAddress) UnsetRecipient 

func (o *MultiLineAddress) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type MultipleComponents 

type MultipleComponents struct {
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine string `json:"primary_line"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	// Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
	Urbanization *string `json:"urbanization,omitempty"`
	City         *string `json:"city,omitempty"`
	// The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.
	State *string `json:"state,omitempty"`
	// Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`).
	ZipCode *string `json:"zip_code,omitempty"`
	// ID that is returned in the response body for the verification
	TransientId *string `json:"transient_id,omitempty"`
}

MultipleComponents struct for MultipleComponents

func NewMultipleComponents 

func NewMultipleComponents(primaryLine string) *MultipleComponents

NewMultipleComponents instantiates a new MultipleComponents object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewMultipleComponentsWithDefaults 

func NewMultipleComponentsWithDefaults() *MultipleComponents

NewMultipleComponentsWithDefaults instantiates a new MultipleComponents object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*MultipleComponents) GetCity 

func (o *MultipleComponents) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*MultipleComponents) GetCityOk 

func (o *MultipleComponents) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponents) GetPrimaryLine 

func (o *MultipleComponents) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value

func (*MultipleComponents) GetPrimaryLineOk 

func (o *MultipleComponents) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value and a boolean to check if the value has been set.

func (*MultipleComponents) GetRecipient 

func (o *MultipleComponents) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*MultipleComponents) GetRecipientOk 

func (o *MultipleComponents) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*MultipleComponents) GetSecondaryLine 

func (o *MultipleComponents) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*MultipleComponents) GetSecondaryLineOk 

func (o *MultipleComponents) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponents) GetState 

func (o *MultipleComponents) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*MultipleComponents) GetStateOk 

func (o *MultipleComponents) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponents) GetTransientId added in v1.1.1 

func (o *MultipleComponents) GetTransientId() string

GetTransientId returns the TransientId field value if set, zero value otherwise.

func (*MultipleComponents) GetTransientIdOk added in v1.1.1 

func (o *MultipleComponents) GetTransientIdOk() (*string, bool)

GetTransientIdOk returns a tuple with the TransientId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponents) GetUrbanization 

func (o *MultipleComponents) GetUrbanization() string

GetUrbanization returns the Urbanization field value if set, zero value otherwise.

func (*MultipleComponents) GetUrbanizationOk 

func (o *MultipleComponents) GetUrbanizationOk() (*string, bool)

GetUrbanizationOk returns a tuple with the Urbanization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponents) GetZipCode 

func (o *MultipleComponents) GetZipCode() string

GetZipCode returns the ZipCode field value if set, zero value otherwise.

func (*MultipleComponents) GetZipCodeOk 

func (o *MultipleComponents) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponents) HasCity 

func (o *MultipleComponents) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*MultipleComponents) HasRecipient 

func (o *MultipleComponents) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*MultipleComponents) HasSecondaryLine 

func (o *MultipleComponents) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*MultipleComponents) HasState 

func (o *MultipleComponents) HasState() bool

HasState returns a boolean if a field has been set.

func (*MultipleComponents) HasTransientId added in v1.1.1 

func (o *MultipleComponents) HasTransientId() bool

HasTransientId returns a boolean if a field has been set.

func (*MultipleComponents) HasUrbanization 

func (o *MultipleComponents) HasUrbanization() bool

HasUrbanization returns a boolean if a field has been set.

func (*MultipleComponents) HasZipCode 

func (o *MultipleComponents) HasZipCode() bool

HasZipCode returns a boolean if a field has been set.

func (MultipleComponents) MarshalJSON 

func (o MultipleComponents) MarshalJSON() ([]byte, error)

func (*MultipleComponents) SetCity 

func (o *MultipleComponents) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*MultipleComponents) SetPrimaryLine 

func (o *MultipleComponents) SetPrimaryLine(v string)

SetPrimaryLine sets field value

func (*MultipleComponents) SetRecipient 

func (o *MultipleComponents) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*MultipleComponents) SetRecipientNil 

func (o *MultipleComponents) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*MultipleComponents) SetSecondaryLine 

func (o *MultipleComponents) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*MultipleComponents) SetState 

func (o *MultipleComponents) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*MultipleComponents) SetTransientId added in v1.1.1 

func (o *MultipleComponents) SetTransientId(v string)

SetTransientId gets a reference to the given string and assigns it to the TransientId field.

func (*MultipleComponents) SetUrbanization 

func (o *MultipleComponents) SetUrbanization(v string)

SetUrbanization gets a reference to the given string and assigns it to the Urbanization field.

func (*MultipleComponents) SetZipCode 

func (o *MultipleComponents) SetZipCode(v string)

SetZipCode gets a reference to the given string and assigns it to the ZipCode field.

func (*MultipleComponents) UnsetRecipient 

func (o *MultipleComponents) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type MultipleComponentsIntl 

type MultipleComponentsIntl struct {
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address.
	PrimaryLine string `json:"primary_line"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	City          *string `json:"city,omitempty"`
	// The name of the state.
	State *string `json:"state,omitempty"`
	// The postal code.
	PostalCode *string         `json:"postal_code,omitempty"`
	Country    CountryExtended `json:"country"`
}

MultipleComponentsIntl struct for MultipleComponentsIntl

func NewMultipleComponentsIntl 

func NewMultipleComponentsIntl(primaryLine string, country CountryExtended) *MultipleComponentsIntl

NewMultipleComponentsIntl instantiates a new MultipleComponentsIntl object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewMultipleComponentsIntlWithDefaults 

func NewMultipleComponentsIntlWithDefaults() *MultipleComponentsIntl

NewMultipleComponentsIntlWithDefaults instantiates a new MultipleComponentsIntl object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*MultipleComponentsIntl) GetCity 

func (o *MultipleComponentsIntl) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*MultipleComponentsIntl) GetCityOk 

func (o *MultipleComponentsIntl) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponentsIntl) GetCountry 

func (o *MultipleComponentsIntl) GetCountry() CountryExtended

GetCountry returns the Country field value

func (*MultipleComponentsIntl) GetCountryOk 

func (o *MultipleComponentsIntl) GetCountryOk() (*CountryExtended, bool)

GetCountryOk returns a tuple with the Country field value and a boolean to check if the value has been set.

func (*MultipleComponentsIntl) GetPostalCode 

func (o *MultipleComponentsIntl) GetPostalCode() string

GetPostalCode returns the PostalCode field value if set, zero value otherwise.

func (*MultipleComponentsIntl) GetPostalCodeOk 

func (o *MultipleComponentsIntl) GetPostalCodeOk() (*string, bool)

GetPostalCodeOk returns a tuple with the PostalCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponentsIntl) GetPrimaryLine 

func (o *MultipleComponentsIntl) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value

func (*MultipleComponentsIntl) GetPrimaryLineOk 

func (o *MultipleComponentsIntl) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value and a boolean to check if the value has been set.

func (*MultipleComponentsIntl) GetRecipient 

func (o *MultipleComponentsIntl) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*MultipleComponentsIntl) GetRecipientOk 

func (o *MultipleComponentsIntl) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*MultipleComponentsIntl) GetSecondaryLine 

func (o *MultipleComponentsIntl) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*MultipleComponentsIntl) GetSecondaryLineOk 

func (o *MultipleComponentsIntl) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponentsIntl) GetState 

func (o *MultipleComponentsIntl) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*MultipleComponentsIntl) GetStateOk 

func (o *MultipleComponentsIntl) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MultipleComponentsIntl) HasCity 

func (o *MultipleComponentsIntl) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*MultipleComponentsIntl) HasPostalCode 

func (o *MultipleComponentsIntl) HasPostalCode() bool

HasPostalCode returns a boolean if a field has been set.

func (*MultipleComponentsIntl) HasRecipient 

func (o *MultipleComponentsIntl) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*MultipleComponentsIntl) HasSecondaryLine 

func (o *MultipleComponentsIntl) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*MultipleComponentsIntl) HasState 

func (o *MultipleComponentsIntl) HasState() bool

HasState returns a boolean if a field has been set.

func (MultipleComponentsIntl) MarshalJSON 

func (o MultipleComponentsIntl) MarshalJSON() ([]byte, error)

func (*MultipleComponentsIntl) SetCity 

func (o *MultipleComponentsIntl) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*MultipleComponentsIntl) SetCountry 

func (o *MultipleComponentsIntl) SetCountry(v CountryExtended)

SetCountry sets field value

func (*MultipleComponentsIntl) SetPostalCode 

func (o *MultipleComponentsIntl) SetPostalCode(v string)

SetPostalCode gets a reference to the given string and assigns it to the PostalCode field.

func (*MultipleComponentsIntl) SetPrimaryLine 

func (o *MultipleComponentsIntl) SetPrimaryLine(v string)

SetPrimaryLine sets field value

func (*MultipleComponentsIntl) SetRecipient 

func (o *MultipleComponentsIntl) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*MultipleComponentsIntl) SetRecipientNil 

func (o *MultipleComponentsIntl) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*MultipleComponentsIntl) SetSecondaryLine 

func (o *MultipleComponentsIntl) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*MultipleComponentsIntl) SetState 

func (o *MultipleComponentsIntl) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*MultipleComponentsIntl) UnsetRecipient 

func (o *MultipleComponentsIntl) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type MultipleComponentsList 

type MultipleComponentsList struct {
	Addresses []MultipleComponents `json:"addresses"`
}

MultipleComponentsList struct for MultipleComponentsList

func NewMultipleComponentsList 

func NewMultipleComponentsList(addresses []MultipleComponents) *MultipleComponentsList

NewMultipleComponentsList instantiates a new MultipleComponentsList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewMultipleComponentsListWithDefaults 

func NewMultipleComponentsListWithDefaults() *MultipleComponentsList

NewMultipleComponentsListWithDefaults instantiates a new MultipleComponentsList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*MultipleComponentsList) GetAddresses 

func (o *MultipleComponentsList) GetAddresses() []MultipleComponents

GetAddresses returns the Addresses field value

func (*MultipleComponentsList) GetAddressesOk 

func (o *MultipleComponentsList) GetAddressesOk() ([]MultipleComponents, bool)

GetAddressesOk returns a tuple with the Addresses field value and a boolean to check if the value has been set.

func (MultipleComponentsList) MarshalJSON 

func (o MultipleComponentsList) MarshalJSON() ([]byte, error)

func (*MultipleComponentsList) SetAddresses 

func (o *MultipleComponentsList) SetAddresses(v []MultipleComponents)

SetAddresses sets field value

type NullableAddress 

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

func NewNullableAddress 

func NewNullableAddress(val *Address) *NullableAddress

func (NullableAddress) Get 

func (v NullableAddress) Get() *Address

func (NullableAddress) IsSet 

func (v NullableAddress) IsSet() bool

func (NullableAddress) MarshalJSON 

func (v NullableAddress) MarshalJSON() ([]byte, error)

func (*NullableAddress) Set 

func (v *NullableAddress) Set(val *Address)

func (*NullableAddress) UnmarshalJSON 

func (v *NullableAddress) UnmarshalJSON(src []byte) error

func (*NullableAddress) Unset 

func (v *NullableAddress) Unset()

type NullableAddressDeletion 

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

func NewNullableAddressDeletion 

func NewNullableAddressDeletion(val *AddressDeletion) *NullableAddressDeletion

func (NullableAddressDeletion) Get 

func (v NullableAddressDeletion) Get() *AddressDeletion

func (NullableAddressDeletion) IsSet 

func (v NullableAddressDeletion) IsSet() bool

func (NullableAddressDeletion) MarshalJSON 

func (v NullableAddressDeletion) MarshalJSON() ([]byte, error)

func (*NullableAddressDeletion) Set 

func (v *NullableAddressDeletion) Set(val *AddressDeletion)

func (*NullableAddressDeletion) UnmarshalJSON 

func (v *NullableAddressDeletion) UnmarshalJSON(src []byte) error

func (*NullableAddressDeletion) Unset 

func (v *NullableAddressDeletion) Unset()

type NullableAddressDomestic 

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

func NewNullableAddressDomestic 

func NewNullableAddressDomestic(val *AddressDomestic) *NullableAddressDomestic

func (NullableAddressDomestic) Get 

func (v NullableAddressDomestic) Get() *AddressDomestic

func (NullableAddressDomestic) IsSet 

func (v NullableAddressDomestic) IsSet() bool

func (NullableAddressDomestic) MarshalJSON 

func (v NullableAddressDomestic) MarshalJSON() ([]byte, error)

func (*NullableAddressDomestic) Set 

func (v *NullableAddressDomestic) Set(val *AddressDomestic)

func (*NullableAddressDomestic) UnmarshalJSON 

func (v *NullableAddressDomestic) UnmarshalJSON(src []byte) error

func (*NullableAddressDomestic) Unset 

func (v *NullableAddressDomestic) Unset()

type NullableAddressDomesticExpanded 

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

func NewNullableAddressDomesticExpanded 

func NewNullableAddressDomesticExpanded(val *AddressDomesticExpanded) *NullableAddressDomesticExpanded

func (NullableAddressDomesticExpanded) Get 

func (v NullableAddressDomesticExpanded) Get() *AddressDomesticExpanded

func (NullableAddressDomesticExpanded) IsSet 

func (v NullableAddressDomesticExpanded) IsSet() bool

func (NullableAddressDomesticExpanded) MarshalJSON 

func (v NullableAddressDomesticExpanded) MarshalJSON() ([]byte, error)

func (*NullableAddressDomesticExpanded) Set 

func (v *NullableAddressDomesticExpanded) Set(val *AddressDomesticExpanded)

func (*NullableAddressDomesticExpanded) UnmarshalJSON 

func (v *NullableAddressDomesticExpanded) UnmarshalJSON(src []byte) error

func (*NullableAddressDomesticExpanded) Unset 

func (v *NullableAddressDomesticExpanded) Unset()

type NullableAddressEditable 

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

func NewNullableAddressEditable 

func NewNullableAddressEditable(val *AddressEditable) *NullableAddressEditable

func (NullableAddressEditable) Get 

func (v NullableAddressEditable) Get() *AddressEditable

func (NullableAddressEditable) IsSet 

func (v NullableAddressEditable) IsSet() bool

func (NullableAddressEditable) MarshalJSON 

func (v NullableAddressEditable) MarshalJSON() ([]byte, error)

func (*NullableAddressEditable) Set 

func (v *NullableAddressEditable) Set(val *AddressEditable)

func (*NullableAddressEditable) UnmarshalJSON 

func (v *NullableAddressEditable) UnmarshalJSON(src []byte) error

func (*NullableAddressEditable) Unset 

func (v *NullableAddressEditable) Unset()

type NullableAddressList 

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

func NewNullableAddressList 

func NewNullableAddressList(val *AddressList) *NullableAddressList

func (NullableAddressList) Get 

func (v NullableAddressList) Get() *AddressList

func (NullableAddressList) IsSet 

func (v NullableAddressList) IsSet() bool

func (NullableAddressList) MarshalJSON 

func (v NullableAddressList) MarshalJSON() ([]byte, error)

func (*NullableAddressList) Set 

func (v *NullableAddressList) Set(val *AddressList)

func (*NullableAddressList) UnmarshalJSON 

func (v *NullableAddressList) UnmarshalJSON(src []byte) error

func (*NullableAddressList) Unset 

func (v *NullableAddressList) Unset()

type NullableBankAccount 

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

func NewNullableBankAccount 

func NewNullableBankAccount(val *BankAccount) *NullableBankAccount

func (NullableBankAccount) Get 

func (v NullableBankAccount) Get() *BankAccount

func (NullableBankAccount) IsSet 

func (v NullableBankAccount) IsSet() bool

func (NullableBankAccount) MarshalJSON 

func (v NullableBankAccount) MarshalJSON() ([]byte, error)

func (*NullableBankAccount) Set 

func (v *NullableBankAccount) Set(val *BankAccount)

func (*NullableBankAccount) UnmarshalJSON 

func (v *NullableBankAccount) UnmarshalJSON(src []byte) error

func (*NullableBankAccount) Unset 

func (v *NullableBankAccount) Unset()

type NullableBankAccountDeletion 

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

func NewNullableBankAccountDeletion 

func NewNullableBankAccountDeletion(val *BankAccountDeletion) *NullableBankAccountDeletion

func (NullableBankAccountDeletion) Get 

func (v NullableBankAccountDeletion) Get() *BankAccountDeletion

func (NullableBankAccountDeletion) IsSet 

func (v NullableBankAccountDeletion) IsSet() bool

func (NullableBankAccountDeletion) MarshalJSON 

func (v NullableBankAccountDeletion) MarshalJSON() ([]byte, error)

func (*NullableBankAccountDeletion) Set 

func (v *NullableBankAccountDeletion) Set(val *BankAccountDeletion)

func (*NullableBankAccountDeletion) UnmarshalJSON 

func (v *NullableBankAccountDeletion) UnmarshalJSON(src []byte) error

func (*NullableBankAccountDeletion) Unset 

func (v *NullableBankAccountDeletion) Unset()

type NullableBankAccountList 

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

func NewNullableBankAccountList 

func NewNullableBankAccountList(val *BankAccountList) *NullableBankAccountList

func (NullableBankAccountList) Get 

func (v NullableBankAccountList) Get() *BankAccountList

func (NullableBankAccountList) IsSet 

func (v NullableBankAccountList) IsSet() bool

func (NullableBankAccountList) MarshalJSON 

func (v NullableBankAccountList) MarshalJSON() ([]byte, error)

func (*NullableBankAccountList) Set 

func (v *NullableBankAccountList) Set(val *BankAccountList)

func (*NullableBankAccountList) UnmarshalJSON 

func (v *NullableBankAccountList) UnmarshalJSON(src []byte) error

func (*NullableBankAccountList) Unset 

func (v *NullableBankAccountList) Unset()

type NullableBankAccountVerify 

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

func NewNullableBankAccountVerify 

func NewNullableBankAccountVerify(val *BankAccountVerify) *NullableBankAccountVerify

func (NullableBankAccountVerify) Get 

func (v NullableBankAccountVerify) Get() *BankAccountVerify

func (NullableBankAccountVerify) IsSet 

func (v NullableBankAccountVerify) IsSet() bool

func (NullableBankAccountVerify) MarshalJSON 

func (v NullableBankAccountVerify) MarshalJSON() ([]byte, error)

func (*NullableBankAccountVerify) Set 

func (v *NullableBankAccountVerify) Set(val *BankAccountVerify)

func (*NullableBankAccountVerify) UnmarshalJSON 

func (v *NullableBankAccountVerify) UnmarshalJSON(src []byte) error

func (*NullableBankAccountVerify) Unset 

func (v *NullableBankAccountVerify) Unset()

type NullableBankAccountWritable 

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

func NewNullableBankAccountWritable 

func NewNullableBankAccountWritable(val *BankAccountWritable) *NullableBankAccountWritable

func (NullableBankAccountWritable) Get 

func (v NullableBankAccountWritable) Get() *BankAccountWritable

func (NullableBankAccountWritable) IsSet 

func (v NullableBankAccountWritable) IsSet() bool

func (NullableBankAccountWritable) MarshalJSON 

func (v NullableBankAccountWritable) MarshalJSON() ([]byte, error)

func (*NullableBankAccountWritable) Set 

func (v *NullableBankAccountWritable) Set(val *BankAccountWritable)

func (*NullableBankAccountWritable) UnmarshalJSON 

func (v *NullableBankAccountWritable) UnmarshalJSON(src []byte) error

func (*NullableBankAccountWritable) Unset 

func (v *NullableBankAccountWritable) Unset()

type NullableBankTypeEnum 

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

func NewNullableBankTypeEnum 

func NewNullableBankTypeEnum(val *BankTypeEnum) *NullableBankTypeEnum

func (NullableBankTypeEnum) Get 

func (v NullableBankTypeEnum) Get() *BankTypeEnum

func (NullableBankTypeEnum) IsSet 

func (v NullableBankTypeEnum) IsSet() bool

func (NullableBankTypeEnum) MarshalJSON 

func (v NullableBankTypeEnum) MarshalJSON() ([]byte, error)

func (*NullableBankTypeEnum) Set 

func (v *NullableBankTypeEnum) Set(val *BankTypeEnum)

func (*NullableBankTypeEnum) UnmarshalJSON 

func (v *NullableBankTypeEnum) UnmarshalJSON(src []byte) error

func (*NullableBankTypeEnum) Unset 

func (v *NullableBankTypeEnum) Unset()

type NullableBillingGroup 

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

func NewNullableBillingGroup 

func NewNullableBillingGroup(val *BillingGroup) *NullableBillingGroup

func (NullableBillingGroup) Get 

func (v NullableBillingGroup) Get() *BillingGroup

func (NullableBillingGroup) IsSet 

func (v NullableBillingGroup) IsSet() bool

func (NullableBillingGroup) MarshalJSON 

func (v NullableBillingGroup) MarshalJSON() ([]byte, error)

func (*NullableBillingGroup) Set 

func (v *NullableBillingGroup) Set(val *BillingGroup)

func (*NullableBillingGroup) UnmarshalJSON 

func (v *NullableBillingGroup) UnmarshalJSON(src []byte) error

func (*NullableBillingGroup) Unset 

func (v *NullableBillingGroup) Unset()

type NullableBillingGroupEditable 

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

func NewNullableBillingGroupEditable 

func NewNullableBillingGroupEditable(val *BillingGroupEditable) *NullableBillingGroupEditable

func (NullableBillingGroupEditable) Get 

func (v NullableBillingGroupEditable) Get() *BillingGroupEditable

func (NullableBillingGroupEditable) IsSet 

func (v NullableBillingGroupEditable) IsSet() bool

func (NullableBillingGroupEditable) MarshalJSON 

func (v NullableBillingGroupEditable) MarshalJSON() ([]byte, error)

func (*NullableBillingGroupEditable) Set 

func (v *NullableBillingGroupEditable) Set(val *BillingGroupEditable)

func (*NullableBillingGroupEditable) UnmarshalJSON 

func (v *NullableBillingGroupEditable) UnmarshalJSON(src []byte) error

func (*NullableBillingGroupEditable) Unset 

func (v *NullableBillingGroupEditable) Unset()

type NullableBillingGroupList 

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

func NewNullableBillingGroupList 

func NewNullableBillingGroupList(val *BillingGroupList) *NullableBillingGroupList

func (NullableBillingGroupList) Get 

func (v NullableBillingGroupList) Get() *BillingGroupList

func (NullableBillingGroupList) IsSet 

func (v NullableBillingGroupList) IsSet() bool

func (NullableBillingGroupList) MarshalJSON 

func (v NullableBillingGroupList) MarshalJSON() ([]byte, error)

func (*NullableBillingGroupList) Set 

func (v *NullableBillingGroupList) Set(val *BillingGroupList)

func (*NullableBillingGroupList) UnmarshalJSON 

func (v *NullableBillingGroupList) UnmarshalJSON(src []byte) error

func (*NullableBillingGroupList) Unset 

func (v *NullableBillingGroupList) Unset()

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableBuckslip 

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

func NewNullableBuckslip 

func NewNullableBuckslip(val *Buckslip) *NullableBuckslip

func (NullableBuckslip) Get 

func (v NullableBuckslip) Get() *Buckslip

func (NullableBuckslip) IsSet 

func (v NullableBuckslip) IsSet() bool

func (NullableBuckslip) MarshalJSON 

func (v NullableBuckslip) MarshalJSON() ([]byte, error)

func (*NullableBuckslip) Set 

func (v *NullableBuckslip) Set(val *Buckslip)

func (*NullableBuckslip) UnmarshalJSON 

func (v *NullableBuckslip) UnmarshalJSON(src []byte) error

func (*NullableBuckslip) Unset 

func (v *NullableBuckslip) Unset()

type NullableBuckslipDeletion 

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

func NewNullableBuckslipDeletion 

func NewNullableBuckslipDeletion(val *BuckslipDeletion) *NullableBuckslipDeletion

func (NullableBuckslipDeletion) Get 

func (v NullableBuckslipDeletion) Get() *BuckslipDeletion

func (NullableBuckslipDeletion) IsSet 

func (v NullableBuckslipDeletion) IsSet() bool

func (NullableBuckslipDeletion) MarshalJSON 

func (v NullableBuckslipDeletion) MarshalJSON() ([]byte, error)

func (*NullableBuckslipDeletion) Set 

func (v *NullableBuckslipDeletion) Set(val *BuckslipDeletion)

func (*NullableBuckslipDeletion) UnmarshalJSON 

func (v *NullableBuckslipDeletion) UnmarshalJSON(src []byte) error

func (*NullableBuckslipDeletion) Unset 

func (v *NullableBuckslipDeletion) Unset()

type NullableBuckslipEditable 

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

func NewNullableBuckslipEditable 

func NewNullableBuckslipEditable(val *BuckslipEditable) *NullableBuckslipEditable

func (NullableBuckslipEditable) Get 

func (v NullableBuckslipEditable) Get() *BuckslipEditable

func (NullableBuckslipEditable) IsSet 

func (v NullableBuckslipEditable) IsSet() bool

func (NullableBuckslipEditable) MarshalJSON 

func (v NullableBuckslipEditable) MarshalJSON() ([]byte, error)

func (*NullableBuckslipEditable) Set 

func (v *NullableBuckslipEditable) Set(val *BuckslipEditable)

func (*NullableBuckslipEditable) UnmarshalJSON 

func (v *NullableBuckslipEditable) UnmarshalJSON(src []byte) error

func (*NullableBuckslipEditable) Unset 

func (v *NullableBuckslipEditable) Unset()

type NullableBuckslipOrder 

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

func NewNullableBuckslipOrder 

func NewNullableBuckslipOrder(val *BuckslipOrder) *NullableBuckslipOrder

func (NullableBuckslipOrder) Get 

func (v NullableBuckslipOrder) Get() *BuckslipOrder

func (NullableBuckslipOrder) IsSet 

func (v NullableBuckslipOrder) IsSet() bool

func (NullableBuckslipOrder) MarshalJSON 

func (v NullableBuckslipOrder) MarshalJSON() ([]byte, error)

func (*NullableBuckslipOrder) Set 

func (v *NullableBuckslipOrder) Set(val *BuckslipOrder)

func (*NullableBuckslipOrder) UnmarshalJSON 

func (v *NullableBuckslipOrder) UnmarshalJSON(src []byte) error

func (*NullableBuckslipOrder) Unset 

func (v *NullableBuckslipOrder) Unset()

type NullableBuckslipOrderEditable 

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

func NewNullableBuckslipOrderEditable 

func NewNullableBuckslipOrderEditable(val *BuckslipOrderEditable) *NullableBuckslipOrderEditable

func (NullableBuckslipOrderEditable) Get 

func (v NullableBuckslipOrderEditable) Get() *BuckslipOrderEditable

func (NullableBuckslipOrderEditable) IsSet 

func (v NullableBuckslipOrderEditable) IsSet() bool

func (NullableBuckslipOrderEditable) MarshalJSON 

func (v NullableBuckslipOrderEditable) MarshalJSON() ([]byte, error)

func (*NullableBuckslipOrderEditable) Set 

func (v *NullableBuckslipOrderEditable) Set(val *BuckslipOrderEditable)

func (*NullableBuckslipOrderEditable) UnmarshalJSON 

func (v *NullableBuckslipOrderEditable) UnmarshalJSON(src []byte) error

func (*NullableBuckslipOrderEditable) Unset 

func (v *NullableBuckslipOrderEditable) Unset()

type NullableBuckslipOrdersList 

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

func NewNullableBuckslipOrdersList 

func NewNullableBuckslipOrdersList(val *BuckslipOrdersList) *NullableBuckslipOrdersList

func (NullableBuckslipOrdersList) Get 

func (v NullableBuckslipOrdersList) Get() *BuckslipOrdersList

func (NullableBuckslipOrdersList) IsSet 

func (v NullableBuckslipOrdersList) IsSet() bool

func (NullableBuckslipOrdersList) MarshalJSON 

func (v NullableBuckslipOrdersList) MarshalJSON() ([]byte, error)

func (*NullableBuckslipOrdersList) Set 

func (v *NullableBuckslipOrdersList) Set(val *BuckslipOrdersList)

func (*NullableBuckslipOrdersList) UnmarshalJSON 

func (v *NullableBuckslipOrdersList) UnmarshalJSON(src []byte) error

func (*NullableBuckslipOrdersList) Unset 

func (v *NullableBuckslipOrdersList) Unset()

type NullableBuckslipUpdatable 

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

func NewNullableBuckslipUpdatable 

func NewNullableBuckslipUpdatable(val *BuckslipUpdatable) *NullableBuckslipUpdatable

func (NullableBuckslipUpdatable) Get 

func (v NullableBuckslipUpdatable) Get() *BuckslipUpdatable

func (NullableBuckslipUpdatable) IsSet 

func (v NullableBuckslipUpdatable) IsSet() bool

func (NullableBuckslipUpdatable) MarshalJSON 

func (v NullableBuckslipUpdatable) MarshalJSON() ([]byte, error)

func (*NullableBuckslipUpdatable) Set 

func (v *NullableBuckslipUpdatable) Set(val *BuckslipUpdatable)

func (*NullableBuckslipUpdatable) UnmarshalJSON 

func (v *NullableBuckslipUpdatable) UnmarshalJSON(src []byte) error

func (*NullableBuckslipUpdatable) Unset 

func (v *NullableBuckslipUpdatable) Unset()

type NullableBuckslipsList 

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

func NewNullableBuckslipsList 

func NewNullableBuckslipsList(val *BuckslipsList) *NullableBuckslipsList

func (NullableBuckslipsList) Get 

func (v NullableBuckslipsList) Get() *BuckslipsList

func (NullableBuckslipsList) IsSet 

func (v NullableBuckslipsList) IsSet() bool

func (NullableBuckslipsList) MarshalJSON 

func (v NullableBuckslipsList) MarshalJSON() ([]byte, error)

func (*NullableBuckslipsList) Set 

func (v *NullableBuckslipsList) Set(val *BuckslipsList)

func (*NullableBuckslipsList) UnmarshalJSON 

func (v *NullableBuckslipsList) UnmarshalJSON(src []byte) error

func (*NullableBuckslipsList) Unset 

func (v *NullableBuckslipsList) Unset()

type NullableBulkError 

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

func NewNullableBulkError 

func NewNullableBulkError(val *BulkError) *NullableBulkError

func (NullableBulkError) Get 

func (v NullableBulkError) Get() *BulkError

func (NullableBulkError) IsSet 

func (v NullableBulkError) IsSet() bool

func (NullableBulkError) MarshalJSON 

func (v NullableBulkError) MarshalJSON() ([]byte, error)

func (*NullableBulkError) Set 

func (v *NullableBulkError) Set(val *BulkError)

func (*NullableBulkError) UnmarshalJSON 

func (v *NullableBulkError) UnmarshalJSON(src []byte) error

func (*NullableBulkError) Unset 

func (v *NullableBulkError) Unset()

type NullableBulkErrorProperties 

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

func NewNullableBulkErrorProperties 

func NewNullableBulkErrorProperties(val *BulkErrorProperties) *NullableBulkErrorProperties

func (NullableBulkErrorProperties) Get 

func (v NullableBulkErrorProperties) Get() *BulkErrorProperties

func (NullableBulkErrorProperties) IsSet 

func (v NullableBulkErrorProperties) IsSet() bool

func (NullableBulkErrorProperties) MarshalJSON 

func (v NullableBulkErrorProperties) MarshalJSON() ([]byte, error)

func (*NullableBulkErrorProperties) Set 

func (v *NullableBulkErrorProperties) Set(val *BulkErrorProperties)

func (*NullableBulkErrorProperties) UnmarshalJSON 

func (v *NullableBulkErrorProperties) UnmarshalJSON(src []byte) error

func (*NullableBulkErrorProperties) Unset 

func (v *NullableBulkErrorProperties) Unset()

type NullableCampaign 

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

func NewNullableCampaign 

func NewNullableCampaign(val *Campaign) *NullableCampaign

func (NullableCampaign) Get 

func (v NullableCampaign) Get() *Campaign

func (NullableCampaign) IsSet 

func (v NullableCampaign) IsSet() bool

func (NullableCampaign) MarshalJSON 

func (v NullableCampaign) MarshalJSON() ([]byte, error)

func (*NullableCampaign) Set 

func (v *NullableCampaign) Set(val *Campaign)

func (*NullableCampaign) UnmarshalJSON 

func (v *NullableCampaign) UnmarshalJSON(src []byte) error

func (*NullableCampaign) Unset 

func (v *NullableCampaign) Unset()

type NullableCampaignCreative 

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

func NewNullableCampaignCreative 

func NewNullableCampaignCreative(val *CampaignCreative) *NullableCampaignCreative

func (NullableCampaignCreative) Get 

func (v NullableCampaignCreative) Get() *CampaignCreative

func (NullableCampaignCreative) IsSet 

func (v NullableCampaignCreative) IsSet() bool

func (NullableCampaignCreative) MarshalJSON 

func (v NullableCampaignCreative) MarshalJSON() ([]byte, error)

func (*NullableCampaignCreative) Set 

func (v *NullableCampaignCreative) Set(val *CampaignCreative)

func (*NullableCampaignCreative) UnmarshalJSON 

func (v *NullableCampaignCreative) UnmarshalJSON(src []byte) error

func (*NullableCampaignCreative) Unset 

func (v *NullableCampaignCreative) Unset()

type NullableCampaignDeletion 

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

func NewNullableCampaignDeletion 

func NewNullableCampaignDeletion(val *CampaignDeletion) *NullableCampaignDeletion

func (NullableCampaignDeletion) Get 

func (v NullableCampaignDeletion) Get() *CampaignDeletion

func (NullableCampaignDeletion) IsSet 

func (v NullableCampaignDeletion) IsSet() bool

func (NullableCampaignDeletion) MarshalJSON 

func (v NullableCampaignDeletion) MarshalJSON() ([]byte, error)

func (*NullableCampaignDeletion) Set 

func (v *NullableCampaignDeletion) Set(val *CampaignDeletion)

func (*NullableCampaignDeletion) UnmarshalJSON 

func (v *NullableCampaignDeletion) UnmarshalJSON(src []byte) error

func (*NullableCampaignDeletion) Unset 

func (v *NullableCampaignDeletion) Unset()

type NullableCampaignUpdatable 

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

func NewNullableCampaignUpdatable 

func NewNullableCampaignUpdatable(val *CampaignUpdatable) *NullableCampaignUpdatable

func (NullableCampaignUpdatable) Get 

func (v NullableCampaignUpdatable) Get() *CampaignUpdatable

func (NullableCampaignUpdatable) IsSet 

func (v NullableCampaignUpdatable) IsSet() bool

func (NullableCampaignUpdatable) MarshalJSON 

func (v NullableCampaignUpdatable) MarshalJSON() ([]byte, error)

func (*NullableCampaignUpdatable) Set 

func (v *NullableCampaignUpdatable) Set(val *CampaignUpdatable)

func (*NullableCampaignUpdatable) UnmarshalJSON 

func (v *NullableCampaignUpdatable) UnmarshalJSON(src []byte) error

func (*NullableCampaignUpdatable) Unset 

func (v *NullableCampaignUpdatable) Unset()

type NullableCampaignWritable 

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

func NewNullableCampaignWritable 

func NewNullableCampaignWritable(val *CampaignWritable) *NullableCampaignWritable

func (NullableCampaignWritable) Get 

func (v NullableCampaignWritable) Get() *CampaignWritable

func (NullableCampaignWritable) IsSet 

func (v NullableCampaignWritable) IsSet() bool

func (NullableCampaignWritable) MarshalJSON 

func (v NullableCampaignWritable) MarshalJSON() ([]byte, error)

func (*NullableCampaignWritable) Set 

func (v *NullableCampaignWritable) Set(val *CampaignWritable)

func (*NullableCampaignWritable) UnmarshalJSON 

func (v *NullableCampaignWritable) UnmarshalJSON(src []byte) error

func (*NullableCampaignWritable) Unset 

func (v *NullableCampaignWritable) Unset()

type NullableCampaignsList 

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

func NewNullableCampaignsList 

func NewNullableCampaignsList(val *CampaignsList) *NullableCampaignsList

func (NullableCampaignsList) Get 

func (v NullableCampaignsList) Get() *CampaignsList

func (NullableCampaignsList) IsSet 

func (v NullableCampaignsList) IsSet() bool

func (NullableCampaignsList) MarshalJSON 

func (v NullableCampaignsList) MarshalJSON() ([]byte, error)

func (*NullableCampaignsList) Set 

func (v *NullableCampaignsList) Set(val *CampaignsList)

func (*NullableCampaignsList) UnmarshalJSON 

func (v *NullableCampaignsList) UnmarshalJSON(src []byte) error

func (*NullableCampaignsList) Unset 

func (v *NullableCampaignsList) Unset()

type NullableCard 

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

func NewNullableCard 

func NewNullableCard(val *Card) *NullableCard

func (NullableCard) Get 

func (v NullableCard) Get() *Card

func (NullableCard) IsSet 

func (v NullableCard) IsSet() bool

func (NullableCard) MarshalJSON 

func (v NullableCard) MarshalJSON() ([]byte, error)

func (*NullableCard) Set 

func (v *NullableCard) Set(val *Card)

func (*NullableCard) UnmarshalJSON 

func (v *NullableCard) UnmarshalJSON(src []byte) error

func (*NullableCard) Unset 

func (v *NullableCard) Unset()

type NullableCardDeletion 

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

func NewNullableCardDeletion 

func NewNullableCardDeletion(val *CardDeletion) *NullableCardDeletion

func (NullableCardDeletion) Get 

func (v NullableCardDeletion) Get() *CardDeletion

func (NullableCardDeletion) IsSet 

func (v NullableCardDeletion) IsSet() bool

func (NullableCardDeletion) MarshalJSON 

func (v NullableCardDeletion) MarshalJSON() ([]byte, error)

func (*NullableCardDeletion) Set 

func (v *NullableCardDeletion) Set(val *CardDeletion)

func (*NullableCardDeletion) UnmarshalJSON 

func (v *NullableCardDeletion) UnmarshalJSON(src []byte) error

func (*NullableCardDeletion) Unset 

func (v *NullableCardDeletion) Unset()

type NullableCardEditable 

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

func NewNullableCardEditable 

func NewNullableCardEditable(val *CardEditable) *NullableCardEditable

func (NullableCardEditable) Get 

func (v NullableCardEditable) Get() *CardEditable

func (NullableCardEditable) IsSet 

func (v NullableCardEditable) IsSet() bool

func (NullableCardEditable) MarshalJSON 

func (v NullableCardEditable) MarshalJSON() ([]byte, error)

func (*NullableCardEditable) Set 

func (v *NullableCardEditable) Set(val *CardEditable)

func (*NullableCardEditable) UnmarshalJSON 

func (v *NullableCardEditable) UnmarshalJSON(src []byte) error

func (*NullableCardEditable) Unset 

func (v *NullableCardEditable) Unset()

type NullableCardList 

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

func NewNullableCardList 

func NewNullableCardList(val *CardList) *NullableCardList

func (NullableCardList) Get 

func (v NullableCardList) Get() *CardList

func (NullableCardList) IsSet 

func (v NullableCardList) IsSet() bool

func (NullableCardList) MarshalJSON 

func (v NullableCardList) MarshalJSON() ([]byte, error)

func (*NullableCardList) Set 

func (v *NullableCardList) Set(val *CardList)

func (*NullableCardList) UnmarshalJSON 

func (v *NullableCardList) UnmarshalJSON(src []byte) error

func (*NullableCardList) Unset 

func (v *NullableCardList) Unset()

type NullableCardOrder 

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

func NewNullableCardOrder 

func NewNullableCardOrder(val *CardOrder) *NullableCardOrder

func (NullableCardOrder) Get 

func (v NullableCardOrder) Get() *CardOrder

func (NullableCardOrder) IsSet 

func (v NullableCardOrder) IsSet() bool

func (NullableCardOrder) MarshalJSON 

func (v NullableCardOrder) MarshalJSON() ([]byte, error)

func (*NullableCardOrder) Set 

func (v *NullableCardOrder) Set(val *CardOrder)

func (*NullableCardOrder) UnmarshalJSON 

func (v *NullableCardOrder) UnmarshalJSON(src []byte) error

func (*NullableCardOrder) Unset 

func (v *NullableCardOrder) Unset()

type NullableCardOrderEditable 

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

func NewNullableCardOrderEditable 

func NewNullableCardOrderEditable(val *CardOrderEditable) *NullableCardOrderEditable

func (NullableCardOrderEditable) Get 

func (v NullableCardOrderEditable) Get() *CardOrderEditable

func (NullableCardOrderEditable) IsSet 

func (v NullableCardOrderEditable) IsSet() bool

func (NullableCardOrderEditable) MarshalJSON 

func (v NullableCardOrderEditable) MarshalJSON() ([]byte, error)

func (*NullableCardOrderEditable) Set 

func (v *NullableCardOrderEditable) Set(val *CardOrderEditable)

func (*NullableCardOrderEditable) UnmarshalJSON 

func (v *NullableCardOrderEditable) UnmarshalJSON(src []byte) error

func (*NullableCardOrderEditable) Unset 

func (v *NullableCardOrderEditable) Unset()

type NullableCardOrderList 

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

func NewNullableCardOrderList 

func NewNullableCardOrderList(val *CardOrderList) *NullableCardOrderList

func (NullableCardOrderList) Get 

func (v NullableCardOrderList) Get() *CardOrderList

func (NullableCardOrderList) IsSet 

func (v NullableCardOrderList) IsSet() bool

func (NullableCardOrderList) MarshalJSON 

func (v NullableCardOrderList) MarshalJSON() ([]byte, error)

func (*NullableCardOrderList) Set 

func (v *NullableCardOrderList) Set(val *CardOrderList)

func (*NullableCardOrderList) UnmarshalJSON 

func (v *NullableCardOrderList) UnmarshalJSON(src []byte) error

func (*NullableCardOrderList) Unset 

func (v *NullableCardOrderList) Unset()

type NullableCardUpdatable 

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

func NewNullableCardUpdatable 

func NewNullableCardUpdatable(val *CardUpdatable) *NullableCardUpdatable

func (NullableCardUpdatable) Get 

func (v NullableCardUpdatable) Get() *CardUpdatable

func (NullableCardUpdatable) IsSet 

func (v NullableCardUpdatable) IsSet() bool

func (NullableCardUpdatable) MarshalJSON 

func (v NullableCardUpdatable) MarshalJSON() ([]byte, error)

func (*NullableCardUpdatable) Set 

func (v *NullableCardUpdatable) Set(val *CardUpdatable)

func (*NullableCardUpdatable) UnmarshalJSON 

func (v *NullableCardUpdatable) UnmarshalJSON(src []byte) error

func (*NullableCardUpdatable) Unset 

func (v *NullableCardUpdatable) Unset()

type NullableCheck 

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

func NewNullableCheck 

func NewNullableCheck(val *Check) *NullableCheck

func (NullableCheck) Get 

func (v NullableCheck) Get() *Check

func (NullableCheck) IsSet 

func (v NullableCheck) IsSet() bool

func (NullableCheck) MarshalJSON 

func (v NullableCheck) MarshalJSON() ([]byte, error)

func (*NullableCheck) Set 

func (v *NullableCheck) Set(val *Check)

func (*NullableCheck) UnmarshalJSON 

func (v *NullableCheck) UnmarshalJSON(src []byte) error

func (*NullableCheck) Unset 

func (v *NullableCheck) Unset()

type NullableCheckDeletion 

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

func NewNullableCheckDeletion 

func NewNullableCheckDeletion(val *CheckDeletion) *NullableCheckDeletion

func (NullableCheckDeletion) Get 

func (v NullableCheckDeletion) Get() *CheckDeletion

func (NullableCheckDeletion) IsSet 

func (v NullableCheckDeletion) IsSet() bool

func (NullableCheckDeletion) MarshalJSON 

func (v NullableCheckDeletion) MarshalJSON() ([]byte, error)

func (*NullableCheckDeletion) Set 

func (v *NullableCheckDeletion) Set(val *CheckDeletion)

func (*NullableCheckDeletion) UnmarshalJSON 

func (v *NullableCheckDeletion) UnmarshalJSON(src []byte) error

func (*NullableCheckDeletion) Unset 

func (v *NullableCheckDeletion) Unset()

type NullableCheckEditable 

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

func NewNullableCheckEditable 

func NewNullableCheckEditable(val *CheckEditable) *NullableCheckEditable

func (NullableCheckEditable) Get 

func (v NullableCheckEditable) Get() *CheckEditable

func (NullableCheckEditable) IsSet 

func (v NullableCheckEditable) IsSet() bool

func (NullableCheckEditable) MarshalJSON 

func (v NullableCheckEditable) MarshalJSON() ([]byte, error)

func (*NullableCheckEditable) Set 

func (v *NullableCheckEditable) Set(val *CheckEditable)

func (*NullableCheckEditable) UnmarshalJSON 

func (v *NullableCheckEditable) UnmarshalJSON(src []byte) error

func (*NullableCheckEditable) Unset 

func (v *NullableCheckEditable) Unset()

type NullableCheckList 

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

func NewNullableCheckList 

func NewNullableCheckList(val *CheckList) *NullableCheckList

func (NullableCheckList) Get 

func (v NullableCheckList) Get() *CheckList

func (NullableCheckList) IsSet 

func (v NullableCheckList) IsSet() bool

func (NullableCheckList) MarshalJSON 

func (v NullableCheckList) MarshalJSON() ([]byte, error)

func (*NullableCheckList) Set 

func (v *NullableCheckList) Set(val *CheckList)

func (*NullableCheckList) UnmarshalJSON 

func (v *NullableCheckList) UnmarshalJSON(src []byte) error

func (*NullableCheckList) Unset 

func (v *NullableCheckList) Unset()

type NullableChkUseType 

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

func NewNullableChkUseType 

func NewNullableChkUseType(val *ChkUseType) *NullableChkUseType

func (NullableChkUseType) Get 

func (v NullableChkUseType) Get() *ChkUseType

func (NullableChkUseType) IsSet 

func (v NullableChkUseType) IsSet() bool

func (NullableChkUseType) MarshalJSON 

func (v NullableChkUseType) MarshalJSON() ([]byte, error)

func (*NullableChkUseType) Set 

func (v *NullableChkUseType) Set(val *ChkUseType)

func (*NullableChkUseType) UnmarshalJSON 

func (v *NullableChkUseType) UnmarshalJSON(src []byte) error

func (*NullableChkUseType) Unset 

func (v *NullableChkUseType) Unset()

type NullableCmpScheduleType 

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

func NewNullableCmpScheduleType 

func NewNullableCmpScheduleType(val *CmpScheduleType) *NullableCmpScheduleType

func (NullableCmpScheduleType) Get 

func (v NullableCmpScheduleType) Get() *CmpScheduleType

func (NullableCmpScheduleType) IsSet 

func (v NullableCmpScheduleType) IsSet() bool

func (NullableCmpScheduleType) MarshalJSON 

func (v NullableCmpScheduleType) MarshalJSON() ([]byte, error)

func (*NullableCmpScheduleType) Set 

func (v *NullableCmpScheduleType) Set(val *CmpScheduleType)

func (*NullableCmpScheduleType) UnmarshalJSON 

func (v *NullableCmpScheduleType) UnmarshalJSON(src []byte) error

func (*NullableCmpScheduleType) Unset 

func (v *NullableCmpScheduleType) Unset()

type NullableCmpUseType 

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

func NewNullableCmpUseType 

func NewNullableCmpUseType(val *CmpUseType) *NullableCmpUseType

func (NullableCmpUseType) Get 

func (v NullableCmpUseType) Get() *CmpUseType

func (NullableCmpUseType) IsSet 

func (v NullableCmpUseType) IsSet() bool

func (NullableCmpUseType) MarshalJSON 

func (v NullableCmpUseType) MarshalJSON() ([]byte, error)

func (*NullableCmpUseType) Set 

func (v *NullableCmpUseType) Set(val *CmpUseType)

func (*NullableCmpUseType) UnmarshalJSON 

func (v *NullableCmpUseType) UnmarshalJSON(src []byte) error

func (*NullableCmpUseType) Unset 

func (v *NullableCmpUseType) Unset()

type NullableCountryExtended 

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

func NewNullableCountryExtended 

func NewNullableCountryExtended(val *CountryExtended) *NullableCountryExtended

func (NullableCountryExtended) Get 

func (v NullableCountryExtended) Get() *CountryExtended

func (NullableCountryExtended) IsSet 

func (v NullableCountryExtended) IsSet() bool

func (NullableCountryExtended) MarshalJSON 

func (v NullableCountryExtended) MarshalJSON() ([]byte, error)

func (*NullableCountryExtended) Set 

func (v *NullableCountryExtended) Set(val *CountryExtended)

func (*NullableCountryExtended) UnmarshalJSON 

func (v *NullableCountryExtended) UnmarshalJSON(src []byte) error

func (*NullableCountryExtended) Unset 

func (v *NullableCountryExtended) Unset()

type NullableCountryExtendedExpanded 

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

func NewNullableCountryExtendedExpanded 

func NewNullableCountryExtendedExpanded(val *CountryExtendedExpanded) *NullableCountryExtendedExpanded

func (NullableCountryExtendedExpanded) Get 

func (v NullableCountryExtendedExpanded) Get() *CountryExtendedExpanded

func (NullableCountryExtendedExpanded) IsSet 

func (v NullableCountryExtendedExpanded) IsSet() bool

func (NullableCountryExtendedExpanded) MarshalJSON 

func (v NullableCountryExtendedExpanded) MarshalJSON() ([]byte, error)

func (*NullableCountryExtendedExpanded) Set 

func (v *NullableCountryExtendedExpanded) Set(val *CountryExtendedExpanded)

func (*NullableCountryExtendedExpanded) UnmarshalJSON 

func (v *NullableCountryExtendedExpanded) UnmarshalJSON(src []byte) error

func (*NullableCountryExtendedExpanded) Unset 

func (v *NullableCountryExtendedExpanded) Unset()

type NullableCreativePatch 

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

func NewNullableCreativePatch 

func NewNullableCreativePatch(val *CreativePatch) *NullableCreativePatch

func (NullableCreativePatch) Get 

func (v NullableCreativePatch) Get() *CreativePatch

func (NullableCreativePatch) IsSet 

func (v NullableCreativePatch) IsSet() bool

func (NullableCreativePatch) MarshalJSON 

func (v NullableCreativePatch) MarshalJSON() ([]byte, error)

func (*NullableCreativePatch) Set 

func (v *NullableCreativePatch) Set(val *CreativePatch)

func (*NullableCreativePatch) UnmarshalJSON 

func (v *NullableCreativePatch) UnmarshalJSON(src []byte) error

func (*NullableCreativePatch) Unset 

func (v *NullableCreativePatch) Unset()

type NullableCreativeResponse 

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

func NewNullableCreativeResponse 

func NewNullableCreativeResponse(val *CreativeResponse) *NullableCreativeResponse

func (NullableCreativeResponse) Get 

func (v NullableCreativeResponse) Get() *CreativeResponse

func (NullableCreativeResponse) IsSet 

func (v NullableCreativeResponse) IsSet() bool

func (NullableCreativeResponse) MarshalJSON 

func (v NullableCreativeResponse) MarshalJSON() ([]byte, error)

func (*NullableCreativeResponse) Set 

func (v *NullableCreativeResponse) Set(val *CreativeResponse)

func (*NullableCreativeResponse) UnmarshalJSON 

func (v *NullableCreativeResponse) UnmarshalJSON(src []byte) error

func (*NullableCreativeResponse) Unset 

func (v *NullableCreativeResponse) Unset()

type NullableCreativeWritable 

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

func NewNullableCreativeWritable 

func NewNullableCreativeWritable(val *CreativeWritable) *NullableCreativeWritable

func (NullableCreativeWritable) Get 

func (v NullableCreativeWritable) Get() *CreativeWritable

func (NullableCreativeWritable) IsSet 

func (v NullableCreativeWritable) IsSet() bool

func (NullableCreativeWritable) MarshalJSON 

func (v NullableCreativeWritable) MarshalJSON() ([]byte, error)

func (*NullableCreativeWritable) Set 

func (v *NullableCreativeWritable) Set(val *CreativeWritable)

func (*NullableCreativeWritable) UnmarshalJSON 

func (v *NullableCreativeWritable) UnmarshalJSON(src []byte) error

func (*NullableCreativeWritable) Unset 

func (v *NullableCreativeWritable) Unset()

type NullableCustomEnvelopeReturned 

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

func NewNullableCustomEnvelopeReturned 

func NewNullableCustomEnvelopeReturned(val *CustomEnvelopeReturned) *NullableCustomEnvelopeReturned

func (NullableCustomEnvelopeReturned) Get 

func (v NullableCustomEnvelopeReturned) Get() *CustomEnvelopeReturned

func (NullableCustomEnvelopeReturned) IsSet 

func (v NullableCustomEnvelopeReturned) IsSet() bool

func (NullableCustomEnvelopeReturned) MarshalJSON 

func (v NullableCustomEnvelopeReturned) MarshalJSON() ([]byte, error)

func (*NullableCustomEnvelopeReturned) Set 

func (v *NullableCustomEnvelopeReturned) Set(val *CustomEnvelopeReturned)

func (*NullableCustomEnvelopeReturned) UnmarshalJSON 

func (v *NullableCustomEnvelopeReturned) UnmarshalJSON(src []byte) error

func (*NullableCustomEnvelopeReturned) Unset 

func (v *NullableCustomEnvelopeReturned) Unset()

type NullableDeliverabilityAnalysis 

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

func NewNullableDeliverabilityAnalysis 

func NewNullableDeliverabilityAnalysis(val *DeliverabilityAnalysis) *NullableDeliverabilityAnalysis

func (NullableDeliverabilityAnalysis) Get 

func (v NullableDeliverabilityAnalysis) Get() *DeliverabilityAnalysis

func (NullableDeliverabilityAnalysis) IsSet 

func (v NullableDeliverabilityAnalysis) IsSet() bool

func (NullableDeliverabilityAnalysis) MarshalJSON 

func (v NullableDeliverabilityAnalysis) MarshalJSON() ([]byte, error)

func (*NullableDeliverabilityAnalysis) Set 

func (v *NullableDeliverabilityAnalysis) Set(val *DeliverabilityAnalysis)

func (*NullableDeliverabilityAnalysis) UnmarshalJSON 

func (v *NullableDeliverabilityAnalysis) UnmarshalJSON(src []byte) error

func (*NullableDeliverabilityAnalysis) Unset 

func (v *NullableDeliverabilityAnalysis) Unset()

type NullableDpvFootnote 

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

func NewNullableDpvFootnote 

func NewNullableDpvFootnote(val *DpvFootnote) *NullableDpvFootnote

func (NullableDpvFootnote) Get 

func (v NullableDpvFootnote) Get() *DpvFootnote

func (NullableDpvFootnote) IsSet 

func (v NullableDpvFootnote) IsSet() bool

func (NullableDpvFootnote) MarshalJSON 

func (v NullableDpvFootnote) MarshalJSON() ([]byte, error)

func (*NullableDpvFootnote) Set 

func (v *NullableDpvFootnote) Set(val *DpvFootnote)

func (*NullableDpvFootnote) UnmarshalJSON 

func (v *NullableDpvFootnote) UnmarshalJSON(src []byte) error

func (*NullableDpvFootnote) Unset 

func (v *NullableDpvFootnote) Unset()

type NullableEngineHtml 

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

func NewNullableEngineHtml 

func NewNullableEngineHtml(val *EngineHtml) *NullableEngineHtml

func (NullableEngineHtml) Get 

func (v NullableEngineHtml) Get() *EngineHtml

func (NullableEngineHtml) IsSet 

func (v NullableEngineHtml) IsSet() bool

func (NullableEngineHtml) MarshalJSON 

func (v NullableEngineHtml) MarshalJSON() ([]byte, error)

func (*NullableEngineHtml) Set 

func (v *NullableEngineHtml) Set(val *EngineHtml)

func (*NullableEngineHtml) UnmarshalJSON 

func (v *NullableEngineHtml) UnmarshalJSON(src []byte) error

func (*NullableEngineHtml) Unset 

func (v *NullableEngineHtml) Unset()

type NullableEventType 

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

func NewNullableEventType 

func NewNullableEventType(val *EventType) *NullableEventType

func (NullableEventType) Get 

func (v NullableEventType) Get() *EventType

func (NullableEventType) IsSet 

func (v NullableEventType) IsSet() bool

func (NullableEventType) MarshalJSON 

func (v NullableEventType) MarshalJSON() ([]byte, error)

func (*NullableEventType) Set 

func (v *NullableEventType) Set(val *EventType)

func (*NullableEventType) UnmarshalJSON 

func (v *NullableEventType) UnmarshalJSON(src []byte) error

func (*NullableEventType) Unset 

func (v *NullableEventType) Unset()

type NullableEvents 

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

func NewNullableEvents 

func NewNullableEvents(val *Events) *NullableEvents

func (NullableEvents) Get 

func (v NullableEvents) Get() *Events

func (NullableEvents) IsSet 

func (v NullableEvents) IsSet() bool

func (NullableEvents) MarshalJSON 

func (v NullableEvents) MarshalJSON() ([]byte, error)

func (*NullableEvents) Set 

func (v *NullableEvents) Set(val *Events)

func (*NullableEvents) UnmarshalJSON 

func (v *NullableEvents) UnmarshalJSON(src []byte) error

func (*NullableEvents) Unset 

func (v *NullableEvents) Unset()

type NullableExport 

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

func NewNullableExport 

func NewNullableExport(val *Export) *NullableExport

func (NullableExport) Get 

func (v NullableExport) Get() *Export

func (NullableExport) IsSet 

func (v NullableExport) IsSet() bool

func (NullableExport) MarshalJSON 

func (v NullableExport) MarshalJSON() ([]byte, error)

func (*NullableExport) Set 

func (v *NullableExport) Set(val *Export)

func (*NullableExport) UnmarshalJSON 

func (v *NullableExport) UnmarshalJSON(src []byte) error

func (*NullableExport) Unset 

func (v *NullableExport) Unset()

type NullableExportModel 

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

func NewNullableExportModel 

func NewNullableExportModel(val *ExportModel) *NullableExportModel

func (NullableExportModel) Get 

func (v NullableExportModel) Get() *ExportModel

func (NullableExportModel) IsSet 

func (v NullableExportModel) IsSet() bool

func (NullableExportModel) MarshalJSON 

func (v NullableExportModel) MarshalJSON() ([]byte, error)

func (*NullableExportModel) Set 

func (v *NullableExportModel) Set(val *ExportModel)

func (*NullableExportModel) UnmarshalJSON 

func (v *NullableExportModel) UnmarshalJSON(src []byte) error

func (*NullableExportModel) Unset 

func (v *NullableExportModel) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableGeocodeAddresses 

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

func NewNullableGeocodeAddresses 

func NewNullableGeocodeAddresses(val *GeocodeAddresses) *NullableGeocodeAddresses

func (NullableGeocodeAddresses) Get 

func (v NullableGeocodeAddresses) Get() *GeocodeAddresses

func (NullableGeocodeAddresses) IsSet 

func (v NullableGeocodeAddresses) IsSet() bool

func (NullableGeocodeAddresses) MarshalJSON 

func (v NullableGeocodeAddresses) MarshalJSON() ([]byte, error)

func (*NullableGeocodeAddresses) Set 

func (v *NullableGeocodeAddresses) Set(val *GeocodeAddresses)

func (*NullableGeocodeAddresses) UnmarshalJSON 

func (v *NullableGeocodeAddresses) UnmarshalJSON(src []byte) error

func (*NullableGeocodeAddresses) Unset 

func (v *NullableGeocodeAddresses) Unset()

type NullableGeocodeComponents 

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

func NewNullableGeocodeComponents 

func NewNullableGeocodeComponents(val *GeocodeComponents) *NullableGeocodeComponents

func (NullableGeocodeComponents) Get 

func (v NullableGeocodeComponents) Get() *GeocodeComponents

func (NullableGeocodeComponents) IsSet 

func (v NullableGeocodeComponents) IsSet() bool

func (NullableGeocodeComponents) MarshalJSON 

func (v NullableGeocodeComponents) MarshalJSON() ([]byte, error)

func (*NullableGeocodeComponents) Set 

func (v *NullableGeocodeComponents) Set(val *GeocodeComponents)

func (*NullableGeocodeComponents) UnmarshalJSON 

func (v *NullableGeocodeComponents) UnmarshalJSON(src []byte) error

func (*NullableGeocodeComponents) Unset 

func (v *NullableGeocodeComponents) Unset()

type NullableIdentityValidation 

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

func NewNullableIdentityValidation 

func NewNullableIdentityValidation(val *IdentityValidation) *NullableIdentityValidation

func (NullableIdentityValidation) Get 

func (v NullableIdentityValidation) Get() *IdentityValidation

func (NullableIdentityValidation) IsSet 

func (v NullableIdentityValidation) IsSet() bool

func (NullableIdentityValidation) MarshalJSON 

func (v NullableIdentityValidation) MarshalJSON() ([]byte, error)

func (*NullableIdentityValidation) Set 

func (v *NullableIdentityValidation) Set(val *IdentityValidation)

func (*NullableIdentityValidation) UnmarshalJSON 

func (v *NullableIdentityValidation) UnmarshalJSON(src []byte) error

func (*NullableIdentityValidation) Unset 

func (v *NullableIdentityValidation) Unset()

type NullableInlineObject 

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

func NewNullableInlineObject 

func NewNullableInlineObject(val *InlineObject) *NullableInlineObject

func (NullableInlineObject) Get 

func (v NullableInlineObject) Get() *InlineObject

func (NullableInlineObject) IsSet 

func (v NullableInlineObject) IsSet() bool

func (NullableInlineObject) MarshalJSON 

func (v NullableInlineObject) MarshalJSON() ([]byte, error)

func (*NullableInlineObject) Set 

func (v *NullableInlineObject) Set(val *InlineObject)

func (*NullableInlineObject) UnmarshalJSON 

func (v *NullableInlineObject) UnmarshalJSON(src []byte) error

func (*NullableInlineObject) Unset 

func (v *NullableInlineObject) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableIntlAutocompletions 

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

func NewNullableIntlAutocompletions 

func NewNullableIntlAutocompletions(val *IntlAutocompletions) *NullableIntlAutocompletions

func (NullableIntlAutocompletions) Get 

func (v NullableIntlAutocompletions) Get() *IntlAutocompletions

func (NullableIntlAutocompletions) IsSet 

func (v NullableIntlAutocompletions) IsSet() bool

func (NullableIntlAutocompletions) MarshalJSON 

func (v NullableIntlAutocompletions) MarshalJSON() ([]byte, error)

func (*NullableIntlAutocompletions) Set 

func (v *NullableIntlAutocompletions) Set(val *IntlAutocompletions)

func (*NullableIntlAutocompletions) UnmarshalJSON 

func (v *NullableIntlAutocompletions) UnmarshalJSON(src []byte) error

func (*NullableIntlAutocompletions) Unset 

func (v *NullableIntlAutocompletions) Unset()

type NullableIntlAutocompletionsWritable 

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

func NewNullableIntlAutocompletionsWritable 

func NewNullableIntlAutocompletionsWritable(val *IntlAutocompletionsWritable) *NullableIntlAutocompletionsWritable

func (NullableIntlAutocompletionsWritable) Get 

func (v NullableIntlAutocompletionsWritable) Get() *IntlAutocompletionsWritable

func (NullableIntlAutocompletionsWritable) IsSet 

func (v NullableIntlAutocompletionsWritable) IsSet() bool

func (NullableIntlAutocompletionsWritable) MarshalJSON 

func (v NullableIntlAutocompletionsWritable) MarshalJSON() ([]byte, error)

func (*NullableIntlAutocompletionsWritable) Set 

func (v *NullableIntlAutocompletionsWritable) Set(val *IntlAutocompletionsWritable)

func (*NullableIntlAutocompletionsWritable) UnmarshalJSON 

func (v *NullableIntlAutocompletionsWritable) UnmarshalJSON(src []byte) error

func (*NullableIntlAutocompletionsWritable) Unset 

func (v *NullableIntlAutocompletionsWritable) Unset()

type NullableIntlComponents 

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

func NewNullableIntlComponents 

func NewNullableIntlComponents(val *IntlComponents) *NullableIntlComponents

func (NullableIntlComponents) Get 

func (v NullableIntlComponents) Get() *IntlComponents

func (NullableIntlComponents) IsSet 

func (v NullableIntlComponents) IsSet() bool

func (NullableIntlComponents) MarshalJSON 

func (v NullableIntlComponents) MarshalJSON() ([]byte, error)

func (*NullableIntlComponents) Set 

func (v *NullableIntlComponents) Set(val *IntlComponents)

func (*NullableIntlComponents) UnmarshalJSON 

func (v *NullableIntlComponents) UnmarshalJSON(src []byte) error

func (*NullableIntlComponents) Unset 

func (v *NullableIntlComponents) Unset()

type NullableIntlSuggestions 

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

func NewNullableIntlSuggestions 

func NewNullableIntlSuggestions(val *IntlSuggestions) *NullableIntlSuggestions

func (NullableIntlSuggestions) Get 

func (v NullableIntlSuggestions) Get() *IntlSuggestions

func (NullableIntlSuggestions) IsSet 

func (v NullableIntlSuggestions) IsSet() bool

func (NullableIntlSuggestions) MarshalJSON 

func (v NullableIntlSuggestions) MarshalJSON() ([]byte, error)

func (*NullableIntlSuggestions) Set 

func (v *NullableIntlSuggestions) Set(val *IntlSuggestions)

func (*NullableIntlSuggestions) UnmarshalJSON 

func (v *NullableIntlSuggestions) UnmarshalJSON(src []byte) error

func (*NullableIntlSuggestions) Unset 

func (v *NullableIntlSuggestions) Unset()

type NullableIntlVerification 

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

func NewNullableIntlVerification 

func NewNullableIntlVerification(val *IntlVerification) *NullableIntlVerification

func (NullableIntlVerification) Get 

func (v NullableIntlVerification) Get() *IntlVerification

func (NullableIntlVerification) IsSet 

func (v NullableIntlVerification) IsSet() bool

func (NullableIntlVerification) MarshalJSON 

func (v NullableIntlVerification) MarshalJSON() ([]byte, error)

func (*NullableIntlVerification) Set 

func (v *NullableIntlVerification) Set(val *IntlVerification)

func (*NullableIntlVerification) UnmarshalJSON 

func (v *NullableIntlVerification) UnmarshalJSON(src []byte) error

func (*NullableIntlVerification) Unset 

func (v *NullableIntlVerification) Unset()

type NullableIntlVerificationOrError 

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

func NewNullableIntlVerificationOrError 

func NewNullableIntlVerificationOrError(val *IntlVerificationOrError) *NullableIntlVerificationOrError

func (NullableIntlVerificationOrError) Get 

func (v NullableIntlVerificationOrError) Get() *IntlVerificationOrError

func (NullableIntlVerificationOrError) IsSet 

func (v NullableIntlVerificationOrError) IsSet() bool

func (NullableIntlVerificationOrError) MarshalJSON 

func (v NullableIntlVerificationOrError) MarshalJSON() ([]byte, error)

func (*NullableIntlVerificationOrError) Set 

func (v *NullableIntlVerificationOrError) Set(val *IntlVerificationOrError)

func (*NullableIntlVerificationOrError) UnmarshalJSON 

func (v *NullableIntlVerificationOrError) UnmarshalJSON(src []byte) error

func (*NullableIntlVerificationOrError) Unset 

func (v *NullableIntlVerificationOrError) Unset()

type NullableIntlVerificationWritable 

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

func NewNullableIntlVerificationWritable 

func NewNullableIntlVerificationWritable(val *IntlVerificationWritable) *NullableIntlVerificationWritable

func (NullableIntlVerificationWritable) Get 

func (v NullableIntlVerificationWritable) Get() *IntlVerificationWritable

func (NullableIntlVerificationWritable) IsSet 

func (v NullableIntlVerificationWritable) IsSet() bool

func (NullableIntlVerificationWritable) MarshalJSON 

func (v NullableIntlVerificationWritable) MarshalJSON() ([]byte, error)

func (*NullableIntlVerificationWritable) Set 

func (v *NullableIntlVerificationWritable) Set(val *IntlVerificationWritable)

func (*NullableIntlVerificationWritable) UnmarshalJSON 

func (v *NullableIntlVerificationWritable) UnmarshalJSON(src []byte) error

func (*NullableIntlVerificationWritable) Unset 

func (v *NullableIntlVerificationWritable) Unset()

type NullableIntlVerifications 

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

func NewNullableIntlVerifications 

func NewNullableIntlVerifications(val *IntlVerifications) *NullableIntlVerifications

func (NullableIntlVerifications) Get 

func (v NullableIntlVerifications) Get() *IntlVerifications

func (NullableIntlVerifications) IsSet 

func (v NullableIntlVerifications) IsSet() bool

func (NullableIntlVerifications) MarshalJSON 

func (v NullableIntlVerifications) MarshalJSON() ([]byte, error)

func (*NullableIntlVerifications) Set 

func (v *NullableIntlVerifications) Set(val *IntlVerifications)

func (*NullableIntlVerifications) UnmarshalJSON 

func (v *NullableIntlVerifications) UnmarshalJSON(src []byte) error

func (*NullableIntlVerifications) Unset 

func (v *NullableIntlVerifications) Unset()

type NullableIntlVerificationsPayload 

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

func NewNullableIntlVerificationsPayload 

func NewNullableIntlVerificationsPayload(val *IntlVerificationsPayload) *NullableIntlVerificationsPayload

func (NullableIntlVerificationsPayload) Get 

func (v NullableIntlVerificationsPayload) Get() *IntlVerificationsPayload

func (NullableIntlVerificationsPayload) IsSet 

func (v NullableIntlVerificationsPayload) IsSet() bool

func (NullableIntlVerificationsPayload) MarshalJSON 

func (v NullableIntlVerificationsPayload) MarshalJSON() ([]byte, error)

func (*NullableIntlVerificationsPayload) Set 

func (v *NullableIntlVerificationsPayload) Set(val *IntlVerificationsPayload)

func (*NullableIntlVerificationsPayload) UnmarshalJSON 

func (v *NullableIntlVerificationsPayload) UnmarshalJSON(src []byte) error

func (*NullableIntlVerificationsPayload) Unset 

func (v *NullableIntlVerificationsPayload) Unset()

type NullableLetter 

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

func NewNullableLetter 

func NewNullableLetter(val *Letter) *NullableLetter

func (NullableLetter) Get 

func (v NullableLetter) Get() *Letter

func (NullableLetter) IsSet 

func (v NullableLetter) IsSet() bool

func (NullableLetter) MarshalJSON 

func (v NullableLetter) MarshalJSON() ([]byte, error)

func (*NullableLetter) Set 

func (v *NullableLetter) Set(val *Letter)

func (*NullableLetter) UnmarshalJSON 

func (v *NullableLetter) UnmarshalJSON(src []byte) error

func (*NullableLetter) Unset 

func (v *NullableLetter) Unset()

type NullableLetterCustomEnvelope 

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

func NewNullableLetterCustomEnvelope 

func NewNullableLetterCustomEnvelope(val *LetterCustomEnvelope) *NullableLetterCustomEnvelope

func (NullableLetterCustomEnvelope) Get 

func (v NullableLetterCustomEnvelope) Get() *LetterCustomEnvelope

func (NullableLetterCustomEnvelope) IsSet 

func (v NullableLetterCustomEnvelope) IsSet() bool

func (NullableLetterCustomEnvelope) MarshalJSON 

func (v NullableLetterCustomEnvelope) MarshalJSON() ([]byte, error)

func (*NullableLetterCustomEnvelope) Set 

func (v *NullableLetterCustomEnvelope) Set(val *LetterCustomEnvelope)

func (*NullableLetterCustomEnvelope) UnmarshalJSON 

func (v *NullableLetterCustomEnvelope) UnmarshalJSON(src []byte) error

func (*NullableLetterCustomEnvelope) Unset 

func (v *NullableLetterCustomEnvelope) Unset()

type NullableLetterDeletion 

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

func NewNullableLetterDeletion 

func NewNullableLetterDeletion(val *LetterDeletion) *NullableLetterDeletion

func (NullableLetterDeletion) Get 

func (v NullableLetterDeletion) Get() *LetterDeletion

func (NullableLetterDeletion) IsSet 

func (v NullableLetterDeletion) IsSet() bool

func (NullableLetterDeletion) MarshalJSON 

func (v NullableLetterDeletion) MarshalJSON() ([]byte, error)

func (*NullableLetterDeletion) Set 

func (v *NullableLetterDeletion) Set(val *LetterDeletion)

func (*NullableLetterDeletion) UnmarshalJSON 

func (v *NullableLetterDeletion) UnmarshalJSON(src []byte) error

func (*NullableLetterDeletion) Unset 

func (v *NullableLetterDeletion) Unset()

type NullableLetterDetailsReturned 

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

func NewNullableLetterDetailsReturned 

func NewNullableLetterDetailsReturned(val *LetterDetailsReturned) *NullableLetterDetailsReturned

func (NullableLetterDetailsReturned) Get 

func (v NullableLetterDetailsReturned) Get() *LetterDetailsReturned

func (NullableLetterDetailsReturned) IsSet 

func (v NullableLetterDetailsReturned) IsSet() bool

func (NullableLetterDetailsReturned) MarshalJSON 

func (v NullableLetterDetailsReturned) MarshalJSON() ([]byte, error)

func (*NullableLetterDetailsReturned) Set 

func (v *NullableLetterDetailsReturned) Set(val *LetterDetailsReturned)

func (*NullableLetterDetailsReturned) UnmarshalJSON 

func (v *NullableLetterDetailsReturned) UnmarshalJSON(src []byte) error

func (*NullableLetterDetailsReturned) Unset 

func (v *NullableLetterDetailsReturned) Unset()

type NullableLetterDetailsWritable 

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

func NewNullableLetterDetailsWritable 

func NewNullableLetterDetailsWritable(val *LetterDetailsWritable) *NullableLetterDetailsWritable

func (NullableLetterDetailsWritable) Get 

func (v NullableLetterDetailsWritable) Get() *LetterDetailsWritable

func (NullableLetterDetailsWritable) IsSet 

func (v NullableLetterDetailsWritable) IsSet() bool

func (NullableLetterDetailsWritable) MarshalJSON 

func (v NullableLetterDetailsWritable) MarshalJSON() ([]byte, error)

func (*NullableLetterDetailsWritable) Set 

func (v *NullableLetterDetailsWritable) Set(val *LetterDetailsWritable)

func (*NullableLetterDetailsWritable) UnmarshalJSON 

func (v *NullableLetterDetailsWritable) UnmarshalJSON(src []byte) error

func (*NullableLetterDetailsWritable) Unset 

func (v *NullableLetterDetailsWritable) Unset()

type NullableLetterEditable 

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

func NewNullableLetterEditable 

func NewNullableLetterEditable(val *LetterEditable) *NullableLetterEditable

func (NullableLetterEditable) Get 

func (v NullableLetterEditable) Get() *LetterEditable

func (NullableLetterEditable) IsSet 

func (v NullableLetterEditable) IsSet() bool

func (NullableLetterEditable) MarshalJSON 

func (v NullableLetterEditable) MarshalJSON() ([]byte, error)

func (*NullableLetterEditable) Set 

func (v *NullableLetterEditable) Set(val *LetterEditable)

func (*NullableLetterEditable) UnmarshalJSON 

func (v *NullableLetterEditable) UnmarshalJSON(src []byte) error

func (*NullableLetterEditable) Unset 

func (v *NullableLetterEditable) Unset()

type NullableLetterList 

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

func NewNullableLetterList 

func NewNullableLetterList(val *LetterList) *NullableLetterList

func (NullableLetterList) Get 

func (v NullableLetterList) Get() *LetterList

func (NullableLetterList) IsSet 

func (v NullableLetterList) IsSet() bool

func (NullableLetterList) MarshalJSON 

func (v NullableLetterList) MarshalJSON() ([]byte, error)

func (*NullableLetterList) Set 

func (v *NullableLetterList) Set(val *LetterList)

func (*NullableLetterList) UnmarshalJSON 

func (v *NullableLetterList) UnmarshalJSON(src []byte) error

func (*NullableLetterList) Unset 

func (v *NullableLetterList) Unset()

type NullableLobConfidenceScore 

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

func NewNullableLobConfidenceScore 

func NewNullableLobConfidenceScore(val *LobConfidenceScore) *NullableLobConfidenceScore

func (NullableLobConfidenceScore) Get 

func (v NullableLobConfidenceScore) Get() *LobConfidenceScore

func (NullableLobConfidenceScore) IsSet 

func (v NullableLobConfidenceScore) IsSet() bool

func (NullableLobConfidenceScore) MarshalJSON 

func (v NullableLobConfidenceScore) MarshalJSON() ([]byte, error)

func (*NullableLobConfidenceScore) Set 

func (v *NullableLobConfidenceScore) Set(val *LobConfidenceScore)

func (*NullableLobConfidenceScore) UnmarshalJSON 

func (v *NullableLobConfidenceScore) UnmarshalJSON(src []byte) error

func (*NullableLobConfidenceScore) Unset 

func (v *NullableLobConfidenceScore) Unset()

type NullableLobError 

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

func NewNullableLobError 

func NewNullableLobError(val *LobError) *NullableLobError

func (NullableLobError) Get 

func (v NullableLobError) Get() *LobError

func (NullableLobError) IsSet 

func (v NullableLobError) IsSet() bool

func (NullableLobError) MarshalJSON 

func (v NullableLobError) MarshalJSON() ([]byte, error)

func (*NullableLobError) Set 

func (v *NullableLobError) Set(val *LobError)

func (*NullableLobError) UnmarshalJSON 

func (v *NullableLobError) UnmarshalJSON(src []byte) error

func (*NullableLobError) Unset 

func (v *NullableLobError) Unset()

type NullableLocation 

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

func NewNullableLocation 

func NewNullableLocation(val *Location) *NullableLocation

func (NullableLocation) Get 

func (v NullableLocation) Get() *Location

func (NullableLocation) IsSet 

func (v NullableLocation) IsSet() bool

func (NullableLocation) MarshalJSON 

func (v NullableLocation) MarshalJSON() ([]byte, error)

func (*NullableLocation) Set 

func (v *NullableLocation) Set(val *Location)

func (*NullableLocation) UnmarshalJSON 

func (v *NullableLocation) UnmarshalJSON(src []byte) error

func (*NullableLocation) Unset 

func (v *NullableLocation) Unset()

type NullableLocationAnalysis 

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

func NewNullableLocationAnalysis 

func NewNullableLocationAnalysis(val *LocationAnalysis) *NullableLocationAnalysis

func (NullableLocationAnalysis) Get 

func (v NullableLocationAnalysis) Get() *LocationAnalysis

func (NullableLocationAnalysis) IsSet 

func (v NullableLocationAnalysis) IsSet() bool

func (NullableLocationAnalysis) MarshalJSON 

func (v NullableLocationAnalysis) MarshalJSON() ([]byte, error)

func (*NullableLocationAnalysis) Set 

func (v *NullableLocationAnalysis) Set(val *LocationAnalysis)

func (*NullableLocationAnalysis) UnmarshalJSON 

func (v *NullableLocationAnalysis) UnmarshalJSON(src []byte) error

func (*NullableLocationAnalysis) Unset 

func (v *NullableLocationAnalysis) Unset()

type NullableLtrUseType 

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

func NewNullableLtrUseType 

func NewNullableLtrUseType(val *LtrUseType) *NullableLtrUseType

func (NullableLtrUseType) Get 

func (v NullableLtrUseType) Get() *LtrUseType

func (NullableLtrUseType) IsSet 

func (v NullableLtrUseType) IsSet() bool

func (NullableLtrUseType) MarshalJSON 

func (v NullableLtrUseType) MarshalJSON() ([]byte, error)

func (*NullableLtrUseType) Set 

func (v *NullableLtrUseType) Set(val *LtrUseType)

func (*NullableLtrUseType) UnmarshalJSON 

func (v *NullableLtrUseType) UnmarshalJSON(src []byte) error

func (*NullableLtrUseType) Unset 

func (v *NullableLtrUseType) Unset()

type NullableMailType 

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

func NewNullableMailType 

func NewNullableMailType(val *MailType) *NullableMailType

func (NullableMailType) Get 

func (v NullableMailType) Get() *MailType

func (NullableMailType) IsSet 

func (v NullableMailType) IsSet() bool

func (NullableMailType) MarshalJSON 

func (v NullableMailType) MarshalJSON() ([]byte, error)

func (*NullableMailType) Set 

func (v *NullableMailType) Set(val *MailType)

func (*NullableMailType) UnmarshalJSON 

func (v *NullableMailType) UnmarshalJSON(src []byte) error

func (*NullableMailType) Unset 

func (v *NullableMailType) Unset()

type NullableMultiLineAddress 

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

func NewNullableMultiLineAddress 

func NewNullableMultiLineAddress(val *MultiLineAddress) *NullableMultiLineAddress

func (NullableMultiLineAddress) Get 

func (v NullableMultiLineAddress) Get() *MultiLineAddress

func (NullableMultiLineAddress) IsSet 

func (v NullableMultiLineAddress) IsSet() bool

func (NullableMultiLineAddress) MarshalJSON 

func (v NullableMultiLineAddress) MarshalJSON() ([]byte, error)

func (*NullableMultiLineAddress) Set 

func (v *NullableMultiLineAddress) Set(val *MultiLineAddress)

func (*NullableMultiLineAddress) UnmarshalJSON 

func (v *NullableMultiLineAddress) UnmarshalJSON(src []byte) error

func (*NullableMultiLineAddress) Unset 

func (v *NullableMultiLineAddress) Unset()

type NullableMultipleComponents 

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

func NewNullableMultipleComponents 

func NewNullableMultipleComponents(val *MultipleComponents) *NullableMultipleComponents

func (NullableMultipleComponents) Get 

func (v NullableMultipleComponents) Get() *MultipleComponents

func (NullableMultipleComponents) IsSet 

func (v NullableMultipleComponents) IsSet() bool

func (NullableMultipleComponents) MarshalJSON 

func (v NullableMultipleComponents) MarshalJSON() ([]byte, error)

func (*NullableMultipleComponents) Set 

func (v *NullableMultipleComponents) Set(val *MultipleComponents)

func (*NullableMultipleComponents) UnmarshalJSON 

func (v *NullableMultipleComponents) UnmarshalJSON(src []byte) error

func (*NullableMultipleComponents) Unset 

func (v *NullableMultipleComponents) Unset()

type NullableMultipleComponentsIntl 

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

func NewNullableMultipleComponentsIntl 

func NewNullableMultipleComponentsIntl(val *MultipleComponentsIntl) *NullableMultipleComponentsIntl

func (NullableMultipleComponentsIntl) Get 

func (v NullableMultipleComponentsIntl) Get() *MultipleComponentsIntl

func (NullableMultipleComponentsIntl) IsSet 

func (v NullableMultipleComponentsIntl) IsSet() bool

func (NullableMultipleComponentsIntl) MarshalJSON 

func (v NullableMultipleComponentsIntl) MarshalJSON() ([]byte, error)

func (*NullableMultipleComponentsIntl) Set 

func (v *NullableMultipleComponentsIntl) Set(val *MultipleComponentsIntl)

func (*NullableMultipleComponentsIntl) UnmarshalJSON 

func (v *NullableMultipleComponentsIntl) UnmarshalJSON(src []byte) error

func (*NullableMultipleComponentsIntl) Unset 

func (v *NullableMultipleComponentsIntl) Unset()

type NullableMultipleComponentsList 

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

func NewNullableMultipleComponentsList 

func NewNullableMultipleComponentsList(val *MultipleComponentsList) *NullableMultipleComponentsList

func (NullableMultipleComponentsList) Get 

func (v NullableMultipleComponentsList) Get() *MultipleComponentsList

func (NullableMultipleComponentsList) IsSet 

func (v NullableMultipleComponentsList) IsSet() bool

func (NullableMultipleComponentsList) MarshalJSON 

func (v NullableMultipleComponentsList) MarshalJSON() ([]byte, error)

func (*NullableMultipleComponentsList) Set 

func (v *NullableMultipleComponentsList) Set(val *MultipleComponentsList)

func (*NullableMultipleComponentsList) UnmarshalJSON 

func (v *NullableMultipleComponentsList) UnmarshalJSON(src []byte) error

func (*NullableMultipleComponentsList) Unset 

func (v *NullableMultipleComponentsList) Unset()

type NullableOptionalAddressColumnMapping 

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

func NewNullableOptionalAddressColumnMapping 

func NewNullableOptionalAddressColumnMapping(val *OptionalAddressColumnMapping) *NullableOptionalAddressColumnMapping

func (NullableOptionalAddressColumnMapping) Get 

func (v NullableOptionalAddressColumnMapping) Get() *OptionalAddressColumnMapping

func (NullableOptionalAddressColumnMapping) IsSet 

func (v NullableOptionalAddressColumnMapping) IsSet() bool

func (NullableOptionalAddressColumnMapping) MarshalJSON 

func (v NullableOptionalAddressColumnMapping) MarshalJSON() ([]byte, error)

func (*NullableOptionalAddressColumnMapping) Set 

func (v *NullableOptionalAddressColumnMapping) Set(val *OptionalAddressColumnMapping)

func (*NullableOptionalAddressColumnMapping) UnmarshalJSON 

func (v *NullableOptionalAddressColumnMapping) UnmarshalJSON(src []byte) error

func (*NullableOptionalAddressColumnMapping) Unset 

func (v *NullableOptionalAddressColumnMapping) Unset()

type NullablePlaceholderModel 

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

func NewNullablePlaceholderModel 

func NewNullablePlaceholderModel(val *PlaceholderModel) *NullablePlaceholderModel

func (NullablePlaceholderModel) Get 

func (v NullablePlaceholderModel) Get() *PlaceholderModel

func (NullablePlaceholderModel) IsSet 

func (v NullablePlaceholderModel) IsSet() bool

func (NullablePlaceholderModel) MarshalJSON 

func (v NullablePlaceholderModel) MarshalJSON() ([]byte, error)

func (*NullablePlaceholderModel) Set 

func (v *NullablePlaceholderModel) Set(val *PlaceholderModel)

func (*NullablePlaceholderModel) UnmarshalJSON 

func (v *NullablePlaceholderModel) UnmarshalJSON(src []byte) error

func (*NullablePlaceholderModel) Unset 

func (v *NullablePlaceholderModel) Unset()

type NullablePostcard 

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

func NewNullablePostcard 

func NewNullablePostcard(val *Postcard) *NullablePostcard

func (NullablePostcard) Get 

func (v NullablePostcard) Get() *Postcard

func (NullablePostcard) IsSet 

func (v NullablePostcard) IsSet() bool

func (NullablePostcard) MarshalJSON 

func (v NullablePostcard) MarshalJSON() ([]byte, error)

func (*NullablePostcard) Set 

func (v *NullablePostcard) Set(val *Postcard)

func (*NullablePostcard) UnmarshalJSON 

func (v *NullablePostcard) UnmarshalJSON(src []byte) error

func (*NullablePostcard) Unset 

func (v *NullablePostcard) Unset()

type NullablePostcardDeletion 

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

func NewNullablePostcardDeletion 

func NewNullablePostcardDeletion(val *PostcardDeletion) *NullablePostcardDeletion

func (NullablePostcardDeletion) Get 

func (v NullablePostcardDeletion) Get() *PostcardDeletion

func (NullablePostcardDeletion) IsSet 

func (v NullablePostcardDeletion) IsSet() bool

func (NullablePostcardDeletion) MarshalJSON 

func (v NullablePostcardDeletion) MarshalJSON() ([]byte, error)

func (*NullablePostcardDeletion) Set 

func (v *NullablePostcardDeletion) Set(val *PostcardDeletion)

func (*NullablePostcardDeletion) UnmarshalJSON 

func (v *NullablePostcardDeletion) UnmarshalJSON(src []byte) error

func (*NullablePostcardDeletion) Unset 

func (v *NullablePostcardDeletion) Unset()

type NullablePostcardDetailsReturned 

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

func NewNullablePostcardDetailsReturned 

func NewNullablePostcardDetailsReturned(val *PostcardDetailsReturned) *NullablePostcardDetailsReturned

func (NullablePostcardDetailsReturned) Get 

func (v NullablePostcardDetailsReturned) Get() *PostcardDetailsReturned

func (NullablePostcardDetailsReturned) IsSet 

func (v NullablePostcardDetailsReturned) IsSet() bool

func (NullablePostcardDetailsReturned) MarshalJSON 

func (v NullablePostcardDetailsReturned) MarshalJSON() ([]byte, error)

func (*NullablePostcardDetailsReturned) Set 

func (v *NullablePostcardDetailsReturned) Set(val *PostcardDetailsReturned)

func (*NullablePostcardDetailsReturned) UnmarshalJSON 

func (v *NullablePostcardDetailsReturned) UnmarshalJSON(src []byte) error

func (*NullablePostcardDetailsReturned) Unset 

func (v *NullablePostcardDetailsReturned) Unset()

type NullablePostcardDetailsWritable 

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

func NewNullablePostcardDetailsWritable 

func NewNullablePostcardDetailsWritable(val *PostcardDetailsWritable) *NullablePostcardDetailsWritable

func (NullablePostcardDetailsWritable) Get 

func (v NullablePostcardDetailsWritable) Get() *PostcardDetailsWritable

func (NullablePostcardDetailsWritable) IsSet 

func (v NullablePostcardDetailsWritable) IsSet() bool

func (NullablePostcardDetailsWritable) MarshalJSON 

func (v NullablePostcardDetailsWritable) MarshalJSON() ([]byte, error)

func (*NullablePostcardDetailsWritable) Set 

func (v *NullablePostcardDetailsWritable) Set(val *PostcardDetailsWritable)

func (*NullablePostcardDetailsWritable) UnmarshalJSON 

func (v *NullablePostcardDetailsWritable) UnmarshalJSON(src []byte) error

func (*NullablePostcardDetailsWritable) Unset 

func (v *NullablePostcardDetailsWritable) Unset()

type NullablePostcardEditable 

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

func NewNullablePostcardEditable 

func NewNullablePostcardEditable(val *PostcardEditable) *NullablePostcardEditable

func (NullablePostcardEditable) Get 

func (v NullablePostcardEditable) Get() *PostcardEditable

func (NullablePostcardEditable) IsSet 

func (v NullablePostcardEditable) IsSet() bool

func (NullablePostcardEditable) MarshalJSON 

func (v NullablePostcardEditable) MarshalJSON() ([]byte, error)

func (*NullablePostcardEditable) Set 

func (v *NullablePostcardEditable) Set(val *PostcardEditable)

func (*NullablePostcardEditable) UnmarshalJSON 

func (v *NullablePostcardEditable) UnmarshalJSON(src []byte) error

func (*NullablePostcardEditable) Unset 

func (v *NullablePostcardEditable) Unset()

type NullablePostcardList 

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

func NewNullablePostcardList 

func NewNullablePostcardList(val *PostcardList) *NullablePostcardList

func (NullablePostcardList) Get 

func (v NullablePostcardList) Get() *PostcardList

func (NullablePostcardList) IsSet 

func (v NullablePostcardList) IsSet() bool

func (NullablePostcardList) MarshalJSON 

func (v NullablePostcardList) MarshalJSON() ([]byte, error)

func (*NullablePostcardList) Set 

func (v *NullablePostcardList) Set(val *PostcardList)

func (*NullablePostcardList) UnmarshalJSON 

func (v *NullablePostcardList) UnmarshalJSON(src []byte) error

func (*NullablePostcardList) Unset 

func (v *NullablePostcardList) Unset()

type NullablePostcardSize 

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

func NewNullablePostcardSize 

func NewNullablePostcardSize(val *PostcardSize) *NullablePostcardSize

func (NullablePostcardSize) Get 

func (v NullablePostcardSize) Get() *PostcardSize

func (NullablePostcardSize) IsSet 

func (v NullablePostcardSize) IsSet() bool

func (NullablePostcardSize) MarshalJSON 

func (v NullablePostcardSize) MarshalJSON() ([]byte, error)

func (*NullablePostcardSize) Set 

func (v *NullablePostcardSize) Set(val *PostcardSize)

func (*NullablePostcardSize) UnmarshalJSON 

func (v *NullablePostcardSize) UnmarshalJSON(src []byte) error

func (*NullablePostcardSize) Unset 

func (v *NullablePostcardSize) Unset()

type NullablePscUseType 

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

func NewNullablePscUseType 

func NewNullablePscUseType(val *PscUseType) *NullablePscUseType

func (NullablePscUseType) Get 

func (v NullablePscUseType) Get() *PscUseType

func (NullablePscUseType) IsSet 

func (v NullablePscUseType) IsSet() bool

func (NullablePscUseType) MarshalJSON 

func (v NullablePscUseType) MarshalJSON() ([]byte, error)

func (*NullablePscUseType) Set 

func (v *NullablePscUseType) Set(val *PscUseType)

func (*NullablePscUseType) UnmarshalJSON 

func (v *NullablePscUseType) UnmarshalJSON(src []byte) error

func (*NullablePscUseType) Unset 

func (v *NullablePscUseType) Unset()

type NullableQrCode 

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

func NewNullableQrCode 

func NewNullableQrCode(val *QrCode) *NullableQrCode

func (NullableQrCode) Get 

func (v NullableQrCode) Get() *QrCode

func (NullableQrCode) IsSet 

func (v NullableQrCode) IsSet() bool

func (NullableQrCode) MarshalJSON 

func (v NullableQrCode) MarshalJSON() ([]byte, error)

func (*NullableQrCode) Set 

func (v *NullableQrCode) Set(val *QrCode)

func (*NullableQrCode) UnmarshalJSON 

func (v *NullableQrCode) UnmarshalJSON(src []byte) error

func (*NullableQrCode) Unset 

func (v *NullableQrCode) Unset()

type NullableRequiredAddressColumnMapping 

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

func NewNullableRequiredAddressColumnMapping 

func NewNullableRequiredAddressColumnMapping(val *RequiredAddressColumnMapping) *NullableRequiredAddressColumnMapping

func (NullableRequiredAddressColumnMapping) Get 

func (v NullableRequiredAddressColumnMapping) Get() *RequiredAddressColumnMapping

func (NullableRequiredAddressColumnMapping) IsSet 

func (v NullableRequiredAddressColumnMapping) IsSet() bool

func (NullableRequiredAddressColumnMapping) MarshalJSON 

func (v NullableRequiredAddressColumnMapping) MarshalJSON() ([]byte, error)

func (*NullableRequiredAddressColumnMapping) Set 

func (v *NullableRequiredAddressColumnMapping) Set(val *RequiredAddressColumnMapping)

func (*NullableRequiredAddressColumnMapping) UnmarshalJSON 

func (v *NullableRequiredAddressColumnMapping) UnmarshalJSON(src []byte) error

func (*NullableRequiredAddressColumnMapping) Unset 

func (v *NullableRequiredAddressColumnMapping) Unset()

type NullableReturnEnvelope 

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

func NewNullableReturnEnvelope 

func NewNullableReturnEnvelope(val *ReturnEnvelope) *NullableReturnEnvelope

func (NullableReturnEnvelope) Get 

func (v NullableReturnEnvelope) Get() *ReturnEnvelope

func (NullableReturnEnvelope) IsSet 

func (v NullableReturnEnvelope) IsSet() bool

func (NullableReturnEnvelope) MarshalJSON 

func (v NullableReturnEnvelope) MarshalJSON() ([]byte, error)

func (*NullableReturnEnvelope) Set 

func (v *NullableReturnEnvelope) Set(val *ReturnEnvelope)

func (*NullableReturnEnvelope) UnmarshalJSON 

func (v *NullableReturnEnvelope) UnmarshalJSON(src []byte) error

func (*NullableReturnEnvelope) Unset 

func (v *NullableReturnEnvelope) Unset()

type NullableReverseGeocode 

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

func NewNullableReverseGeocode 

func NewNullableReverseGeocode(val *ReverseGeocode) *NullableReverseGeocode

func (NullableReverseGeocode) Get 

func (v NullableReverseGeocode) Get() *ReverseGeocode

func (NullableReverseGeocode) IsSet 

func (v NullableReverseGeocode) IsSet() bool

func (NullableReverseGeocode) MarshalJSON 

func (v NullableReverseGeocode) MarshalJSON() ([]byte, error)

func (*NullableReverseGeocode) Set 

func (v *NullableReverseGeocode) Set(val *ReverseGeocode)

func (*NullableReverseGeocode) UnmarshalJSON 

func (v *NullableReverseGeocode) UnmarshalJSON(src []byte) error

func (*NullableReverseGeocode) Unset 

func (v *NullableReverseGeocode) Unset()

type NullableSelfMailer 

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

func NewNullableSelfMailer 

func NewNullableSelfMailer(val *SelfMailer) *NullableSelfMailer

func (NullableSelfMailer) Get 

func (v NullableSelfMailer) Get() *SelfMailer

func (NullableSelfMailer) IsSet 

func (v NullableSelfMailer) IsSet() bool

func (NullableSelfMailer) MarshalJSON 

func (v NullableSelfMailer) MarshalJSON() ([]byte, error)

func (*NullableSelfMailer) Set 

func (v *NullableSelfMailer) Set(val *SelfMailer)

func (*NullableSelfMailer) UnmarshalJSON 

func (v *NullableSelfMailer) UnmarshalJSON(src []byte) error

func (*NullableSelfMailer) Unset 

func (v *NullableSelfMailer) Unset()

type NullableSelfMailerDeletion 

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

func NewNullableSelfMailerDeletion 

func NewNullableSelfMailerDeletion(val *SelfMailerDeletion) *NullableSelfMailerDeletion

func (NullableSelfMailerDeletion) Get 

func (v NullableSelfMailerDeletion) Get() *SelfMailerDeletion

func (NullableSelfMailerDeletion) IsSet 

func (v NullableSelfMailerDeletion) IsSet() bool

func (NullableSelfMailerDeletion) MarshalJSON 

func (v NullableSelfMailerDeletion) MarshalJSON() ([]byte, error)

func (*NullableSelfMailerDeletion) Set 

func (v *NullableSelfMailerDeletion) Set(val *SelfMailerDeletion)

func (*NullableSelfMailerDeletion) UnmarshalJSON 

func (v *NullableSelfMailerDeletion) UnmarshalJSON(src []byte) error

func (*NullableSelfMailerDeletion) Unset 

func (v *NullableSelfMailerDeletion) Unset()

type NullableSelfMailerEditable 

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

func NewNullableSelfMailerEditable 

func NewNullableSelfMailerEditable(val *SelfMailerEditable) *NullableSelfMailerEditable

func (NullableSelfMailerEditable) Get 

func (v NullableSelfMailerEditable) Get() *SelfMailerEditable

func (NullableSelfMailerEditable) IsSet 

func (v NullableSelfMailerEditable) IsSet() bool

func (NullableSelfMailerEditable) MarshalJSON 

func (v NullableSelfMailerEditable) MarshalJSON() ([]byte, error)

func (*NullableSelfMailerEditable) Set 

func (v *NullableSelfMailerEditable) Set(val *SelfMailerEditable)

func (*NullableSelfMailerEditable) UnmarshalJSON 

func (v *NullableSelfMailerEditable) UnmarshalJSON(src []byte) error

func (*NullableSelfMailerEditable) Unset 

func (v *NullableSelfMailerEditable) Unset()

type NullableSelfMailerList 

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

func NewNullableSelfMailerList 

func NewNullableSelfMailerList(val *SelfMailerList) *NullableSelfMailerList

func (NullableSelfMailerList) Get 

func (v NullableSelfMailerList) Get() *SelfMailerList

func (NullableSelfMailerList) IsSet 

func (v NullableSelfMailerList) IsSet() bool

func (NullableSelfMailerList) MarshalJSON 

func (v NullableSelfMailerList) MarshalJSON() ([]byte, error)

func (*NullableSelfMailerList) Set 

func (v *NullableSelfMailerList) Set(val *SelfMailerList)

func (*NullableSelfMailerList) UnmarshalJSON 

func (v *NullableSelfMailerList) UnmarshalJSON(src []byte) error

func (*NullableSelfMailerList) Unset 

func (v *NullableSelfMailerList) Unset()

type NullableSelfMailerSize 

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

func NewNullableSelfMailerSize 

func NewNullableSelfMailerSize(val *SelfMailerSize) *NullableSelfMailerSize

func (NullableSelfMailerSize) Get 

func (v NullableSelfMailerSize) Get() *SelfMailerSize

func (NullableSelfMailerSize) IsSet 

func (v NullableSelfMailerSize) IsSet() bool

func (NullableSelfMailerSize) MarshalJSON 

func (v NullableSelfMailerSize) MarshalJSON() ([]byte, error)

func (*NullableSelfMailerSize) Set 

func (v *NullableSelfMailerSize) Set(val *SelfMailerSize)

func (*NullableSelfMailerSize) UnmarshalJSON 

func (v *NullableSelfMailerSize) UnmarshalJSON(src []byte) error

func (*NullableSelfMailerSize) Unset 

func (v *NullableSelfMailerSize) Unset()

type NullableSfmUseType 

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

func NewNullableSfmUseType 

func NewNullableSfmUseType(val *SfmUseType) *NullableSfmUseType

func (NullableSfmUseType) Get 

func (v NullableSfmUseType) Get() *SfmUseType

func (NullableSfmUseType) IsSet 

func (v NullableSfmUseType) IsSet() bool

func (NullableSfmUseType) MarshalJSON 

func (v NullableSfmUseType) MarshalJSON() ([]byte, error)

func (*NullableSfmUseType) Set 

func (v *NullableSfmUseType) Set(val *SfmUseType)

func (*NullableSfmUseType) UnmarshalJSON 

func (v *NullableSfmUseType) UnmarshalJSON(src []byte) error

func (*NullableSfmUseType) Unset 

func (v *NullableSfmUseType) Unset()

type NullableSortBy 

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

func NewNullableSortBy 

func NewNullableSortBy(val *SortBy) *NullableSortBy

func (NullableSortBy) Get 

func (v NullableSortBy) Get() *SortBy

func (NullableSortBy) IsSet 

func (v NullableSortBy) IsSet() bool

func (NullableSortBy) MarshalJSON 

func (v NullableSortBy) MarshalJSON() ([]byte, error)

func (*NullableSortBy) Set 

func (v *NullableSortBy) Set(val *SortBy)

func (*NullableSortBy) UnmarshalJSON 

func (v *NullableSortBy) UnmarshalJSON(src []byte) error

func (*NullableSortBy) Unset 

func (v *NullableSortBy) Unset()

type NullableSortBy1 

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

func NewNullableSortBy1 

func NewNullableSortBy1(val *SortBy1) *NullableSortBy1

func (NullableSortBy1) Get 

func (v NullableSortBy1) Get() *SortBy1

func (NullableSortBy1) IsSet 

func (v NullableSortBy1) IsSet() bool

func (NullableSortBy1) MarshalJSON 

func (v NullableSortBy1) MarshalJSON() ([]byte, error)

func (*NullableSortBy1) Set 

func (v *NullableSortBy1) Set(val *SortBy1)

func (*NullableSortBy1) UnmarshalJSON 

func (v *NullableSortBy1) UnmarshalJSON(src []byte) error

func (*NullableSortBy1) Unset 

func (v *NullableSortBy1) Unset()

type NullableSortBy2 

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

func NewNullableSortBy2 

func NewNullableSortBy2(val *SortBy2) *NullableSortBy2

func (NullableSortBy2) Get 

func (v NullableSortBy2) Get() *SortBy2

func (NullableSortBy2) IsSet 

func (v NullableSortBy2) IsSet() bool

func (NullableSortBy2) MarshalJSON 

func (v NullableSortBy2) MarshalJSON() ([]byte, error)

func (*NullableSortBy2) Set 

func (v *NullableSortBy2) Set(val *SortBy2)

func (*NullableSortBy2) UnmarshalJSON 

func (v *NullableSortBy2) UnmarshalJSON(src []byte) error

func (*NullableSortBy2) Unset 

func (v *NullableSortBy2) Unset()

type NullableSortBy3 

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

func NewNullableSortBy3 

func NewNullableSortBy3(val *SortBy3) *NullableSortBy3

func (NullableSortBy3) Get 

func (v NullableSortBy3) Get() *SortBy3

func (NullableSortBy3) IsSet 

func (v NullableSortBy3) IsSet() bool

func (NullableSortBy3) MarshalJSON 

func (v NullableSortBy3) MarshalJSON() ([]byte, error)

func (*NullableSortBy3) Set 

func (v *NullableSortBy3) Set(val *SortBy3)

func (*NullableSortBy3) UnmarshalJSON 

func (v *NullableSortBy3) UnmarshalJSON(src []byte) error

func (*NullableSortBy3) Unset 

func (v *NullableSortBy3) Unset()

type NullableSortByDateModified 

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

func NewNullableSortByDateModified 

func NewNullableSortByDateModified(val *SortByDateModified) *NullableSortByDateModified

func (NullableSortByDateModified) Get 

func (v NullableSortByDateModified) Get() *SortByDateModified

func (NullableSortByDateModified) IsSet 

func (v NullableSortByDateModified) IsSet() bool

func (NullableSortByDateModified) MarshalJSON 

func (v NullableSortByDateModified) MarshalJSON() ([]byte, error)

func (*NullableSortByDateModified) Set 

func (v *NullableSortByDateModified) Set(val *SortByDateModified)

func (*NullableSortByDateModified) UnmarshalJSON 

func (v *NullableSortByDateModified) UnmarshalJSON(src []byte) error

func (*NullableSortByDateModified) Unset 

func (v *NullableSortByDateModified) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableSuggestions 

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

func NewNullableSuggestions 

func NewNullableSuggestions(val *Suggestions) *NullableSuggestions

func (NullableSuggestions) Get 

func (v NullableSuggestions) Get() *Suggestions

func (NullableSuggestions) IsSet 

func (v NullableSuggestions) IsSet() bool

func (NullableSuggestions) MarshalJSON 

func (v NullableSuggestions) MarshalJSON() ([]byte, error)

func (*NullableSuggestions) Set 

func (v *NullableSuggestions) Set(val *Suggestions)

func (*NullableSuggestions) UnmarshalJSON 

func (v *NullableSuggestions) UnmarshalJSON(src []byte) error

func (*NullableSuggestions) Unset 

func (v *NullableSuggestions) Unset()

type NullableTemplate 

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

func NewNullableTemplate 

func NewNullableTemplate(val *Template) *NullableTemplate

func (NullableTemplate) Get 

func (v NullableTemplate) Get() *Template

func (NullableTemplate) IsSet 

func (v NullableTemplate) IsSet() bool

func (NullableTemplate) MarshalJSON 

func (v NullableTemplate) MarshalJSON() ([]byte, error)

func (*NullableTemplate) Set 

func (v *NullableTemplate) Set(val *Template)

func (*NullableTemplate) UnmarshalJSON 

func (v *NullableTemplate) UnmarshalJSON(src []byte) error

func (*NullableTemplate) Unset 

func (v *NullableTemplate) Unset()

type NullableTemplateDeletion 

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

func NewNullableTemplateDeletion 

func NewNullableTemplateDeletion(val *TemplateDeletion) *NullableTemplateDeletion

func (NullableTemplateDeletion) Get 

func (v NullableTemplateDeletion) Get() *TemplateDeletion

func (NullableTemplateDeletion) IsSet 

func (v NullableTemplateDeletion) IsSet() bool

func (NullableTemplateDeletion) MarshalJSON 

func (v NullableTemplateDeletion) MarshalJSON() ([]byte, error)

func (*NullableTemplateDeletion) Set 

func (v *NullableTemplateDeletion) Set(val *TemplateDeletion)

func (*NullableTemplateDeletion) UnmarshalJSON 

func (v *NullableTemplateDeletion) UnmarshalJSON(src []byte) error

func (*NullableTemplateDeletion) Unset 

func (v *NullableTemplateDeletion) Unset()

type NullableTemplateList 

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

func NewNullableTemplateList 

func NewNullableTemplateList(val *TemplateList) *NullableTemplateList

func (NullableTemplateList) Get 

func (v NullableTemplateList) Get() *TemplateList

func (NullableTemplateList) IsSet 

func (v NullableTemplateList) IsSet() bool

func (NullableTemplateList) MarshalJSON 

func (v NullableTemplateList) MarshalJSON() ([]byte, error)

func (*NullableTemplateList) Set 

func (v *NullableTemplateList) Set(val *TemplateList)

func (*NullableTemplateList) UnmarshalJSON 

func (v *NullableTemplateList) UnmarshalJSON(src []byte) error

func (*NullableTemplateList) Unset 

func (v *NullableTemplateList) Unset()

type NullableTemplateUpdate 

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

func NewNullableTemplateUpdate 

func NewNullableTemplateUpdate(val *TemplateUpdate) *NullableTemplateUpdate

func (NullableTemplateUpdate) Get 

func (v NullableTemplateUpdate) Get() *TemplateUpdate

func (NullableTemplateUpdate) IsSet 

func (v NullableTemplateUpdate) IsSet() bool

func (NullableTemplateUpdate) MarshalJSON 

func (v NullableTemplateUpdate) MarshalJSON() ([]byte, error)

func (*NullableTemplateUpdate) Set 

func (v *NullableTemplateUpdate) Set(val *TemplateUpdate)

func (*NullableTemplateUpdate) UnmarshalJSON 

func (v *NullableTemplateUpdate) UnmarshalJSON(src []byte) error

func (*NullableTemplateUpdate) Unset 

func (v *NullableTemplateUpdate) Unset()

type NullableTemplateVersion 

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

func NewNullableTemplateVersion 

func NewNullableTemplateVersion(val *TemplateVersion) *NullableTemplateVersion

func (NullableTemplateVersion) Get 

func (v NullableTemplateVersion) Get() *TemplateVersion

func (NullableTemplateVersion) IsSet 

func (v NullableTemplateVersion) IsSet() bool

func (NullableTemplateVersion) MarshalJSON 

func (v NullableTemplateVersion) MarshalJSON() ([]byte, error)

func (*NullableTemplateVersion) Set 

func (v *NullableTemplateVersion) Set(val *TemplateVersion)

func (*NullableTemplateVersion) UnmarshalJSON 

func (v *NullableTemplateVersion) UnmarshalJSON(src []byte) error

func (*NullableTemplateVersion) Unset 

func (v *NullableTemplateVersion) Unset()

type NullableTemplateVersionDeletion 

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

func NewNullableTemplateVersionDeletion 

func NewNullableTemplateVersionDeletion(val *TemplateVersionDeletion) *NullableTemplateVersionDeletion

func (NullableTemplateVersionDeletion) Get 

func (v NullableTemplateVersionDeletion) Get() *TemplateVersionDeletion

func (NullableTemplateVersionDeletion) IsSet 

func (v NullableTemplateVersionDeletion) IsSet() bool

func (NullableTemplateVersionDeletion) MarshalJSON 

func (v NullableTemplateVersionDeletion) MarshalJSON() ([]byte, error)

func (*NullableTemplateVersionDeletion) Set 

func (v *NullableTemplateVersionDeletion) Set(val *TemplateVersionDeletion)

func (*NullableTemplateVersionDeletion) UnmarshalJSON 

func (v *NullableTemplateVersionDeletion) UnmarshalJSON(src []byte) error

func (*NullableTemplateVersionDeletion) Unset 

func (v *NullableTemplateVersionDeletion) Unset()

type NullableTemplateVersionList 

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

func NewNullableTemplateVersionList 

func NewNullableTemplateVersionList(val *TemplateVersionList) *NullableTemplateVersionList

func (NullableTemplateVersionList) Get 

func (v NullableTemplateVersionList) Get() *TemplateVersionList

func (NullableTemplateVersionList) IsSet 

func (v NullableTemplateVersionList) IsSet() bool

func (NullableTemplateVersionList) MarshalJSON 

func (v NullableTemplateVersionList) MarshalJSON() ([]byte, error)

func (*NullableTemplateVersionList) Set 

func (v *NullableTemplateVersionList) Set(val *TemplateVersionList)

func (*NullableTemplateVersionList) UnmarshalJSON 

func (v *NullableTemplateVersionList) UnmarshalJSON(src []byte) error

func (*NullableTemplateVersionList) Unset 

func (v *NullableTemplateVersionList) Unset()

type NullableTemplateVersionUpdatable 

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

func NewNullableTemplateVersionUpdatable 

func NewNullableTemplateVersionUpdatable(val *TemplateVersionUpdatable) *NullableTemplateVersionUpdatable

func (NullableTemplateVersionUpdatable) Get 

func (v NullableTemplateVersionUpdatable) Get() *TemplateVersionUpdatable

func (NullableTemplateVersionUpdatable) IsSet 

func (v NullableTemplateVersionUpdatable) IsSet() bool

func (NullableTemplateVersionUpdatable) MarshalJSON 

func (v NullableTemplateVersionUpdatable) MarshalJSON() ([]byte, error)

func (*NullableTemplateVersionUpdatable) Set 

func (v *NullableTemplateVersionUpdatable) Set(val *TemplateVersionUpdatable)

func (*NullableTemplateVersionUpdatable) UnmarshalJSON 

func (v *NullableTemplateVersionUpdatable) UnmarshalJSON(src []byte) error

func (*NullableTemplateVersionUpdatable) Unset 

func (v *NullableTemplateVersionUpdatable) Unset()

type NullableTemplateVersionWritable 

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

func NewNullableTemplateVersionWritable 

func NewNullableTemplateVersionWritable(val *TemplateVersionWritable) *NullableTemplateVersionWritable

func (NullableTemplateVersionWritable) Get 

func (v NullableTemplateVersionWritable) Get() *TemplateVersionWritable

func (NullableTemplateVersionWritable) IsSet 

func (v NullableTemplateVersionWritable) IsSet() bool

func (NullableTemplateVersionWritable) MarshalJSON 

func (v NullableTemplateVersionWritable) MarshalJSON() ([]byte, error)

func (*NullableTemplateVersionWritable) Set 

func (v *NullableTemplateVersionWritable) Set(val *TemplateVersionWritable)

func (*NullableTemplateVersionWritable) UnmarshalJSON 

func (v *NullableTemplateVersionWritable) UnmarshalJSON(src []byte) error

func (*NullableTemplateVersionWritable) Unset 

func (v *NullableTemplateVersionWritable) Unset()

type NullableTemplateWritable 

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

func NewNullableTemplateWritable 

func NewNullableTemplateWritable(val *TemplateWritable) *NullableTemplateWritable

func (NullableTemplateWritable) Get 

func (v NullableTemplateWritable) Get() *TemplateWritable

func (NullableTemplateWritable) IsSet 

func (v NullableTemplateWritable) IsSet() bool

func (NullableTemplateWritable) MarshalJSON 

func (v NullableTemplateWritable) MarshalJSON() ([]byte, error)

func (*NullableTemplateWritable) Set 

func (v *NullableTemplateWritable) Set(val *TemplateWritable)

func (*NullableTemplateWritable) UnmarshalJSON 

func (v *NullableTemplateWritable) UnmarshalJSON(src []byte) error

func (*NullableTemplateWritable) Unset 

func (v *NullableTemplateWritable) Unset()

type NullableThumbnail 

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

func NewNullableThumbnail 

func NewNullableThumbnail(val *Thumbnail) *NullableThumbnail

func (NullableThumbnail) Get 

func (v NullableThumbnail) Get() *Thumbnail

func (NullableThumbnail) IsSet 

func (v NullableThumbnail) IsSet() bool

func (NullableThumbnail) MarshalJSON 

func (v NullableThumbnail) MarshalJSON() ([]byte, error)

func (*NullableThumbnail) Set 

func (v *NullableThumbnail) Set(val *Thumbnail)

func (*NullableThumbnail) UnmarshalJSON 

func (v *NullableThumbnail) UnmarshalJSON(src []byte) error

func (*NullableThumbnail) Unset 

func (v *NullableThumbnail) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type NullableTrackingEventCertified 

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

func NewNullableTrackingEventCertified 

func NewNullableTrackingEventCertified(val *TrackingEventCertified) *NullableTrackingEventCertified

func (NullableTrackingEventCertified) Get 

func (v NullableTrackingEventCertified) Get() *TrackingEventCertified

func (NullableTrackingEventCertified) IsSet 

func (v NullableTrackingEventCertified) IsSet() bool

func (NullableTrackingEventCertified) MarshalJSON 

func (v NullableTrackingEventCertified) MarshalJSON() ([]byte, error)

func (*NullableTrackingEventCertified) Set 

func (v *NullableTrackingEventCertified) Set(val *TrackingEventCertified)

func (*NullableTrackingEventCertified) UnmarshalJSON 

func (v *NullableTrackingEventCertified) UnmarshalJSON(src []byte) error

func (*NullableTrackingEventCertified) Unset 

func (v *NullableTrackingEventCertified) Unset()

type NullableTrackingEventDetails 

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

func NewNullableTrackingEventDetails 

func NewNullableTrackingEventDetails(val *TrackingEventDetails) *NullableTrackingEventDetails

func (NullableTrackingEventDetails) Get 

func (v NullableTrackingEventDetails) Get() *TrackingEventDetails

func (NullableTrackingEventDetails) IsSet 

func (v NullableTrackingEventDetails) IsSet() bool

func (NullableTrackingEventDetails) MarshalJSON 

func (v NullableTrackingEventDetails) MarshalJSON() ([]byte, error)

func (*NullableTrackingEventDetails) Set 

func (v *NullableTrackingEventDetails) Set(val *TrackingEventDetails)

func (*NullableTrackingEventDetails) UnmarshalJSON 

func (v *NullableTrackingEventDetails) UnmarshalJSON(src []byte) error

func (*NullableTrackingEventDetails) Unset 

func (v *NullableTrackingEventDetails) Unset()

type NullableTrackingEventNormal 

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

func NewNullableTrackingEventNormal 

func NewNullableTrackingEventNormal(val *TrackingEventNormal) *NullableTrackingEventNormal

func (NullableTrackingEventNormal) Get 

func (v NullableTrackingEventNormal) Get() *TrackingEventNormal

func (NullableTrackingEventNormal) IsSet 

func (v NullableTrackingEventNormal) IsSet() bool

func (NullableTrackingEventNormal) MarshalJSON 

func (v NullableTrackingEventNormal) MarshalJSON() ([]byte, error)

func (*NullableTrackingEventNormal) Set 

func (v *NullableTrackingEventNormal) Set(val *TrackingEventNormal)

func (*NullableTrackingEventNormal) UnmarshalJSON 

func (v *NullableTrackingEventNormal) UnmarshalJSON(src []byte) error

func (*NullableTrackingEventNormal) Unset 

func (v *NullableTrackingEventNormal) Unset()

type NullableUpload 

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

func NewNullableUpload 

func NewNullableUpload(val *Upload) *NullableUpload

func (NullableUpload) Get 

func (v NullableUpload) Get() *Upload

func (NullableUpload) IsSet 

func (v NullableUpload) IsSet() bool

func (NullableUpload) MarshalJSON 

func (v NullableUpload) MarshalJSON() ([]byte, error)

func (*NullableUpload) Set 

func (v *NullableUpload) Set(val *Upload)

func (*NullableUpload) UnmarshalJSON 

func (v *NullableUpload) UnmarshalJSON(src []byte) error

func (*NullableUpload) Unset 

func (v *NullableUpload) Unset()

type NullableUploadCreateExport 

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

func NewNullableUploadCreateExport 

func NewNullableUploadCreateExport(val *UploadCreateExport) *NullableUploadCreateExport

func (NullableUploadCreateExport) Get 

func (v NullableUploadCreateExport) Get() *UploadCreateExport

func (NullableUploadCreateExport) IsSet 

func (v NullableUploadCreateExport) IsSet() bool

func (NullableUploadCreateExport) MarshalJSON 

func (v NullableUploadCreateExport) MarshalJSON() ([]byte, error)

func (*NullableUploadCreateExport) Set 

func (v *NullableUploadCreateExport) Set(val *UploadCreateExport)

func (*NullableUploadCreateExport) UnmarshalJSON 

func (v *NullableUploadCreateExport) UnmarshalJSON(src []byte) error

func (*NullableUploadCreateExport) Unset 

func (v *NullableUploadCreateExport) Unset()

type NullableUploadFile 

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

func NewNullableUploadFile 

func NewNullableUploadFile(val *UploadFile) *NullableUploadFile

func (NullableUploadFile) Get 

func (v NullableUploadFile) Get() *UploadFile

func (NullableUploadFile) IsSet 

func (v NullableUploadFile) IsSet() bool

func (NullableUploadFile) MarshalJSON 

func (v NullableUploadFile) MarshalJSON() ([]byte, error)

func (*NullableUploadFile) Set 

func (v *NullableUploadFile) Set(val *UploadFile)

func (*NullableUploadFile) UnmarshalJSON 

func (v *NullableUploadFile) UnmarshalJSON(src []byte) error

func (*NullableUploadFile) Unset 

func (v *NullableUploadFile) Unset()

type NullableUploadState 

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

func NewNullableUploadState 

func NewNullableUploadState(val *UploadState) *NullableUploadState

func (NullableUploadState) Get 

func (v NullableUploadState) Get() *UploadState

func (NullableUploadState) IsSet 

func (v NullableUploadState) IsSet() bool

func (NullableUploadState) MarshalJSON 

func (v NullableUploadState) MarshalJSON() ([]byte, error)

func (*NullableUploadState) Set 

func (v *NullableUploadState) Set(val *UploadState)

func (*NullableUploadState) UnmarshalJSON 

func (v *NullableUploadState) UnmarshalJSON(src []byte) error

func (*NullableUploadState) Unset 

func (v *NullableUploadState) Unset()

type NullableUploadUpdatable 

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

func NewNullableUploadUpdatable 

func NewNullableUploadUpdatable(val *UploadUpdatable) *NullableUploadUpdatable

func (NullableUploadUpdatable) Get 

func (v NullableUploadUpdatable) Get() *UploadUpdatable

func (NullableUploadUpdatable) IsSet 

func (v NullableUploadUpdatable) IsSet() bool

func (NullableUploadUpdatable) MarshalJSON 

func (v NullableUploadUpdatable) MarshalJSON() ([]byte, error)

func (*NullableUploadUpdatable) Set 

func (v *NullableUploadUpdatable) Set(val *UploadUpdatable)

func (*NullableUploadUpdatable) UnmarshalJSON 

func (v *NullableUploadUpdatable) UnmarshalJSON(src []byte) error

func (*NullableUploadUpdatable) Unset 

func (v *NullableUploadUpdatable) Unset()

type NullableUploadWritable 

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

func NewNullableUploadWritable 

func NewNullableUploadWritable(val *UploadWritable) *NullableUploadWritable

func (NullableUploadWritable) Get 

func (v NullableUploadWritable) Get() *UploadWritable

func (NullableUploadWritable) IsSet 

func (v NullableUploadWritable) IsSet() bool

func (NullableUploadWritable) MarshalJSON 

func (v NullableUploadWritable) MarshalJSON() ([]byte, error)

func (*NullableUploadWritable) Set 

func (v *NullableUploadWritable) Set(val *UploadWritable)

func (*NullableUploadWritable) UnmarshalJSON 

func (v *NullableUploadWritable) UnmarshalJSON(src []byte) error

func (*NullableUploadWritable) Unset 

func (v *NullableUploadWritable) Unset()

type NullableUploadsMetadata 

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

func NewNullableUploadsMetadata 

func NewNullableUploadsMetadata(val *UploadsMetadata) *NullableUploadsMetadata

func (NullableUploadsMetadata) Get 

func (v NullableUploadsMetadata) Get() *UploadsMetadata

func (NullableUploadsMetadata) IsSet 

func (v NullableUploadsMetadata) IsSet() bool

func (NullableUploadsMetadata) MarshalJSON 

func (v NullableUploadsMetadata) MarshalJSON() ([]byte, error)

func (*NullableUploadsMetadata) Set 

func (v *NullableUploadsMetadata) Set(val *UploadsMetadata)

func (*NullableUploadsMetadata) UnmarshalJSON 

func (v *NullableUploadsMetadata) UnmarshalJSON(src []byte) error

func (*NullableUploadsMetadata) Unset 

func (v *NullableUploadsMetadata) Unset()

type NullableUsAutocompletions 

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

func NewNullableUsAutocompletions 

func NewNullableUsAutocompletions(val *UsAutocompletions) *NullableUsAutocompletions

func (NullableUsAutocompletions) Get 

func (v NullableUsAutocompletions) Get() *UsAutocompletions

func (NullableUsAutocompletions) IsSet 

func (v NullableUsAutocompletions) IsSet() bool

func (NullableUsAutocompletions) MarshalJSON 

func (v NullableUsAutocompletions) MarshalJSON() ([]byte, error)

func (*NullableUsAutocompletions) Set 

func (v *NullableUsAutocompletions) Set(val *UsAutocompletions)

func (*NullableUsAutocompletions) UnmarshalJSON 

func (v *NullableUsAutocompletions) UnmarshalJSON(src []byte) error

func (*NullableUsAutocompletions) Unset 

func (v *NullableUsAutocompletions) Unset()

type NullableUsAutocompletionsWritable 

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

func NewNullableUsAutocompletionsWritable 

func NewNullableUsAutocompletionsWritable(val *UsAutocompletionsWritable) *NullableUsAutocompletionsWritable

func (NullableUsAutocompletionsWritable) Get 

func (v NullableUsAutocompletionsWritable) Get() *UsAutocompletionsWritable

func (NullableUsAutocompletionsWritable) IsSet 

func (v NullableUsAutocompletionsWritable) IsSet() bool

func (NullableUsAutocompletionsWritable) MarshalJSON 

func (v NullableUsAutocompletionsWritable) MarshalJSON() ([]byte, error)

func (*NullableUsAutocompletionsWritable) Set 

func (v *NullableUsAutocompletionsWritable) Set(val *UsAutocompletionsWritable)

func (*NullableUsAutocompletionsWritable) UnmarshalJSON 

func (v *NullableUsAutocompletionsWritable) UnmarshalJSON(src []byte) error

func (*NullableUsAutocompletionsWritable) Unset 

func (v *NullableUsAutocompletionsWritable) Unset()

type NullableUsComponents 

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

func NewNullableUsComponents 

func NewNullableUsComponents(val *UsComponents) *NullableUsComponents

func (NullableUsComponents) Get 

func (v NullableUsComponents) Get() *UsComponents

func (NullableUsComponents) IsSet 

func (v NullableUsComponents) IsSet() bool

func (NullableUsComponents) MarshalJSON 

func (v NullableUsComponents) MarshalJSON() ([]byte, error)

func (*NullableUsComponents) Set 

func (v *NullableUsComponents) Set(val *UsComponents)

func (*NullableUsComponents) UnmarshalJSON 

func (v *NullableUsComponents) UnmarshalJSON(src []byte) error

func (*NullableUsComponents) Unset 

func (v *NullableUsComponents) Unset()

type NullableUsVerification 

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

func NewNullableUsVerification 

func NewNullableUsVerification(val *UsVerification) *NullableUsVerification

func (NullableUsVerification) Get 

func (v NullableUsVerification) Get() *UsVerification

func (NullableUsVerification) IsSet 

func (v NullableUsVerification) IsSet() bool

func (NullableUsVerification) MarshalJSON 

func (v NullableUsVerification) MarshalJSON() ([]byte, error)

func (*NullableUsVerification) Set 

func (v *NullableUsVerification) Set(val *UsVerification)

func (*NullableUsVerification) UnmarshalJSON 

func (v *NullableUsVerification) UnmarshalJSON(src []byte) error

func (*NullableUsVerification) Unset 

func (v *NullableUsVerification) Unset()

type NullableUsVerificationOrError 

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

func NewNullableUsVerificationOrError 

func NewNullableUsVerificationOrError(val *UsVerificationOrError) *NullableUsVerificationOrError

func (NullableUsVerificationOrError) Get 

func (v NullableUsVerificationOrError) Get() *UsVerificationOrError

func (NullableUsVerificationOrError) IsSet 

func (v NullableUsVerificationOrError) IsSet() bool

func (NullableUsVerificationOrError) MarshalJSON 

func (v NullableUsVerificationOrError) MarshalJSON() ([]byte, error)

func (*NullableUsVerificationOrError) Set 

func (v *NullableUsVerificationOrError) Set(val *UsVerificationOrError)

func (*NullableUsVerificationOrError) UnmarshalJSON 

func (v *NullableUsVerificationOrError) UnmarshalJSON(src []byte) error

func (*NullableUsVerificationOrError) Unset 

func (v *NullableUsVerificationOrError) Unset()

type NullableUsVerifications 

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

func NewNullableUsVerifications 

func NewNullableUsVerifications(val *UsVerifications) *NullableUsVerifications

func (NullableUsVerifications) Get 

func (v NullableUsVerifications) Get() *UsVerifications

func (NullableUsVerifications) IsSet 

func (v NullableUsVerifications) IsSet() bool

func (NullableUsVerifications) MarshalJSON 

func (v NullableUsVerifications) MarshalJSON() ([]byte, error)

func (*NullableUsVerifications) Set 

func (v *NullableUsVerifications) Set(val *UsVerifications)

func (*NullableUsVerifications) UnmarshalJSON 

func (v *NullableUsVerifications) UnmarshalJSON(src []byte) error

func (*NullableUsVerifications) Unset 

func (v *NullableUsVerifications) Unset()

type NullableUsVerificationsWritable 

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

func NewNullableUsVerificationsWritable 

func NewNullableUsVerificationsWritable(val *UsVerificationsWritable) *NullableUsVerificationsWritable

func (NullableUsVerificationsWritable) Get 

func (v NullableUsVerificationsWritable) Get() *UsVerificationsWritable

func (NullableUsVerificationsWritable) IsSet 

func (v NullableUsVerificationsWritable) IsSet() bool

func (NullableUsVerificationsWritable) MarshalJSON 

func (v NullableUsVerificationsWritable) MarshalJSON() ([]byte, error)

func (*NullableUsVerificationsWritable) Set 

func (v *NullableUsVerificationsWritable) Set(val *UsVerificationsWritable)

func (*NullableUsVerificationsWritable) UnmarshalJSON 

func (v *NullableUsVerificationsWritable) UnmarshalJSON(src []byte) error

func (*NullableUsVerificationsWritable) Unset 

func (v *NullableUsVerificationsWritable) Unset()

type NullableZip 

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

func NewNullableZip 

func NewNullableZip(val *Zip) *NullableZip

func (NullableZip) Get 

func (v NullableZip) Get() *Zip

func (NullableZip) IsSet 

func (v NullableZip) IsSet() bool

func (NullableZip) MarshalJSON 

func (v NullableZip) MarshalJSON() ([]byte, error)

func (*NullableZip) Set 

func (v *NullableZip) Set(val *Zip)

func (*NullableZip) UnmarshalJSON 

func (v *NullableZip) UnmarshalJSON(src []byte) error

func (*NullableZip) Unset 

func (v *NullableZip) Unset()

type NullableZipCodeType 

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

func NewNullableZipCodeType 

func NewNullableZipCodeType(val *ZipCodeType) *NullableZipCodeType

func (NullableZipCodeType) Get 

func (v NullableZipCodeType) Get() *ZipCodeType

func (NullableZipCodeType) IsSet 

func (v NullableZipCodeType) IsSet() bool

func (NullableZipCodeType) MarshalJSON 

func (v NullableZipCodeType) MarshalJSON() ([]byte, error)

func (*NullableZipCodeType) Set 

func (v *NullableZipCodeType) Set(val *ZipCodeType)

func (*NullableZipCodeType) UnmarshalJSON 

func (v *NullableZipCodeType) UnmarshalJSON(src []byte) error

func (*NullableZipCodeType) Unset 

func (v *NullableZipCodeType) Unset()

type NullableZipEditable 

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

func NewNullableZipEditable 

func NewNullableZipEditable(val *ZipEditable) *NullableZipEditable

func (NullableZipEditable) Get 

func (v NullableZipEditable) Get() *ZipEditable

func (NullableZipEditable) IsSet 

func (v NullableZipEditable) IsSet() bool

func (NullableZipEditable) MarshalJSON 

func (v NullableZipEditable) MarshalJSON() ([]byte, error)

func (*NullableZipEditable) Set 

func (v *NullableZipEditable) Set(val *ZipEditable)

func (*NullableZipEditable) UnmarshalJSON 

func (v *NullableZipEditable) UnmarshalJSON(src []byte) error

func (*NullableZipEditable) Unset 

func (v *NullableZipEditable) Unset()

type NullableZipLookupCity 

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

func NewNullableZipLookupCity 

func NewNullableZipLookupCity(val *ZipLookupCity) *NullableZipLookupCity

func (NullableZipLookupCity) Get 

func (v NullableZipLookupCity) Get() *ZipLookupCity

func (NullableZipLookupCity) IsSet 

func (v NullableZipLookupCity) IsSet() bool

func (NullableZipLookupCity) MarshalJSON 

func (v NullableZipLookupCity) MarshalJSON() ([]byte, error)

func (*NullableZipLookupCity) Set 

func (v *NullableZipLookupCity) Set(val *ZipLookupCity)

func (*NullableZipLookupCity) UnmarshalJSON 

func (v *NullableZipLookupCity) UnmarshalJSON(src []byte) error

func (*NullableZipLookupCity) Unset 

func (v *NullableZipLookupCity) Unset()

type OptionalAddressColumnMapping 

type OptionalAddressColumnMapping struct {
	// The column header from the csv file that should be mapped to the optional field \"address_line2\"
	AddressLine2 NullableString `json:"address_line2"`
	// The column header from the csv file that should be mapped to the optional field \"company\"
	Company NullableString `json:"company"`
	// The column header from the csv file that should be mapped to the optional field \"address_country\"
	AddressCountry NullableString `json:"address_country"`
}

OptionalAddressColumnMapping The mapping of column headers in your file to Lob-optional fields for the resource created. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#optional-columns-3\" target=\"_blank\">Campaign Audience Guide</a> for additional details.

func NewOptionalAddressColumnMapping 

func NewOptionalAddressColumnMapping(addressLine2 NullableString, company NullableString, addressCountry NullableString) *OptionalAddressColumnMapping

NewOptionalAddressColumnMapping instantiates a new OptionalAddressColumnMapping object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewOptionalAddressColumnMappingWithDefaults 

func NewOptionalAddressColumnMappingWithDefaults() *OptionalAddressColumnMapping

NewOptionalAddressColumnMappingWithDefaults instantiates a new OptionalAddressColumnMapping object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*OptionalAddressColumnMapping) GetAddressCountry 

func (o *OptionalAddressColumnMapping) GetAddressCountry() string

GetAddressCountry returns the AddressCountry field value If the value is explicit nil, the zero value for string will be returned

func (*OptionalAddressColumnMapping) GetAddressCountryOk 

func (o *OptionalAddressColumnMapping) GetAddressCountryOk() (*string, bool)

GetAddressCountryOk returns a tuple with the AddressCountry field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*OptionalAddressColumnMapping) GetAddressLine2 

func (o *OptionalAddressColumnMapping) GetAddressLine2() string

GetAddressLine2 returns the AddressLine2 field value If the value is explicit nil, the zero value for string will be returned

func (*OptionalAddressColumnMapping) GetAddressLine2Ok 

func (o *OptionalAddressColumnMapping) GetAddressLine2Ok() (*string, bool)

GetAddressLine2Ok returns a tuple with the AddressLine2 field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*OptionalAddressColumnMapping) GetCompany 

func (o *OptionalAddressColumnMapping) GetCompany() string

GetCompany returns the Company field value If the value is explicit nil, the zero value for string will be returned

func (*OptionalAddressColumnMapping) GetCompanyOk 

func (o *OptionalAddressColumnMapping) GetCompanyOk() (*string, bool)

GetCompanyOk returns a tuple with the Company field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (OptionalAddressColumnMapping) MarshalJSON 

func (o OptionalAddressColumnMapping) MarshalJSON() ([]byte, error)

func (*OptionalAddressColumnMapping) SetAddressCountry 

func (o *OptionalAddressColumnMapping) SetAddressCountry(v string)

SetAddressCountry sets field value

func (*OptionalAddressColumnMapping) SetAddressLine2 

func (o *OptionalAddressColumnMapping) SetAddressLine2(v string)

SetAddressLine2 sets field value

func (*OptionalAddressColumnMapping) SetCompany 

func (o *OptionalAddressColumnMapping) SetCompany(v string)

SetCompany sets field value

type PlaceholderModel 

type PlaceholderModel struct {
	ReturnEnvelope          *ReturnEnvelope          `json:"return_envelope,omitempty"`
	AddressDomestic         *AddressDomestic         `json:"address_domestic,omitempty"`
	LetterDetailsWritable   *LetterDetailsWritable   `json:"letter_details_writable,omitempty"`
	PostcardDetailsWritable *PostcardDetailsWritable `json:"postcard_details_writable,omitempty"`
	LetterDetailsReturned   *LetterDetailsReturned   `json:"letter_details_returned,omitempty"`
	PostcardDetailsReturned *PostcardDetailsReturned `json:"postcard_details_returned,omitempty"`
}

PlaceholderModel struct for PlaceholderModel

func NewPlaceholderModel 

func NewPlaceholderModel() *PlaceholderModel

NewPlaceholderModel instantiates a new PlaceholderModel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPlaceholderModelWithDefaults 

func NewPlaceholderModelWithDefaults() *PlaceholderModel

NewPlaceholderModelWithDefaults instantiates a new PlaceholderModel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PlaceholderModel) GetAddressDomestic 

func (o *PlaceholderModel) GetAddressDomestic() AddressDomestic

GetAddressDomestic returns the AddressDomestic field value if set, zero value otherwise.

func (*PlaceholderModel) GetAddressDomesticOk 

func (o *PlaceholderModel) GetAddressDomesticOk() (*AddressDomestic, bool)

GetAddressDomesticOk returns a tuple with the AddressDomestic field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PlaceholderModel) GetLetterDetailsReturned 

func (o *PlaceholderModel) GetLetterDetailsReturned() LetterDetailsReturned

GetLetterDetailsReturned returns the LetterDetailsReturned field value if set, zero value otherwise.

func (*PlaceholderModel) GetLetterDetailsReturnedOk 

func (o *PlaceholderModel) GetLetterDetailsReturnedOk() (*LetterDetailsReturned, bool)

GetLetterDetailsReturnedOk returns a tuple with the LetterDetailsReturned field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PlaceholderModel) GetLetterDetailsWritable 

func (o *PlaceholderModel) GetLetterDetailsWritable() LetterDetailsWritable

GetLetterDetailsWritable returns the LetterDetailsWritable field value if set, zero value otherwise.

func (*PlaceholderModel) GetLetterDetailsWritableOk 

func (o *PlaceholderModel) GetLetterDetailsWritableOk() (*LetterDetailsWritable, bool)

GetLetterDetailsWritableOk returns a tuple with the LetterDetailsWritable field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PlaceholderModel) GetPostcardDetailsReturned 

func (o *PlaceholderModel) GetPostcardDetailsReturned() PostcardDetailsReturned

GetPostcardDetailsReturned returns the PostcardDetailsReturned field value if set, zero value otherwise.

func (*PlaceholderModel) GetPostcardDetailsReturnedOk 

func (o *PlaceholderModel) GetPostcardDetailsReturnedOk() (*PostcardDetailsReturned, bool)

GetPostcardDetailsReturnedOk returns a tuple with the PostcardDetailsReturned field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PlaceholderModel) GetPostcardDetailsWritable 

func (o *PlaceholderModel) GetPostcardDetailsWritable() PostcardDetailsWritable

GetPostcardDetailsWritable returns the PostcardDetailsWritable field value if set, zero value otherwise.

func (*PlaceholderModel) GetPostcardDetailsWritableOk 

func (o *PlaceholderModel) GetPostcardDetailsWritableOk() (*PostcardDetailsWritable, bool)

GetPostcardDetailsWritableOk returns a tuple with the PostcardDetailsWritable field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PlaceholderModel) GetReturnEnvelope 

func (o *PlaceholderModel) GetReturnEnvelope() ReturnEnvelope

GetReturnEnvelope returns the ReturnEnvelope field value if set, zero value otherwise.

func (*PlaceholderModel) GetReturnEnvelopeOk 

func (o *PlaceholderModel) GetReturnEnvelopeOk() (*ReturnEnvelope, bool)

GetReturnEnvelopeOk returns a tuple with the ReturnEnvelope field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PlaceholderModel) HasAddressDomestic 

func (o *PlaceholderModel) HasAddressDomestic() bool

HasAddressDomestic returns a boolean if a field has been set.

func (*PlaceholderModel) HasLetterDetailsReturned 

func (o *PlaceholderModel) HasLetterDetailsReturned() bool

HasLetterDetailsReturned returns a boolean if a field has been set.

func (*PlaceholderModel) HasLetterDetailsWritable 

func (o *PlaceholderModel) HasLetterDetailsWritable() bool

HasLetterDetailsWritable returns a boolean if a field has been set.

func (*PlaceholderModel) HasPostcardDetailsReturned 

func (o *PlaceholderModel) HasPostcardDetailsReturned() bool

HasPostcardDetailsReturned returns a boolean if a field has been set.

func (*PlaceholderModel) HasPostcardDetailsWritable 

func (o *PlaceholderModel) HasPostcardDetailsWritable() bool

HasPostcardDetailsWritable returns a boolean if a field has been set.

func (*PlaceholderModel) HasReturnEnvelope 

func (o *PlaceholderModel) HasReturnEnvelope() bool

HasReturnEnvelope returns a boolean if a field has been set.

func (PlaceholderModel) MarshalJSON 

func (o PlaceholderModel) MarshalJSON() ([]byte, error)

func (*PlaceholderModel) SetAddressDomestic 

func (o *PlaceholderModel) SetAddressDomestic(v AddressDomestic)

SetAddressDomestic gets a reference to the given AddressDomestic and assigns it to the AddressDomestic field.

func (*PlaceholderModel) SetLetterDetailsReturned 

func (o *PlaceholderModel) SetLetterDetailsReturned(v LetterDetailsReturned)

SetLetterDetailsReturned gets a reference to the given LetterDetailsReturned and assigns it to the LetterDetailsReturned field.

func (*PlaceholderModel) SetLetterDetailsWritable 

func (o *PlaceholderModel) SetLetterDetailsWritable(v LetterDetailsWritable)

SetLetterDetailsWritable gets a reference to the given LetterDetailsWritable and assigns it to the LetterDetailsWritable field.

func (*PlaceholderModel) SetPostcardDetailsReturned 

func (o *PlaceholderModel) SetPostcardDetailsReturned(v PostcardDetailsReturned)

SetPostcardDetailsReturned gets a reference to the given PostcardDetailsReturned and assigns it to the PostcardDetailsReturned field.

func (*PlaceholderModel) SetPostcardDetailsWritable 

func (o *PlaceholderModel) SetPostcardDetailsWritable(v PostcardDetailsWritable)

SetPostcardDetailsWritable gets a reference to the given PostcardDetailsWritable and assigns it to the PostcardDetailsWritable field.

func (*PlaceholderModel) SetReturnEnvelope 

func (o *PlaceholderModel) SetReturnEnvelope(v ReturnEnvelope)

SetReturnEnvelope gets a reference to the given ReturnEnvelope and assigns it to the ReturnEnvelope field.

type Postcard 

type Postcard struct {
	// Unique identifier prefixed with `psc_`.
	Id         string                   `json:"id"`
	To         *Address                 `json:"to,omitempty"`
	From       *AddressDomesticExpanded `json:"from,omitempty"`
	Carrier    *string                  `json:"carrier,omitempty"`
	Thumbnails []Thumbnail              `json:"thumbnails,omitempty"`
	Size       *PostcardSize            `json:"size,omitempty"`
	// A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.
	ExpectedDeliveryDate *string `json:"expected_delivery_date,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified *time.Time `json:"date_modified,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// The unique ID of the HTML template used for the front of the postcard.
	FrontTemplateId NullableString `json:"front_template_id,omitempty"`
	// The unique ID of the HTML template used for the back of the postcard.
	BackTemplateId NullableString `json:"back_template_id,omitempty"`
	// The unique ID of the specific version of the HTML template used for the front of the postcard.
	FrontTemplateVersionId NullableString `json:"front_template_version_id,omitempty"`
	// The unique ID of the specific version of the HTML template used for the back of the postcard.
	BackTemplateVersionId NullableString `json:"back_template_version_id,omitempty"`
	// An array of tracking_event objects ordered by ascending `time`. Will not be populated for postcards created in test mode.
	TrackingEvents []TrackingEventNormal `json:"tracking_events,omitempty"`
	Object         *string               `json:"object,omitempty"`
	// A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
	Url string `json:"url"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	MailType *MailType          `json:"mail_type,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time         `json:"send_date,omitempty"`
	UseType  NullablePscUseType `json:"use_type,omitempty"`
}

Postcard struct for Postcard

func NewPostcard 

func NewPostcard(id string, url string) *Postcard

NewPostcard instantiates a new Postcard object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPostcardWithDefaults 

func NewPostcardWithDefaults() *Postcard

NewPostcardWithDefaults instantiates a new Postcard object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Postcard) GetBackTemplateId 

func (o *Postcard) GetBackTemplateId() string

GetBackTemplateId returns the BackTemplateId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetBackTemplateIdOk 

func (o *Postcard) GetBackTemplateIdOk() (*string, bool)

GetBackTemplateIdOk returns a tuple with the BackTemplateId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) GetBackTemplateVersionId 

func (o *Postcard) GetBackTemplateVersionId() string

GetBackTemplateVersionId returns the BackTemplateVersionId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetBackTemplateVersionIdOk 

func (o *Postcard) GetBackTemplateVersionIdOk() (*string, bool)

GetBackTemplateVersionIdOk returns a tuple with the BackTemplateVersionId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) GetCarrier 

func (o *Postcard) GetCarrier() string

GetCarrier returns the Carrier field value if set, zero value otherwise.

func (*Postcard) GetCarrierOk 

func (o *Postcard) GetCarrierOk() (*string, bool)

GetCarrierOk returns a tuple with the Carrier field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetDateCreated 

func (o *Postcard) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*Postcard) GetDateCreatedOk 

func (o *Postcard) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetDateModified 

func (o *Postcard) GetDateModified() time.Time

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*Postcard) GetDateModifiedOk 

func (o *Postcard) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetDeleted 

func (o *Postcard) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*Postcard) GetDeletedOk 

func (o *Postcard) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetDescription 

func (o *Postcard) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetDescriptionOk 

func (o *Postcard) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) GetExpectedDeliveryDate 

func (o *Postcard) GetExpectedDeliveryDate() string

GetExpectedDeliveryDate returns the ExpectedDeliveryDate field value if set, zero value otherwise.

func (*Postcard) GetExpectedDeliveryDateOk 

func (o *Postcard) GetExpectedDeliveryDateOk() (*string, bool)

GetExpectedDeliveryDateOk returns a tuple with the ExpectedDeliveryDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetFrom 

func (o *Postcard) GetFrom() AddressDomesticExpanded

GetFrom returns the From field value if set, zero value otherwise.

func (*Postcard) GetFromOk 

func (o *Postcard) GetFromOk() (*AddressDomesticExpanded, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetFrontTemplateId 

func (o *Postcard) GetFrontTemplateId() string

GetFrontTemplateId returns the FrontTemplateId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetFrontTemplateIdOk 

func (o *Postcard) GetFrontTemplateIdOk() (*string, bool)

GetFrontTemplateIdOk returns a tuple with the FrontTemplateId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) GetFrontTemplateVersionId 

func (o *Postcard) GetFrontTemplateVersionId() string

GetFrontTemplateVersionId returns the FrontTemplateVersionId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetFrontTemplateVersionIdOk 

func (o *Postcard) GetFrontTemplateVersionIdOk() (*string, bool)

GetFrontTemplateVersionIdOk returns a tuple with the FrontTemplateVersionId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) GetId 

func (o *Postcard) GetId() string

GetId returns the Id field value

func (*Postcard) GetIdOk 

func (o *Postcard) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Postcard) GetMailType 

func (o *Postcard) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*Postcard) GetMailTypeOk 

func (o *Postcard) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetMergeVariables 

func (o *Postcard) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetMergeVariablesOk 

func (o *Postcard) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) GetMetadata 

func (o *Postcard) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*Postcard) GetMetadataOk 

func (o *Postcard) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetObject 

func (o *Postcard) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*Postcard) GetObjectOk 

func (o *Postcard) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetSendDate 

func (o *Postcard) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*Postcard) GetSendDateOk 

func (o *Postcard) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetSize 

func (o *Postcard) GetSize() PostcardSize

GetSize returns the Size field value if set, zero value otherwise.

func (*Postcard) GetSizeOk 

func (o *Postcard) GetSizeOk() (*PostcardSize, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetThumbnails 

func (o *Postcard) GetThumbnails() []Thumbnail

GetThumbnails returns the Thumbnails field value if set, zero value otherwise.

func (*Postcard) GetThumbnailsOk 

func (o *Postcard) GetThumbnailsOk() ([]Thumbnail, bool)

GetThumbnailsOk returns a tuple with the Thumbnails field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetTo 

func (o *Postcard) GetTo() Address

GetTo returns the To field value if set, zero value otherwise.

func (*Postcard) GetToOk 

func (o *Postcard) GetToOk() (*Address, bool)

GetToOk returns a tuple with the To field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Postcard) GetTrackingEvents 

func (o *Postcard) GetTrackingEvents() []TrackingEventNormal

GetTrackingEvents returns the TrackingEvents field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetTrackingEventsOk 

func (o *Postcard) GetTrackingEventsOk() ([]TrackingEventNormal, bool)

GetTrackingEventsOk returns a tuple with the TrackingEvents field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) GetUrl 

func (o *Postcard) GetUrl() string

GetUrl returns the Url field value

func (*Postcard) GetUrlOk 

func (o *Postcard) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*Postcard) GetUseType 

func (o *Postcard) GetUseType() PscUseType

GetUseType returns the UseType field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Postcard) GetUseTypeOk 

func (o *Postcard) GetUseTypeOk() (*PscUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Postcard) HasBackTemplateId 

func (o *Postcard) HasBackTemplateId() bool

HasBackTemplateId returns a boolean if a field has been set.

func (*Postcard) HasBackTemplateVersionId 

func (o *Postcard) HasBackTemplateVersionId() bool

HasBackTemplateVersionId returns a boolean if a field has been set.

func (*Postcard) HasCarrier 

func (o *Postcard) HasCarrier() bool

HasCarrier returns a boolean if a field has been set.

func (*Postcard) HasDateCreated 

func (o *Postcard) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*Postcard) HasDateModified 

func (o *Postcard) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (*Postcard) HasDeleted 

func (o *Postcard) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*Postcard) HasDescription 

func (o *Postcard) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Postcard) HasExpectedDeliveryDate 

func (o *Postcard) HasExpectedDeliveryDate() bool

HasExpectedDeliveryDate returns a boolean if a field has been set.

func (*Postcard) HasFrom 

func (o *Postcard) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*Postcard) HasFrontTemplateId 

func (o *Postcard) HasFrontTemplateId() bool

HasFrontTemplateId returns a boolean if a field has been set.

func (*Postcard) HasFrontTemplateVersionId 

func (o *Postcard) HasFrontTemplateVersionId() bool

HasFrontTemplateVersionId returns a boolean if a field has been set.

func (*Postcard) HasMailType 

func (o *Postcard) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*Postcard) HasMergeVariables 

func (o *Postcard) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*Postcard) HasMetadata 

func (o *Postcard) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*Postcard) HasObject 

func (o *Postcard) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*Postcard) HasSendDate 

func (o *Postcard) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*Postcard) HasSize 

func (o *Postcard) HasSize() bool

HasSize returns a boolean if a field has been set.

func (*Postcard) HasThumbnails 

func (o *Postcard) HasThumbnails() bool

HasThumbnails returns a boolean if a field has been set.

func (*Postcard) HasTo 

func (o *Postcard) HasTo() bool

HasTo returns a boolean if a field has been set.

func (*Postcard) HasTrackingEvents 

func (o *Postcard) HasTrackingEvents() bool

HasTrackingEvents returns a boolean if a field has been set.

func (*Postcard) HasUseType 

func (o *Postcard) HasUseType() bool

HasUseType returns a boolean if a field has been set.

func (Postcard) MarshalJSON 

func (o Postcard) MarshalJSON() ([]byte, error)

func (*Postcard) SetBackTemplateId 

func (o *Postcard) SetBackTemplateId(v string)

SetBackTemplateId gets a reference to the given NullableString and assigns it to the BackTemplateId field.

func (*Postcard) SetBackTemplateIdNil 

func (o *Postcard) SetBackTemplateIdNil()

SetBackTemplateIdNil sets the value for BackTemplateId to be an explicit nil

func (*Postcard) SetBackTemplateVersionId 

func (o *Postcard) SetBackTemplateVersionId(v string)

SetBackTemplateVersionId gets a reference to the given NullableString and assigns it to the BackTemplateVersionId field.

func (*Postcard) SetBackTemplateVersionIdNil 

func (o *Postcard) SetBackTemplateVersionIdNil()

SetBackTemplateVersionIdNil sets the value for BackTemplateVersionId to be an explicit nil

func (*Postcard) SetCarrier 

func (o *Postcard) SetCarrier(v string)

SetCarrier gets a reference to the given string and assigns it to the Carrier field.

func (*Postcard) SetDateCreated 

func (o *Postcard) SetDateCreated(v time.Time)

SetDateCreated gets a reference to the given time.Time and assigns it to the DateCreated field.

func (*Postcard) SetDateModified 

func (o *Postcard) SetDateModified(v time.Time)

SetDateModified gets a reference to the given time.Time and assigns it to the DateModified field.

func (*Postcard) SetDeleted 

func (o *Postcard) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*Postcard) SetDescription 

func (o *Postcard) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*Postcard) SetDescriptionNil 

func (o *Postcard) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*Postcard) SetExpectedDeliveryDate 

func (o *Postcard) SetExpectedDeliveryDate(v string)

SetExpectedDeliveryDate gets a reference to the given string and assigns it to the ExpectedDeliveryDate field.

func (*Postcard) SetFrom 

func (o *Postcard) SetFrom(v AddressDomesticExpanded)

SetFrom gets a reference to the given AddressDomesticExpanded and assigns it to the From field.

func (*Postcard) SetFrontTemplateId 

func (o *Postcard) SetFrontTemplateId(v string)

SetFrontTemplateId gets a reference to the given NullableString and assigns it to the FrontTemplateId field.

func (*Postcard) SetFrontTemplateIdNil 

func (o *Postcard) SetFrontTemplateIdNil()

SetFrontTemplateIdNil sets the value for FrontTemplateId to be an explicit nil

func (*Postcard) SetFrontTemplateVersionId 

func (o *Postcard) SetFrontTemplateVersionId(v string)

SetFrontTemplateVersionId gets a reference to the given NullableString and assigns it to the FrontTemplateVersionId field.

func (*Postcard) SetFrontTemplateVersionIdNil 

func (o *Postcard) SetFrontTemplateVersionIdNil()

SetFrontTemplateVersionIdNil sets the value for FrontTemplateVersionId to be an explicit nil

func (*Postcard) SetId 

func (o *Postcard) SetId(v string)

SetId sets field value

func (*Postcard) SetMailType 

func (o *Postcard) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*Postcard) SetMergeVariables 

func (o *Postcard) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*Postcard) SetMetadata 

func (o *Postcard) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*Postcard) SetObject 

func (o *Postcard) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*Postcard) SetSendDate 

func (o *Postcard) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*Postcard) SetSize 

func (o *Postcard) SetSize(v PostcardSize)

SetSize gets a reference to the given PostcardSize and assigns it to the Size field.

func (*Postcard) SetThumbnails 

func (o *Postcard) SetThumbnails(v []Thumbnail)

SetThumbnails gets a reference to the given []Thumbnail and assigns it to the Thumbnails field.

func (*Postcard) SetTo 

func (o *Postcard) SetTo(v Address)

SetTo gets a reference to the given Address and assigns it to the To field.

func (*Postcard) SetTrackingEvents 

func (o *Postcard) SetTrackingEvents(v []TrackingEventNormal)

SetTrackingEvents gets a reference to the given []TrackingEventNormal and assigns it to the TrackingEvents field.

func (*Postcard) SetUrl 

func (o *Postcard) SetUrl(v string)

SetUrl sets field value

func (*Postcard) SetUseType 

func (o *Postcard) SetUseType(v PscUseType)

SetUseType gets a reference to the given NullablePscUseType and assigns it to the UseType field.

func (*Postcard) SetUseTypeNil 

func (o *Postcard) SetUseTypeNil()

SetUseTypeNil sets the value for UseType to be an explicit nil

func (*Postcard) UnsetBackTemplateId 

func (o *Postcard) UnsetBackTemplateId()

UnsetBackTemplateId ensures that no value is present for BackTemplateId, not even an explicit nil

func (*Postcard) UnsetBackTemplateVersionId 

func (o *Postcard) UnsetBackTemplateVersionId()

UnsetBackTemplateVersionId ensures that no value is present for BackTemplateVersionId, not even an explicit nil

func (*Postcard) UnsetDescription 

func (o *Postcard) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*Postcard) UnsetFrontTemplateId 

func (o *Postcard) UnsetFrontTemplateId()

UnsetFrontTemplateId ensures that no value is present for FrontTemplateId, not even an explicit nil

func (*Postcard) UnsetFrontTemplateVersionId 

func (o *Postcard) UnsetFrontTemplateVersionId()

UnsetFrontTemplateVersionId ensures that no value is present for FrontTemplateVersionId, not even an explicit nil

func (*Postcard) UnsetUseType 

func (o *Postcard) UnsetUseType()

UnsetUseType ensures that no value is present for UseType, not even an explicit nil

type PostcardDeletion 

type PostcardDeletion struct {
	// Unique identifier prefixed with `psc_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

PostcardDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewPostcardDeletion 

func NewPostcardDeletion() *PostcardDeletion

NewPostcardDeletion instantiates a new PostcardDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPostcardDeletionWithDefaults 

func NewPostcardDeletionWithDefaults() *PostcardDeletion

NewPostcardDeletionWithDefaults instantiates a new PostcardDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PostcardDeletion) GetDeleted 

func (o *PostcardDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*PostcardDeletion) GetDeletedOk 

func (o *PostcardDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDeletion) GetId 

func (o *PostcardDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*PostcardDeletion) GetIdOk 

func (o *PostcardDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDeletion) GetObject 

func (o *PostcardDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*PostcardDeletion) GetObjectOk 

func (o *PostcardDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDeletion) HasDeleted 

func (o *PostcardDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*PostcardDeletion) HasId 

func (o *PostcardDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*PostcardDeletion) HasObject 

func (o *PostcardDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (PostcardDeletion) MarshalJSON 

func (o PostcardDeletion) MarshalJSON() ([]byte, error)

func (*PostcardDeletion) SetDeleted 

func (o *PostcardDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*PostcardDeletion) SetId 

func (o *PostcardDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*PostcardDeletion) SetObject 

func (o *PostcardDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type PostcardDetailsReturned 

type PostcardDetailsReturned struct {
	MailType *MailType     `json:"mail_type,omitempty"`
	Size     *PostcardSize `json:"size,omitempty"`
	Setting  *int32        `json:"setting,omitempty"`
	// The original URL of the front template.
	FrontOriginalUrl *string `json:"front_original_url,omitempty"`
	// The original URL of the back template.
	BackOriginalUrl *string `json:"back_original_url,omitempty"`
}

PostcardDetailsReturned Properties that the postcards in your Creative should have.

func NewPostcardDetailsReturned 

func NewPostcardDetailsReturned() *PostcardDetailsReturned

NewPostcardDetailsReturned instantiates a new PostcardDetailsReturned object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPostcardDetailsReturnedWithDefaults 

func NewPostcardDetailsReturnedWithDefaults() *PostcardDetailsReturned

NewPostcardDetailsReturnedWithDefaults instantiates a new PostcardDetailsReturned object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PostcardDetailsReturned) GetBackOriginalUrl 

func (o *PostcardDetailsReturned) GetBackOriginalUrl() string

GetBackOriginalUrl returns the BackOriginalUrl field value if set, zero value otherwise.

func (*PostcardDetailsReturned) GetBackOriginalUrlOk 

func (o *PostcardDetailsReturned) GetBackOriginalUrlOk() (*string, bool)

GetBackOriginalUrlOk returns a tuple with the BackOriginalUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDetailsReturned) GetFrontOriginalUrl 

func (o *PostcardDetailsReturned) GetFrontOriginalUrl() string

GetFrontOriginalUrl returns the FrontOriginalUrl field value if set, zero value otherwise.

func (*PostcardDetailsReturned) GetFrontOriginalUrlOk 

func (o *PostcardDetailsReturned) GetFrontOriginalUrlOk() (*string, bool)

GetFrontOriginalUrlOk returns a tuple with the FrontOriginalUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDetailsReturned) GetMailType 

func (o *PostcardDetailsReturned) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*PostcardDetailsReturned) GetMailTypeOk 

func (o *PostcardDetailsReturned) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDetailsReturned) GetSetting 

func (o *PostcardDetailsReturned) GetSetting() int32

GetSetting returns the Setting field value if set, zero value otherwise.

func (*PostcardDetailsReturned) GetSettingOk 

func (o *PostcardDetailsReturned) GetSettingOk() (*int32, bool)

GetSettingOk returns a tuple with the Setting field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDetailsReturned) GetSize 

func (o *PostcardDetailsReturned) GetSize() PostcardSize

GetSize returns the Size field value if set, zero value otherwise.

func (*PostcardDetailsReturned) GetSizeOk 

func (o *PostcardDetailsReturned) GetSizeOk() (*PostcardSize, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDetailsReturned) HasBackOriginalUrl 

func (o *PostcardDetailsReturned) HasBackOriginalUrl() bool

HasBackOriginalUrl returns a boolean if a field has been set.

func (*PostcardDetailsReturned) HasFrontOriginalUrl 

func (o *PostcardDetailsReturned) HasFrontOriginalUrl() bool

HasFrontOriginalUrl returns a boolean if a field has been set.

func (*PostcardDetailsReturned) HasMailType 

func (o *PostcardDetailsReturned) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*PostcardDetailsReturned) HasSetting 

func (o *PostcardDetailsReturned) HasSetting() bool

HasSetting returns a boolean if a field has been set.

func (*PostcardDetailsReturned) HasSize 

func (o *PostcardDetailsReturned) HasSize() bool

HasSize returns a boolean if a field has been set.

func (PostcardDetailsReturned) MarshalJSON 

func (o PostcardDetailsReturned) MarshalJSON() ([]byte, error)

func (*PostcardDetailsReturned) SetBackOriginalUrl 

func (o *PostcardDetailsReturned) SetBackOriginalUrl(v string)

SetBackOriginalUrl gets a reference to the given string and assigns it to the BackOriginalUrl field.

func (*PostcardDetailsReturned) SetFrontOriginalUrl 

func (o *PostcardDetailsReturned) SetFrontOriginalUrl(v string)

SetFrontOriginalUrl gets a reference to the given string and assigns it to the FrontOriginalUrl field.

func (*PostcardDetailsReturned) SetMailType 

func (o *PostcardDetailsReturned) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*PostcardDetailsReturned) SetSetting 

func (o *PostcardDetailsReturned) SetSetting(v int32)

SetSetting gets a reference to the given int32 and assigns it to the Setting field.

func (*PostcardDetailsReturned) SetSize 

func (o *PostcardDetailsReturned) SetSize(v PostcardSize)

SetSize gets a reference to the given PostcardSize and assigns it to the Size field.

type PostcardDetailsWritable 

type PostcardDetailsWritable struct {
	MailType *MailType     `json:"mail_type,omitempty"`
	Size     *PostcardSize `json:"size,omitempty"`
}

PostcardDetailsWritable Properties that the postcards in your Creative should have.

func NewPostcardDetailsWritable 

func NewPostcardDetailsWritable() *PostcardDetailsWritable

NewPostcardDetailsWritable instantiates a new PostcardDetailsWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPostcardDetailsWritableWithDefaults 

func NewPostcardDetailsWritableWithDefaults() *PostcardDetailsWritable

NewPostcardDetailsWritableWithDefaults instantiates a new PostcardDetailsWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PostcardDetailsWritable) GetMailType 

func (o *PostcardDetailsWritable) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*PostcardDetailsWritable) GetMailTypeOk 

func (o *PostcardDetailsWritable) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDetailsWritable) GetSize 

func (o *PostcardDetailsWritable) GetSize() PostcardSize

GetSize returns the Size field value if set, zero value otherwise.

func (*PostcardDetailsWritable) GetSizeOk 

func (o *PostcardDetailsWritable) GetSizeOk() (*PostcardSize, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardDetailsWritable) HasMailType 

func (o *PostcardDetailsWritable) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*PostcardDetailsWritable) HasSize 

func (o *PostcardDetailsWritable) HasSize() bool

HasSize returns a boolean if a field has been set.

func (PostcardDetailsWritable) MarshalJSON 

func (o PostcardDetailsWritable) MarshalJSON() ([]byte, error)

func (*PostcardDetailsWritable) SetMailType 

func (o *PostcardDetailsWritable) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*PostcardDetailsWritable) SetSize 

func (o *PostcardDetailsWritable) SetSize(v PostcardSize)

SetSize gets a reference to the given PostcardSize and assigns it to the Size field.

type PostcardEditable 

type PostcardEditable struct {
	// Must either be an address ID or an inline object with correct address parameters.
	To interface{} `json:"to"`
	// Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters.
	From interface{}   `json:"from,omitempty"`
	Size *PostcardSize `json:"size,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	MailType *MailType          `json:"mail_type,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time `json:"send_date,omitempty"`
	// The artwork to use as the front of your postcard.
	Front string `json:"front"`
	// The artwork to use as the back of your postcard.
	Back string `json:"back"`
	// An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.
	BillingGroupId *string            `json:"billing_group_id,omitempty"`
	QrCode         *QrCode            `json:"qr_code,omitempty"`
	UseType        NullablePscUseType `json:"use_type"`
}

PostcardEditable struct for PostcardEditable

func NewPostcardEditable 

func NewPostcardEditable(to interface{}, front string, back string, useType NullablePscUseType) *PostcardEditable

NewPostcardEditable instantiates a new PostcardEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPostcardEditableWithDefaults 

func NewPostcardEditableWithDefaults() *PostcardEditable

NewPostcardEditableWithDefaults instantiates a new PostcardEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PostcardEditable) GetBack 

func (o *PostcardEditable) GetBack() string

GetBack returns the Back field value

func (*PostcardEditable) GetBackOk 

func (o *PostcardEditable) GetBackOk() (*string, bool)

GetBackOk returns a tuple with the Back field value and a boolean to check if the value has been set.

func (*PostcardEditable) GetBillingGroupId 

func (o *PostcardEditable) GetBillingGroupId() string

GetBillingGroupId returns the BillingGroupId field value if set, zero value otherwise.

func (*PostcardEditable) GetBillingGroupIdOk 

func (o *PostcardEditable) GetBillingGroupIdOk() (*string, bool)

GetBillingGroupIdOk returns a tuple with the BillingGroupId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardEditable) GetDescription 

func (o *PostcardEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*PostcardEditable) GetDescriptionOk 

func (o *PostcardEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*PostcardEditable) GetFrom 

func (o *PostcardEditable) GetFrom() interface{}

GetFrom returns the From field value if set, zero value otherwise (both if not set or set to explicit null).

func (*PostcardEditable) GetFromOk 

func (o *PostcardEditable) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*PostcardEditable) GetFront 

func (o *PostcardEditable) GetFront() string

GetFront returns the Front field value

func (*PostcardEditable) GetFrontOk 

func (o *PostcardEditable) GetFrontOk() (*string, bool)

GetFrontOk returns a tuple with the Front field value and a boolean to check if the value has been set.

func (*PostcardEditable) GetMailType 

func (o *PostcardEditable) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*PostcardEditable) GetMailTypeOk 

func (o *PostcardEditable) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardEditable) GetMergeVariables 

func (o *PostcardEditable) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*PostcardEditable) GetMergeVariablesOk 

func (o *PostcardEditable) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*PostcardEditable) GetMetadata 

func (o *PostcardEditable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*PostcardEditable) GetMetadataOk 

func (o *PostcardEditable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardEditable) GetQrCode 

func (o *PostcardEditable) GetQrCode() QrCode

GetQrCode returns the QrCode field value if set, zero value otherwise.

func (*PostcardEditable) GetQrCodeOk 

func (o *PostcardEditable) GetQrCodeOk() (*QrCode, bool)

GetQrCodeOk returns a tuple with the QrCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardEditable) GetSendDate 

func (o *PostcardEditable) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*PostcardEditable) GetSendDateOk 

func (o *PostcardEditable) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardEditable) GetSize 

func (o *PostcardEditable) GetSize() PostcardSize

GetSize returns the Size field value if set, zero value otherwise.

func (*PostcardEditable) GetSizeOk 

func (o *PostcardEditable) GetSizeOk() (*PostcardSize, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardEditable) GetTo 

func (o *PostcardEditable) GetTo() interface{}

GetTo returns the To field value If the value is explicit nil, the zero value for interface{} will be returned

func (*PostcardEditable) GetToOk 

func (o *PostcardEditable) GetToOk() (*interface{}, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*PostcardEditable) GetUseType 

func (o *PostcardEditable) GetUseType() PscUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for PscUseType will be returned

func (*PostcardEditable) GetUseTypeOk 

func (o *PostcardEditable) GetUseTypeOk() (*PscUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*PostcardEditable) HasBillingGroupId 

func (o *PostcardEditable) HasBillingGroupId() bool

HasBillingGroupId returns a boolean if a field has been set.

func (*PostcardEditable) HasDescription 

func (o *PostcardEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*PostcardEditable) HasFrom 

func (o *PostcardEditable) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*PostcardEditable) HasMailType 

func (o *PostcardEditable) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*PostcardEditable) HasMergeVariables 

func (o *PostcardEditable) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*PostcardEditable) HasMetadata 

func (o *PostcardEditable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*PostcardEditable) HasQrCode 

func (o *PostcardEditable) HasQrCode() bool

HasQrCode returns a boolean if a field has been set.

func (*PostcardEditable) HasSendDate 

func (o *PostcardEditable) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*PostcardEditable) HasSize 

func (o *PostcardEditable) HasSize() bool

HasSize returns a boolean if a field has been set.

func (PostcardEditable) MarshalJSON 

func (o PostcardEditable) MarshalJSON() ([]byte, error)

func (*PostcardEditable) SetBack 

func (o *PostcardEditable) SetBack(v string)

SetBack sets field value

func (*PostcardEditable) SetBillingGroupId 

func (o *PostcardEditable) SetBillingGroupId(v string)

SetBillingGroupId gets a reference to the given string and assigns it to the BillingGroupId field.

func (*PostcardEditable) SetDescription 

func (o *PostcardEditable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*PostcardEditable) SetDescriptionNil 

func (o *PostcardEditable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*PostcardEditable) SetFrom 

func (o *PostcardEditable) SetFrom(v interface{})

SetFrom gets a reference to the given interface{} and assigns it to the From field.

func (*PostcardEditable) SetFront 

func (o *PostcardEditable) SetFront(v string)

SetFront sets field value

func (*PostcardEditable) SetMailType 

func (o *PostcardEditable) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*PostcardEditable) SetMergeVariables 

func (o *PostcardEditable) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*PostcardEditable) SetMetadata 

func (o *PostcardEditable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*PostcardEditable) SetQrCode 

func (o *PostcardEditable) SetQrCode(v QrCode)

SetQrCode gets a reference to the given QrCode and assigns it to the QrCode field.

func (*PostcardEditable) SetSendDate 

func (o *PostcardEditable) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*PostcardEditable) SetSize 

func (o *PostcardEditable) SetSize(v PostcardSize)

SetSize gets a reference to the given PostcardSize and assigns it to the Size field.

func (*PostcardEditable) SetTo 

func (o *PostcardEditable) SetTo(v interface{})

SetTo sets field value

func (*PostcardEditable) SetUseType 

func (o *PostcardEditable) SetUseType(v PscUseType)

SetUseType sets field value

func (*PostcardEditable) UnsetDescription 

func (o *PostcardEditable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type PostcardList 

type PostcardList struct {
	// list of postcards
	Data []Postcard `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

PostcardList struct for PostcardList

func NewPostcardList 

func NewPostcardList() *PostcardList

NewPostcardList instantiates a new PostcardList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPostcardListWithDefaults 

func NewPostcardListWithDefaults() *PostcardList

NewPostcardListWithDefaults instantiates a new PostcardList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PostcardList) GetCount 

func (o *PostcardList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*PostcardList) GetCountOk 

func (o *PostcardList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardList) GetData 

func (o *PostcardList) GetData() []Postcard

GetData returns the Data field value if set, zero value otherwise.

func (*PostcardList) GetDataOk 

func (o *PostcardList) GetDataOk() ([]Postcard, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardList) GetNextPageToken 

func (o *PostcardList) GetNextPageToken() string

func (*PostcardList) GetNextUrl 

func (o *PostcardList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*PostcardList) GetNextUrlOk 

func (o *PostcardList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*PostcardList) GetObject 

func (o *PostcardList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*PostcardList) GetObjectOk 

func (o *PostcardList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardList) GetPrevPageToken 

func (o *PostcardList) GetPrevPageToken() string

func (*PostcardList) GetPreviousUrl 

func (o *PostcardList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*PostcardList) GetPreviousUrlOk 

func (o *PostcardList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*PostcardList) GetTotalCount 

func (o *PostcardList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*PostcardList) GetTotalCountOk 

func (o *PostcardList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PostcardList) HasCount 

func (o *PostcardList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*PostcardList) HasData 

func (o *PostcardList) HasData() bool

HasData returns a boolean if a field has been set.

func (*PostcardList) HasNextUrl 

func (o *PostcardList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*PostcardList) HasObject 

func (o *PostcardList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*PostcardList) HasPreviousUrl 

func (o *PostcardList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*PostcardList) HasTotalCount 

func (o *PostcardList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (PostcardList) MarshalJSON 

func (o PostcardList) MarshalJSON() ([]byte, error)

func (*PostcardList) SetCount 

func (o *PostcardList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*PostcardList) SetData 

func (o *PostcardList) SetData(v []Postcard)

SetData gets a reference to the given []Postcard and assigns it to the Data field.

func (*PostcardList) SetNextUrl 

func (o *PostcardList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*PostcardList) SetNextUrlNil 

func (o *PostcardList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*PostcardList) SetObject 

func (o *PostcardList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*PostcardList) SetPreviousUrl 

func (o *PostcardList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*PostcardList) SetPreviousUrlNil 

func (o *PostcardList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*PostcardList) SetTotalCount 

func (o *PostcardList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*PostcardList) UnsetNextUrl 

func (o *PostcardList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*PostcardList) UnsetPreviousUrl 

func (o *PostcardList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type PostcardSize 

type PostcardSize string

PostcardSize Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. 

const (
	POSTCARDSIZE__4X6  PostcardSize = "4x6"
	POSTCARDSIZE__6X9  PostcardSize = "6x9"
	POSTCARDSIZE__6X11 PostcardSize = "6x11"
)

List of postcard_size

func NewPostcardSizeFromValue 

func NewPostcardSizeFromValue(v string) (*PostcardSize, error)

NewPostcardSizeFromValue returns a pointer to a valid PostcardSize for the value passed as argument, or an error if the value passed is not allowed by the enum

func (PostcardSize) IsValid 

func (v PostcardSize) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (PostcardSize) Ptr 

func (v PostcardSize) Ptr() *PostcardSize

Ptr returns reference to postcard_size value

func (*PostcardSize) UnmarshalJSON 

func (v *PostcardSize) UnmarshalJSON(src []byte) error

type PostcardsApiService 

type PostcardsApiService service

PostcardsApiService PostcardsApi service

func (*PostcardsApiService) Cancel 

func (a *PostcardsApiService) Cancel(ctx context.Context, pscId string) ApiPostcardDeleteRequest

PostcardDelete cancel

Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pscId id of the postcard
@return ApiPostcardDeleteRequest

func (*PostcardsApiService) Create 

func (a *PostcardsApiService) Create(ctx context.Context) ApiPostcardCreateRequest

PostcardCreate create

Creates a new postcard given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiPostcardCreateRequest

func (*PostcardsApiService) Get 

func (a *PostcardsApiService) Get(ctx context.Context, pscId string) ApiPostcardRetrieveRequest

PostcardRetrieve get

Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pscId id of the postcard
@return ApiPostcardRetrieveRequest

func (*PostcardsApiService) List 

func (a *PostcardsApiService) List(ctx context.Context) ApiPostcardsListRequest

PostcardsList list

Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiPostcardsListRequest

func (*PostcardsApiService) PostcardCreateExecute 

func (a *PostcardsApiService) PostcardCreateExecute(r ApiPostcardCreateRequest) (*Postcard, *http.Response, error)

Execute executes the request 

@return Postcard

func (*PostcardsApiService) PostcardDeleteExecute 

func (a *PostcardsApiService) PostcardDeleteExecute(r ApiPostcardDeleteRequest) (*PostcardDeletion, *http.Response, error)

Execute executes the request 

@return PostcardDeletion

func (*PostcardsApiService) PostcardRetrieveExecute 

func (a *PostcardsApiService) PostcardRetrieveExecute(r ApiPostcardRetrieveRequest) (*Postcard, *http.Response, error)

Execute executes the request 

@return Postcard

func (*PostcardsApiService) PostcardsListExecute 

func (a *PostcardsApiService) PostcardsListExecute(r ApiPostcardsListRequest) (*PostcardList, *http.Response, error)

Execute executes the request 

@return PostcardList

type PscUseType 

type PscUseType string

PscUseType The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). 

const (
	PSCUSETYPE_MARKETING   PscUseType = "marketing"
	PSCUSETYPE_OPERATIONAL PscUseType = "operational"
	PSCUSETYPE_NULL        PscUseType = "null"
)

List of psc_use_type

func NewPscUseTypeFromValue 

func NewPscUseTypeFromValue(v string) (*PscUseType, error)

NewPscUseTypeFromValue returns a pointer to a valid PscUseType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (PscUseType) IsValid 

func (v PscUseType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (PscUseType) Ptr 

func (v PscUseType) Ptr() *PscUseType

Ptr returns reference to psc_use_type value

func (*PscUseType) UnmarshalJSON 

func (v *PscUseType) UnmarshalJSON(src []byte) error

type QrCode 

type QrCode struct {
	// Sets how a QR code is being positioned in the document.
	Position string `json:"position"`
	// Vertical distance(in inches) to place QR code from the top.
	Top *string `json:"top,omitempty"`
	// Horizonal distance(in inches) to place QR code from the right.
	Right *string `json:"right,omitempty"`
	// Horizonal distance(in inches) to place QR code from the left.
	Left *string `json:"left,omitempty"`
	// Vertical distance(in inches) to place QR code from the bottom.
	Bottom *string `json:"bottom,omitempty"`
	// The url to redirect the user when a QR code is scanned. The url must start with `https://`
	RedirectUrl string `json:"redirect_url"`
	// The size(in inches) of the QR code. All QR codes are generated as a square.
	Width string `json:"width"`
}

QrCode Customize and place a QR code on the creative at the required position.

func NewQrCode 

func NewQrCode(position string, redirectUrl string, width string) *QrCode

NewQrCode instantiates a new QrCode object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewQrCodeWithDefaults 

func NewQrCodeWithDefaults() *QrCode

NewQrCodeWithDefaults instantiates a new QrCode object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*QrCode) GetBottom 

func (o *QrCode) GetBottom() string

GetBottom returns the Bottom field value if set, zero value otherwise.

func (*QrCode) GetBottomOk 

func (o *QrCode) GetBottomOk() (*string, bool)

GetBottomOk returns a tuple with the Bottom field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QrCode) GetLeft 

func (o *QrCode) GetLeft() string

GetLeft returns the Left field value if set, zero value otherwise.

func (*QrCode) GetLeftOk 

func (o *QrCode) GetLeftOk() (*string, bool)

GetLeftOk returns a tuple with the Left field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QrCode) GetPosition 

func (o *QrCode) GetPosition() string

GetPosition returns the Position field value

func (*QrCode) GetPositionOk 

func (o *QrCode) GetPositionOk() (*string, bool)

GetPositionOk returns a tuple with the Position field value and a boolean to check if the value has been set.

func (*QrCode) GetRedirectUrl 

func (o *QrCode) GetRedirectUrl() string

GetRedirectUrl returns the RedirectUrl field value

func (*QrCode) GetRedirectUrlOk 

func (o *QrCode) GetRedirectUrlOk() (*string, bool)

GetRedirectUrlOk returns a tuple with the RedirectUrl field value and a boolean to check if the value has been set.

func (*QrCode) GetRight 

func (o *QrCode) GetRight() string

GetRight returns the Right field value if set, zero value otherwise.

func (*QrCode) GetRightOk 

func (o *QrCode) GetRightOk() (*string, bool)

GetRightOk returns a tuple with the Right field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QrCode) GetTop 

func (o *QrCode) GetTop() string

GetTop returns the Top field value if set, zero value otherwise.

func (*QrCode) GetTopOk 

func (o *QrCode) GetTopOk() (*string, bool)

GetTopOk returns a tuple with the Top field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QrCode) GetWidth 

func (o *QrCode) GetWidth() string

GetWidth returns the Width field value

func (*QrCode) GetWidthOk 

func (o *QrCode) GetWidthOk() (*string, bool)

GetWidthOk returns a tuple with the Width field value and a boolean to check if the value has been set.

func (*QrCode) HasBottom 

func (o *QrCode) HasBottom() bool

HasBottom returns a boolean if a field has been set.

func (*QrCode) HasLeft 

func (o *QrCode) HasLeft() bool

HasLeft returns a boolean if a field has been set.

func (*QrCode) HasRight 

func (o *QrCode) HasRight() bool

HasRight returns a boolean if a field has been set.

func (*QrCode) HasTop 

func (o *QrCode) HasTop() bool

HasTop returns a boolean if a field has been set.

func (QrCode) MarshalJSON 

func (o QrCode) MarshalJSON() ([]byte, error)

func (*QrCode) SetBottom 

func (o *QrCode) SetBottom(v string)

SetBottom gets a reference to the given string and assigns it to the Bottom field.

func (*QrCode) SetLeft 

func (o *QrCode) SetLeft(v string)

SetLeft gets a reference to the given string and assigns it to the Left field.

func (*QrCode) SetPosition 

func (o *QrCode) SetPosition(v string)

SetPosition sets field value

func (*QrCode) SetRedirectUrl 

func (o *QrCode) SetRedirectUrl(v string)

SetRedirectUrl sets field value

func (*QrCode) SetRight 

func (o *QrCode) SetRight(v string)

SetRight gets a reference to the given string and assigns it to the Right field.

func (*QrCode) SetTop 

func (o *QrCode) SetTop(v string)

SetTop gets a reference to the given string and assigns it to the Top field.

func (*QrCode) SetWidth 

func (o *QrCode) SetWidth(v string)

SetWidth sets field value

type RequiredAddressColumnMapping 

type RequiredAddressColumnMapping struct {
	// The column header from the csv file that should be mapped to the required field `name`
	Name NullableString `json:"name"`
	// The column header from the csv file that should be mapped to the required field `address_line1`
	AddressLine1 NullableString `json:"address_line1"`
	// The column header from the csv file that should be mapped to the required field `address_city`
	AddressCity NullableString `json:"address_city"`
	// The column header from the csv file that should be mapped to the required field `address_state`
	AddressState NullableString `json:"address_state"`
	// The column header from the csv file that should be mapped to the required field `address_zip`
	AddressZip NullableString `json:"address_zip"`
}

RequiredAddressColumnMapping The mapping of column headers in your file to Lob-required fields for the resource created. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#required-columns-2\" target=\"_blank\">Campaign Audience Guide</a> for additional details.

func NewRequiredAddressColumnMapping 

func NewRequiredAddressColumnMapping(name NullableString, addressLine1 NullableString, addressCity NullableString, addressState NullableString, addressZip NullableString) *RequiredAddressColumnMapping

NewRequiredAddressColumnMapping instantiates a new RequiredAddressColumnMapping object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRequiredAddressColumnMappingWithDefaults 

func NewRequiredAddressColumnMappingWithDefaults() *RequiredAddressColumnMapping

NewRequiredAddressColumnMappingWithDefaults instantiates a new RequiredAddressColumnMapping object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RequiredAddressColumnMapping) GetAddressCity 

func (o *RequiredAddressColumnMapping) GetAddressCity() string

GetAddressCity returns the AddressCity field value If the value is explicit nil, the zero value for string will be returned

func (*RequiredAddressColumnMapping) GetAddressCityOk 

func (o *RequiredAddressColumnMapping) GetAddressCityOk() (*string, bool)

GetAddressCityOk returns a tuple with the AddressCity field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*RequiredAddressColumnMapping) GetAddressLine1 

func (o *RequiredAddressColumnMapping) GetAddressLine1() string

GetAddressLine1 returns the AddressLine1 field value If the value is explicit nil, the zero value for string will be returned

func (*RequiredAddressColumnMapping) GetAddressLine1Ok 

func (o *RequiredAddressColumnMapping) GetAddressLine1Ok() (*string, bool)

GetAddressLine1Ok returns a tuple with the AddressLine1 field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*RequiredAddressColumnMapping) GetAddressState 

func (o *RequiredAddressColumnMapping) GetAddressState() string

GetAddressState returns the AddressState field value If the value is explicit nil, the zero value for string will be returned

func (*RequiredAddressColumnMapping) GetAddressStateOk 

func (o *RequiredAddressColumnMapping) GetAddressStateOk() (*string, bool)

GetAddressStateOk returns a tuple with the AddressState field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*RequiredAddressColumnMapping) GetAddressZip 

func (o *RequiredAddressColumnMapping) GetAddressZip() string

GetAddressZip returns the AddressZip field value If the value is explicit nil, the zero value for string will be returned

func (*RequiredAddressColumnMapping) GetAddressZipOk 

func (o *RequiredAddressColumnMapping) GetAddressZipOk() (*string, bool)

GetAddressZipOk returns a tuple with the AddressZip field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*RequiredAddressColumnMapping) GetName 

func (o *RequiredAddressColumnMapping) GetName() string

GetName returns the Name field value If the value is explicit nil, the zero value for string will be returned

func (*RequiredAddressColumnMapping) GetNameOk 

func (o *RequiredAddressColumnMapping) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (RequiredAddressColumnMapping) MarshalJSON 

func (o RequiredAddressColumnMapping) MarshalJSON() ([]byte, error)

func (*RequiredAddressColumnMapping) SetAddressCity 

func (o *RequiredAddressColumnMapping) SetAddressCity(v string)

SetAddressCity sets field value

func (*RequiredAddressColumnMapping) SetAddressLine1 

func (o *RequiredAddressColumnMapping) SetAddressLine1(v string)

SetAddressLine1 sets field value

func (*RequiredAddressColumnMapping) SetAddressState 

func (o *RequiredAddressColumnMapping) SetAddressState(v string)

SetAddressState sets field value

func (*RequiredAddressColumnMapping) SetAddressZip 

func (o *RequiredAddressColumnMapping) SetAddressZip(v string)

SetAddressZip sets field value

func (*RequiredAddressColumnMapping) SetName 

func (o *RequiredAddressColumnMapping) SetName(v string)

SetName sets field value

type ReturnEnvelope 

type ReturnEnvelope struct {
	// The unique ID of the Return Envelope
	Id *string `json:"id,omitempty"`
	// A quick reference name for the Return Envelope
	Alias *string `json:"alias,omitempty"`
	// The url of the  return envelope
	Url    *string `json:"url,omitempty"`
	Object *string `json:"object,omitempty"`
}

ReturnEnvelope struct for ReturnEnvelope

func NewReturnEnvelope 

func NewReturnEnvelope() *ReturnEnvelope

NewReturnEnvelope instantiates a new ReturnEnvelope object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReturnEnvelopeWithDefaults 

func NewReturnEnvelopeWithDefaults() *ReturnEnvelope

NewReturnEnvelopeWithDefaults instantiates a new ReturnEnvelope object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ReturnEnvelope) GetAlias 

func (o *ReturnEnvelope) GetAlias() string

GetAlias returns the Alias field value if set, zero value otherwise.

func (*ReturnEnvelope) GetAliasOk 

func (o *ReturnEnvelope) GetAliasOk() (*string, bool)

GetAliasOk returns a tuple with the Alias field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReturnEnvelope) GetId 

func (o *ReturnEnvelope) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ReturnEnvelope) GetIdOk 

func (o *ReturnEnvelope) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReturnEnvelope) GetObject 

func (o *ReturnEnvelope) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*ReturnEnvelope) GetObjectOk 

func (o *ReturnEnvelope) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReturnEnvelope) GetUrl 

func (o *ReturnEnvelope) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*ReturnEnvelope) GetUrlOk 

func (o *ReturnEnvelope) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReturnEnvelope) HasAlias 

func (o *ReturnEnvelope) HasAlias() bool

HasAlias returns a boolean if a field has been set.

func (*ReturnEnvelope) HasId 

func (o *ReturnEnvelope) HasId() bool

HasId returns a boolean if a field has been set.

func (*ReturnEnvelope) HasObject 

func (o *ReturnEnvelope) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*ReturnEnvelope) HasUrl 

func (o *ReturnEnvelope) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (ReturnEnvelope) MarshalJSON 

func (o ReturnEnvelope) MarshalJSON() ([]byte, error)

func (*ReturnEnvelope) SetAlias 

func (o *ReturnEnvelope) SetAlias(v string)

SetAlias gets a reference to the given string and assigns it to the Alias field.

func (*ReturnEnvelope) SetId 

func (o *ReturnEnvelope) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*ReturnEnvelope) SetObject 

func (o *ReturnEnvelope) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*ReturnEnvelope) SetUrl 

func (o *ReturnEnvelope) SetUrl(v string)

SetUrl gets a reference to the given string and assigns it to the Url field.

type ReverseGeocode 

type ReverseGeocode struct {
	// Unique identifier prefixed with `us_reverse_geocode_`.
	Id *string `json:"id,omitempty"`
	// list of addresses
	Addresses []GeocodeAddresses `json:"addresses,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

ReverseGeocode struct for ReverseGeocode

func NewReverseGeocode 

func NewReverseGeocode() *ReverseGeocode

NewReverseGeocode instantiates a new ReverseGeocode object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReverseGeocodeWithDefaults 

func NewReverseGeocodeWithDefaults() *ReverseGeocode

NewReverseGeocodeWithDefaults instantiates a new ReverseGeocode object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ReverseGeocode) GetAddresses 

func (o *ReverseGeocode) GetAddresses() []GeocodeAddresses

GetAddresses returns the Addresses field value if set, zero value otherwise.

func (*ReverseGeocode) GetAddressesOk 

func (o *ReverseGeocode) GetAddressesOk() ([]GeocodeAddresses, bool)

GetAddressesOk returns a tuple with the Addresses field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReverseGeocode) GetId 

func (o *ReverseGeocode) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ReverseGeocode) GetIdOk 

func (o *ReverseGeocode) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReverseGeocode) GetObject 

func (o *ReverseGeocode) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*ReverseGeocode) GetObjectOk 

func (o *ReverseGeocode) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReverseGeocode) HasAddresses 

func (o *ReverseGeocode) HasAddresses() bool

HasAddresses returns a boolean if a field has been set.

func (*ReverseGeocode) HasId 

func (o *ReverseGeocode) HasId() bool

HasId returns a boolean if a field has been set.

func (*ReverseGeocode) HasObject 

func (o *ReverseGeocode) HasObject() bool

HasObject returns a boolean if a field has been set.

func (ReverseGeocode) MarshalJSON 

func (o ReverseGeocode) MarshalJSON() ([]byte, error)

func (*ReverseGeocode) SetAddresses 

func (o *ReverseGeocode) SetAddresses(v []GeocodeAddresses)

SetAddresses gets a reference to the given []GeocodeAddresses and assigns it to the Addresses field.

func (*ReverseGeocode) SetId 

func (o *ReverseGeocode) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*ReverseGeocode) SetObject 

func (o *ReverseGeocode) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type ReverseGeocodeLookupsApiService 

type ReverseGeocodeLookupsApiService service

ReverseGeocodeLookupsApiService ReverseGeocodeLookupsApi service

func (*ReverseGeocodeLookupsApiService) Lookup 

func (a *ReverseGeocodeLookupsApiService) Lookup(ctx context.Context) ApiReverseGeocodeLookupRequest

ReverseGeocodeLookup lookup

Reverse geocode a valid US location with a live API key. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiReverseGeocodeLookupRequest

func (*ReverseGeocodeLookupsApiService) ReverseGeocodeLookupExecute 

func (a *ReverseGeocodeLookupsApiService) ReverseGeocodeLookupExecute(r ApiReverseGeocodeLookupRequest) (*ReverseGeocode, *http.Response, error)

Execute executes the request 

@return ReverseGeocode

type SelfMailer 

type SelfMailer struct {
	// Unique identifier prefixed with `sfm_`.
	Id   string          `json:"id"`
	To   interface{}     `json:"to"`
	From interface{}     `json:"from,omitempty"`
	Size *SelfMailerSize `json:"size,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	MailType *MailType          `json:"mail_type,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time `json:"send_date,omitempty"`
	// The unique ID of the HTML template used for the outside of the self mailer.
	OutsideTemplateId NullableString `json:"outside_template_id,omitempty"`
	// The unique ID of the HTML template used for the inside of the self mailer.
	InsideTemplateId NullableString `json:"inside_template_id,omitempty"`
	// The unique ID of the specific version of the HTML template used for the outside of the self mailer.
	OutsideTemplateVersionId NullableString `json:"outside_template_version_id,omitempty"`
	// The unique ID of the specific version of the HTML template used for the inside of the self mailer.
	InsideTemplateVersionId NullableString `json:"inside_template_version_id,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
	// An array of certified tracking events ordered by ascending `time`. Not populated in test mode.
	TrackingEvents []TrackingEventCertified `json:"tracking_events,omitempty"`
	// A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
	Url     string             `json:"url"`
	UseType NullableSfmUseType `json:"use_type"`
}

SelfMailer struct for SelfMailer

func NewSelfMailer 

func NewSelfMailer(id string, to interface{}, url string, useType NullableSfmUseType) *SelfMailer

NewSelfMailer instantiates a new SelfMailer object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSelfMailerWithDefaults 

func NewSelfMailerWithDefaults() *SelfMailer

NewSelfMailerWithDefaults instantiates a new SelfMailer object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SelfMailer) GetDescription 

func (o *SelfMailer) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailer) GetDescriptionOk 

func (o *SelfMailer) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetFrom 

func (o *SelfMailer) GetFrom() interface{}

GetFrom returns the From field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailer) GetFromOk 

func (o *SelfMailer) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetId 

func (o *SelfMailer) GetId() string

GetId returns the Id field value

func (*SelfMailer) GetIdOk 

func (o *SelfMailer) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*SelfMailer) GetInsideTemplateId 

func (o *SelfMailer) GetInsideTemplateId() string

GetInsideTemplateId returns the InsideTemplateId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailer) GetInsideTemplateIdOk 

func (o *SelfMailer) GetInsideTemplateIdOk() (*string, bool)

GetInsideTemplateIdOk returns a tuple with the InsideTemplateId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetInsideTemplateVersionId 

func (o *SelfMailer) GetInsideTemplateVersionId() string

GetInsideTemplateVersionId returns the InsideTemplateVersionId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailer) GetInsideTemplateVersionIdOk 

func (o *SelfMailer) GetInsideTemplateVersionIdOk() (*string, bool)

GetInsideTemplateVersionIdOk returns a tuple with the InsideTemplateVersionId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetMailType 

func (o *SelfMailer) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*SelfMailer) GetMailTypeOk 

func (o *SelfMailer) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailer) GetMergeVariables 

func (o *SelfMailer) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailer) GetMergeVariablesOk 

func (o *SelfMailer) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetMetadata 

func (o *SelfMailer) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*SelfMailer) GetMetadataOk 

func (o *SelfMailer) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailer) GetObject 

func (o *SelfMailer) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*SelfMailer) GetObjectOk 

func (o *SelfMailer) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailer) GetOutsideTemplateId 

func (o *SelfMailer) GetOutsideTemplateId() string

GetOutsideTemplateId returns the OutsideTemplateId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailer) GetOutsideTemplateIdOk 

func (o *SelfMailer) GetOutsideTemplateIdOk() (*string, bool)

GetOutsideTemplateIdOk returns a tuple with the OutsideTemplateId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetOutsideTemplateVersionId 

func (o *SelfMailer) GetOutsideTemplateVersionId() string

GetOutsideTemplateVersionId returns the OutsideTemplateVersionId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailer) GetOutsideTemplateVersionIdOk 

func (o *SelfMailer) GetOutsideTemplateVersionIdOk() (*string, bool)

GetOutsideTemplateVersionIdOk returns a tuple with the OutsideTemplateVersionId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetSendDate 

func (o *SelfMailer) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*SelfMailer) GetSendDateOk 

func (o *SelfMailer) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailer) GetSize 

func (o *SelfMailer) GetSize() SelfMailerSize

GetSize returns the Size field value if set, zero value otherwise.

func (*SelfMailer) GetSizeOk 

func (o *SelfMailer) GetSizeOk() (*SelfMailerSize, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailer) GetTo 

func (o *SelfMailer) GetTo() interface{}

GetTo returns the To field value If the value is explicit nil, the zero value for interface{} will be returned

func (*SelfMailer) GetToOk 

func (o *SelfMailer) GetToOk() (*interface{}, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) GetTrackingEvents 

func (o *SelfMailer) GetTrackingEvents() []TrackingEventCertified

GetTrackingEvents returns the TrackingEvents field value if set, zero value otherwise.

func (*SelfMailer) GetTrackingEventsOk 

func (o *SelfMailer) GetTrackingEventsOk() ([]TrackingEventCertified, bool)

GetTrackingEventsOk returns a tuple with the TrackingEvents field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailer) GetUrl 

func (o *SelfMailer) GetUrl() string

GetUrl returns the Url field value

func (*SelfMailer) GetUrlOk 

func (o *SelfMailer) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*SelfMailer) GetUseType 

func (o *SelfMailer) GetUseType() SfmUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for SfmUseType will be returned

func (*SelfMailer) GetUseTypeOk 

func (o *SelfMailer) GetUseTypeOk() (*SfmUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailer) HasDescription 

func (o *SelfMailer) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*SelfMailer) HasFrom 

func (o *SelfMailer) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*SelfMailer) HasInsideTemplateId 

func (o *SelfMailer) HasInsideTemplateId() bool

HasInsideTemplateId returns a boolean if a field has been set.

func (*SelfMailer) HasInsideTemplateVersionId 

func (o *SelfMailer) HasInsideTemplateVersionId() bool

HasInsideTemplateVersionId returns a boolean if a field has been set.

func (*SelfMailer) HasMailType 

func (o *SelfMailer) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*SelfMailer) HasMergeVariables 

func (o *SelfMailer) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*SelfMailer) HasMetadata 

func (o *SelfMailer) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*SelfMailer) HasObject 

func (o *SelfMailer) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*SelfMailer) HasOutsideTemplateId 

func (o *SelfMailer) HasOutsideTemplateId() bool

HasOutsideTemplateId returns a boolean if a field has been set.

func (*SelfMailer) HasOutsideTemplateVersionId 

func (o *SelfMailer) HasOutsideTemplateVersionId() bool

HasOutsideTemplateVersionId returns a boolean if a field has been set.

func (*SelfMailer) HasSendDate 

func (o *SelfMailer) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*SelfMailer) HasSize 

func (o *SelfMailer) HasSize() bool

HasSize returns a boolean if a field has been set.

func (*SelfMailer) HasTrackingEvents 

func (o *SelfMailer) HasTrackingEvents() bool

HasTrackingEvents returns a boolean if a field has been set.

func (SelfMailer) MarshalJSON 

func (o SelfMailer) MarshalJSON() ([]byte, error)

func (*SelfMailer) SetDescription 

func (o *SelfMailer) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*SelfMailer) SetDescriptionNil 

func (o *SelfMailer) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*SelfMailer) SetFrom 

func (o *SelfMailer) SetFrom(v interface{})

SetFrom gets a reference to the given interface{} and assigns it to the From field.

func (*SelfMailer) SetId 

func (o *SelfMailer) SetId(v string)

SetId sets field value

func (*SelfMailer) SetInsideTemplateId 

func (o *SelfMailer) SetInsideTemplateId(v string)

SetInsideTemplateId gets a reference to the given NullableString and assigns it to the InsideTemplateId field.

func (*SelfMailer) SetInsideTemplateIdNil 

func (o *SelfMailer) SetInsideTemplateIdNil()

SetInsideTemplateIdNil sets the value for InsideTemplateId to be an explicit nil

func (*SelfMailer) SetInsideTemplateVersionId 

func (o *SelfMailer) SetInsideTemplateVersionId(v string)

SetInsideTemplateVersionId gets a reference to the given NullableString and assigns it to the InsideTemplateVersionId field.

func (*SelfMailer) SetInsideTemplateVersionIdNil 

func (o *SelfMailer) SetInsideTemplateVersionIdNil()

SetInsideTemplateVersionIdNil sets the value for InsideTemplateVersionId to be an explicit nil

func (*SelfMailer) SetMailType 

func (o *SelfMailer) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*SelfMailer) SetMergeVariables 

func (o *SelfMailer) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*SelfMailer) SetMetadata 

func (o *SelfMailer) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*SelfMailer) SetObject 

func (o *SelfMailer) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*SelfMailer) SetOutsideTemplateId 

func (o *SelfMailer) SetOutsideTemplateId(v string)

SetOutsideTemplateId gets a reference to the given NullableString and assigns it to the OutsideTemplateId field.

func (*SelfMailer) SetOutsideTemplateIdNil 

func (o *SelfMailer) SetOutsideTemplateIdNil()

SetOutsideTemplateIdNil sets the value for OutsideTemplateId to be an explicit nil

func (*SelfMailer) SetOutsideTemplateVersionId 

func (o *SelfMailer) SetOutsideTemplateVersionId(v string)

SetOutsideTemplateVersionId gets a reference to the given NullableString and assigns it to the OutsideTemplateVersionId field.

func (*SelfMailer) SetOutsideTemplateVersionIdNil 

func (o *SelfMailer) SetOutsideTemplateVersionIdNil()

SetOutsideTemplateVersionIdNil sets the value for OutsideTemplateVersionId to be an explicit nil

func (*SelfMailer) SetSendDate 

func (o *SelfMailer) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*SelfMailer) SetSize 

func (o *SelfMailer) SetSize(v SelfMailerSize)

SetSize gets a reference to the given SelfMailerSize and assigns it to the Size field.

func (*SelfMailer) SetTo 

func (o *SelfMailer) SetTo(v interface{})

SetTo sets field value

func (*SelfMailer) SetTrackingEvents 

func (o *SelfMailer) SetTrackingEvents(v []TrackingEventCertified)

SetTrackingEvents gets a reference to the given []TrackingEventCertified and assigns it to the TrackingEvents field.

func (*SelfMailer) SetUrl 

func (o *SelfMailer) SetUrl(v string)

SetUrl sets field value

func (*SelfMailer) SetUseType 

func (o *SelfMailer) SetUseType(v SfmUseType)

SetUseType sets field value

func (*SelfMailer) UnsetDescription 

func (o *SelfMailer) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*SelfMailer) UnsetInsideTemplateId 

func (o *SelfMailer) UnsetInsideTemplateId()

UnsetInsideTemplateId ensures that no value is present for InsideTemplateId, not even an explicit nil

func (*SelfMailer) UnsetInsideTemplateVersionId 

func (o *SelfMailer) UnsetInsideTemplateVersionId()

UnsetInsideTemplateVersionId ensures that no value is present for InsideTemplateVersionId, not even an explicit nil

func (*SelfMailer) UnsetOutsideTemplateId 

func (o *SelfMailer) UnsetOutsideTemplateId()

UnsetOutsideTemplateId ensures that no value is present for OutsideTemplateId, not even an explicit nil

func (*SelfMailer) UnsetOutsideTemplateVersionId 

func (o *SelfMailer) UnsetOutsideTemplateVersionId()

UnsetOutsideTemplateVersionId ensures that no value is present for OutsideTemplateVersionId, not even an explicit nil

type SelfMailerDeletion 

type SelfMailerDeletion struct {
	// Unique identifier prefixed with `sfm_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

SelfMailerDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewSelfMailerDeletion 

func NewSelfMailerDeletion() *SelfMailerDeletion

NewSelfMailerDeletion instantiates a new SelfMailerDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSelfMailerDeletionWithDefaults 

func NewSelfMailerDeletionWithDefaults() *SelfMailerDeletion

NewSelfMailerDeletionWithDefaults instantiates a new SelfMailerDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SelfMailerDeletion) GetDeleted 

func (o *SelfMailerDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*SelfMailerDeletion) GetDeletedOk 

func (o *SelfMailerDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerDeletion) GetId 

func (o *SelfMailerDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*SelfMailerDeletion) GetIdOk 

func (o *SelfMailerDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerDeletion) GetObject 

func (o *SelfMailerDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*SelfMailerDeletion) GetObjectOk 

func (o *SelfMailerDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerDeletion) HasDeleted 

func (o *SelfMailerDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*SelfMailerDeletion) HasId 

func (o *SelfMailerDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*SelfMailerDeletion) HasObject 

func (o *SelfMailerDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (SelfMailerDeletion) MarshalJSON 

func (o SelfMailerDeletion) MarshalJSON() ([]byte, error)

func (*SelfMailerDeletion) SetDeleted 

func (o *SelfMailerDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*SelfMailerDeletion) SetId 

func (o *SelfMailerDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*SelfMailerDeletion) SetObject 

func (o *SelfMailerDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type SelfMailerEditable 

type SelfMailerEditable struct {
	// Must either be an address ID or an inline object with correct address parameters.
	To interface{} `json:"to"`
	// Must either be an address ID or an inline object with correct address parameters.
	From interface{}     `json:"from,omitempty"`
	Size *SelfMailerSize `json:"size,omitempty"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	MailType *MailType          `json:"mail_type,omitempty"`
	// You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, “ ` “, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
	SendDate *time.Time `json:"send_date,omitempty"`
	// The artwork to use as the inside of your self mailer.
	Inside string `json:"inside"`
	// The artwork to use as the outside of your self mailer.
	Outside string `json:"outside"`
	// An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.
	BillingGroupId *string            `json:"billing_group_id,omitempty"`
	UseType        NullableSfmUseType `json:"use_type"`
}

SelfMailerEditable struct for SelfMailerEditable

func NewSelfMailerEditable 

func NewSelfMailerEditable(to interface{}, inside string, outside string, useType NullableSfmUseType) *SelfMailerEditable

NewSelfMailerEditable instantiates a new SelfMailerEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSelfMailerEditableWithDefaults 

func NewSelfMailerEditableWithDefaults() *SelfMailerEditable

NewSelfMailerEditableWithDefaults instantiates a new SelfMailerEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SelfMailerEditable) GetBillingGroupId 

func (o *SelfMailerEditable) GetBillingGroupId() string

GetBillingGroupId returns the BillingGroupId field value if set, zero value otherwise.

func (*SelfMailerEditable) GetBillingGroupIdOk 

func (o *SelfMailerEditable) GetBillingGroupIdOk() (*string, bool)

GetBillingGroupIdOk returns a tuple with the BillingGroupId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerEditable) GetDescription 

func (o *SelfMailerEditable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailerEditable) GetDescriptionOk 

func (o *SelfMailerEditable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailerEditable) GetFrom 

func (o *SelfMailerEditable) GetFrom() interface{}

GetFrom returns the From field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailerEditable) GetFromOk 

func (o *SelfMailerEditable) GetFromOk() (*interface{}, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailerEditable) GetInside 

func (o *SelfMailerEditable) GetInside() string

GetInside returns the Inside field value

func (*SelfMailerEditable) GetInsideOk 

func (o *SelfMailerEditable) GetInsideOk() (*string, bool)

GetInsideOk returns a tuple with the Inside field value and a boolean to check if the value has been set.

func (*SelfMailerEditable) GetMailType 

func (o *SelfMailerEditable) GetMailType() MailType

GetMailType returns the MailType field value if set, zero value otherwise.

func (*SelfMailerEditable) GetMailTypeOk 

func (o *SelfMailerEditable) GetMailTypeOk() (*MailType, bool)

GetMailTypeOk returns a tuple with the MailType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerEditable) GetMergeVariables 

func (o *SelfMailerEditable) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailerEditable) GetMergeVariablesOk 

func (o *SelfMailerEditable) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailerEditable) GetMetadata 

func (o *SelfMailerEditable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*SelfMailerEditable) GetMetadataOk 

func (o *SelfMailerEditable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerEditable) GetOutside 

func (o *SelfMailerEditable) GetOutside() string

GetOutside returns the Outside field value

func (*SelfMailerEditable) GetOutsideOk 

func (o *SelfMailerEditable) GetOutsideOk() (*string, bool)

GetOutsideOk returns a tuple with the Outside field value and a boolean to check if the value has been set.

func (*SelfMailerEditable) GetSendDate 

func (o *SelfMailerEditable) GetSendDate() time.Time

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*SelfMailerEditable) GetSendDateOk 

func (o *SelfMailerEditable) GetSendDateOk() (*time.Time, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerEditable) GetSize 

func (o *SelfMailerEditable) GetSize() SelfMailerSize

GetSize returns the Size field value if set, zero value otherwise.

func (*SelfMailerEditable) GetSizeOk 

func (o *SelfMailerEditable) GetSizeOk() (*SelfMailerSize, bool)

GetSizeOk returns a tuple with the Size field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerEditable) GetTo 

func (o *SelfMailerEditable) GetTo() interface{}

GetTo returns the To field value If the value is explicit nil, the zero value for interface{} will be returned

func (*SelfMailerEditable) GetToOk 

func (o *SelfMailerEditable) GetToOk() (*interface{}, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailerEditable) GetUseType 

func (o *SelfMailerEditable) GetUseType() SfmUseType

GetUseType returns the UseType field value If the value is explicit nil, the zero value for SfmUseType will be returned

func (*SelfMailerEditable) GetUseTypeOk 

func (o *SelfMailerEditable) GetUseTypeOk() (*SfmUseType, bool)

GetUseTypeOk returns a tuple with the UseType field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailerEditable) HasBillingGroupId 

func (o *SelfMailerEditable) HasBillingGroupId() bool

HasBillingGroupId returns a boolean if a field has been set.

func (*SelfMailerEditable) HasDescription 

func (o *SelfMailerEditable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*SelfMailerEditable) HasFrom 

func (o *SelfMailerEditable) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*SelfMailerEditable) HasMailType 

func (o *SelfMailerEditable) HasMailType() bool

HasMailType returns a boolean if a field has been set.

func (*SelfMailerEditable) HasMergeVariables 

func (o *SelfMailerEditable) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*SelfMailerEditable) HasMetadata 

func (o *SelfMailerEditable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*SelfMailerEditable) HasSendDate 

func (o *SelfMailerEditable) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (*SelfMailerEditable) HasSize 

func (o *SelfMailerEditable) HasSize() bool

HasSize returns a boolean if a field has been set.

func (SelfMailerEditable) MarshalJSON 

func (o SelfMailerEditable) MarshalJSON() ([]byte, error)

func (*SelfMailerEditable) SetBillingGroupId 

func (o *SelfMailerEditable) SetBillingGroupId(v string)

SetBillingGroupId gets a reference to the given string and assigns it to the BillingGroupId field.

func (*SelfMailerEditable) SetDescription 

func (o *SelfMailerEditable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*SelfMailerEditable) SetDescriptionNil 

func (o *SelfMailerEditable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*SelfMailerEditable) SetFrom 

func (o *SelfMailerEditable) SetFrom(v interface{})

SetFrom gets a reference to the given interface{} and assigns it to the From field.

func (*SelfMailerEditable) SetInside 

func (o *SelfMailerEditable) SetInside(v string)

SetInside sets field value

func (*SelfMailerEditable) SetMailType 

func (o *SelfMailerEditable) SetMailType(v MailType)

SetMailType gets a reference to the given MailType and assigns it to the MailType field.

func (*SelfMailerEditable) SetMergeVariables 

func (o *SelfMailerEditable) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*SelfMailerEditable) SetMetadata 

func (o *SelfMailerEditable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*SelfMailerEditable) SetOutside 

func (o *SelfMailerEditable) SetOutside(v string)

SetOutside sets field value

func (*SelfMailerEditable) SetSendDate 

func (o *SelfMailerEditable) SetSendDate(v time.Time)

SetSendDate gets a reference to the given time.Time and assigns it to the SendDate field.

func (*SelfMailerEditable) SetSize 

func (o *SelfMailerEditable) SetSize(v SelfMailerSize)

SetSize gets a reference to the given SelfMailerSize and assigns it to the Size field.

func (*SelfMailerEditable) SetTo 

func (o *SelfMailerEditable) SetTo(v interface{})

SetTo sets field value

func (*SelfMailerEditable) SetUseType 

func (o *SelfMailerEditable) SetUseType(v SfmUseType)

SetUseType sets field value

func (*SelfMailerEditable) UnsetDescription 

func (o *SelfMailerEditable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type SelfMailerList 

type SelfMailerList struct {
	// list of self-mailers
	Data []SelfMailer `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

SelfMailerList struct for SelfMailerList

func NewSelfMailerList 

func NewSelfMailerList() *SelfMailerList

NewSelfMailerList instantiates a new SelfMailerList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSelfMailerListWithDefaults 

func NewSelfMailerListWithDefaults() *SelfMailerList

NewSelfMailerListWithDefaults instantiates a new SelfMailerList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SelfMailerList) GetCount 

func (o *SelfMailerList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*SelfMailerList) GetCountOk 

func (o *SelfMailerList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerList) GetData 

func (o *SelfMailerList) GetData() []SelfMailer

GetData returns the Data field value if set, zero value otherwise.

func (*SelfMailerList) GetDataOk 

func (o *SelfMailerList) GetDataOk() ([]SelfMailer, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerList) GetNextPageToken 

func (o *SelfMailerList) GetNextPageToken() string

func (*SelfMailerList) GetNextUrl 

func (o *SelfMailerList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailerList) GetNextUrlOk 

func (o *SelfMailerList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailerList) GetObject 

func (o *SelfMailerList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*SelfMailerList) GetObjectOk 

func (o *SelfMailerList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerList) GetPrevPageToken 

func (o *SelfMailerList) GetPrevPageToken() string

func (*SelfMailerList) GetPreviousUrl 

func (o *SelfMailerList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SelfMailerList) GetPreviousUrlOk 

func (o *SelfMailerList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*SelfMailerList) GetTotalCount 

func (o *SelfMailerList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*SelfMailerList) GetTotalCountOk 

func (o *SelfMailerList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SelfMailerList) HasCount 

func (o *SelfMailerList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*SelfMailerList) HasData 

func (o *SelfMailerList) HasData() bool

HasData returns a boolean if a field has been set.

func (*SelfMailerList) HasNextUrl 

func (o *SelfMailerList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*SelfMailerList) HasObject 

func (o *SelfMailerList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*SelfMailerList) HasPreviousUrl 

func (o *SelfMailerList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*SelfMailerList) HasTotalCount 

func (o *SelfMailerList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (SelfMailerList) MarshalJSON 

func (o SelfMailerList) MarshalJSON() ([]byte, error)

func (*SelfMailerList) SetCount 

func (o *SelfMailerList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*SelfMailerList) SetData 

func (o *SelfMailerList) SetData(v []SelfMailer)

SetData gets a reference to the given []SelfMailer and assigns it to the Data field.

func (*SelfMailerList) SetNextUrl 

func (o *SelfMailerList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*SelfMailerList) SetNextUrlNil 

func (o *SelfMailerList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*SelfMailerList) SetObject 

func (o *SelfMailerList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*SelfMailerList) SetPreviousUrl 

func (o *SelfMailerList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*SelfMailerList) SetPreviousUrlNil 

func (o *SelfMailerList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*SelfMailerList) SetTotalCount 

func (o *SelfMailerList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*SelfMailerList) UnsetNextUrl 

func (o *SelfMailerList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*SelfMailerList) UnsetPreviousUrl 

func (o *SelfMailerList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type SelfMailerSize 

type SelfMailerSize string

SelfMailerSize Specifies the size of the self mailer. 

const (
	SELFMAILERSIZE__6X18_BIFOLD SelfMailerSize = "6x18_bifold"
	SELFMAILERSIZE__11X9_BIFOLD SelfMailerSize = "11x9_bifold"
	SELFMAILERSIZE__12X9_BIFOLD SelfMailerSize = "12x9_bifold"
)

List of self_mailer_size

func NewSelfMailerSizeFromValue 

func NewSelfMailerSizeFromValue(v string) (*SelfMailerSize, error)

NewSelfMailerSizeFromValue returns a pointer to a valid SelfMailerSize for the value passed as argument, or an error if the value passed is not allowed by the enum

func (SelfMailerSize) IsValid 

func (v SelfMailerSize) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (SelfMailerSize) Ptr 

func (v SelfMailerSize) Ptr() *SelfMailerSize

Ptr returns reference to self_mailer_size value

func (*SelfMailerSize) UnmarshalJSON 

func (v *SelfMailerSize) UnmarshalJSON(src []byte) error

type SelfMailersApiService 

type SelfMailersApiService service

SelfMailersApiService SelfMailersApi service

func (*SelfMailersApiService) Create 

func (a *SelfMailersApiService) Create(ctx context.Context) ApiSelfMailerCreateRequest

SelfMailerCreate create

Creates a new self_mailer given information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiSelfMailerCreateRequest

func (*SelfMailersApiService) Delete 

func (a *SelfMailersApiService) Delete(ctx context.Context, sfmId string) ApiSelfMailerDeleteRequest

SelfMailerDelete delete

Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param sfmId id of the self_mailer
@return ApiSelfMailerDeleteRequest

func (*SelfMailersApiService) Get 

func (a *SelfMailersApiService) Get(ctx context.Context, sfmId string) ApiSelfMailerRetrieveRequest

SelfMailerRetrieve get

Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param sfmId id of the self_mailer
@return ApiSelfMailerRetrieveRequest

func (*SelfMailersApiService) List 

func (a *SelfMailersApiService) List(ctx context.Context) ApiSelfMailersListRequest

SelfMailersList list

Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiSelfMailersListRequest

func (*SelfMailersApiService) SelfMailerCreateExecute 

func (a *SelfMailersApiService) SelfMailerCreateExecute(r ApiSelfMailerCreateRequest) (*SelfMailer, *http.Response, error)

Execute executes the request 

@return SelfMailer

func (*SelfMailersApiService) SelfMailerDeleteExecute 

func (a *SelfMailersApiService) SelfMailerDeleteExecute(r ApiSelfMailerDeleteRequest) (*SelfMailerDeletion, *http.Response, error)

Execute executes the request 

@return SelfMailerDeletion

func (*SelfMailersApiService) SelfMailerRetrieveExecute 

func (a *SelfMailersApiService) SelfMailerRetrieveExecute(r ApiSelfMailerRetrieveRequest) (*SelfMailer, *http.Response, error)

Execute executes the request 

@return SelfMailer

func (*SelfMailersApiService) SelfMailersListExecute 

func (a *SelfMailersApiService) SelfMailersListExecute(r ApiSelfMailersListRequest) (*SelfMailerList, *http.Response, error)

Execute executes the request 

@return SelfMailerList

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SfmUseType 

type SfmUseType string

SfmUseType The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). 

const (
	SFMUSETYPE_MARKETING   SfmUseType = "marketing"
	SFMUSETYPE_OPERATIONAL SfmUseType = "operational"
	SFMUSETYPE_NULL        SfmUseType = "null"
)

List of sfm_use_type

func NewSfmUseTypeFromValue 

func NewSfmUseTypeFromValue(v string) (*SfmUseType, error)

NewSfmUseTypeFromValue returns a pointer to a valid SfmUseType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (SfmUseType) IsValid 

func (v SfmUseType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (SfmUseType) Ptr 

func (v SfmUseType) Ptr() *SfmUseType

Ptr returns reference to sfm_use_type value

func (*SfmUseType) UnmarshalJSON 

func (v *SfmUseType) UnmarshalJSON(src []byte) error

type SortBy 

type SortBy struct {
	DateCreated *string `json:"date_created,omitempty"`
	SendDate    *string `json:"send_date,omitempty"`
}

SortBy struct for SortBy

func NewSortBy 

func NewSortBy() *SortBy

NewSortBy instantiates a new SortBy object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSortByWithDefaults 

func NewSortByWithDefaults() *SortBy

NewSortByWithDefaults instantiates a new SortBy object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SortBy) GetDateCreated 

func (o *SortBy) GetDateCreated() string

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*SortBy) GetDateCreatedOk 

func (o *SortBy) GetDateCreatedOk() (*string, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy) GetSendDate 

func (o *SortBy) GetSendDate() string

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*SortBy) GetSendDateOk 

func (o *SortBy) GetSendDateOk() (*string, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy) HasDateCreated 

func (o *SortBy) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*SortBy) HasSendDate 

func (o *SortBy) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (SortBy) MarshalJSON 

func (o SortBy) MarshalJSON() ([]byte, error)

func (*SortBy) SetDateCreated 

func (o *SortBy) SetDateCreated(v string)

SetDateCreated gets a reference to the given string and assigns it to the DateCreated field.

func (*SortBy) SetSendDate 

func (o *SortBy) SetSendDate(v string)

SetSendDate gets a reference to the given string and assigns it to the SendDate field.

type SortBy1 

type SortBy1 struct {
	DateCreated *string `json:"date_created,omitempty"`
	SendDate    *string `json:"send_date,omitempty"`
}

SortBy1 struct for SortBy1

func NewSortBy1 

func NewSortBy1() *SortBy1

NewSortBy1 instantiates a new SortBy1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSortBy1WithDefaults 

func NewSortBy1WithDefaults() *SortBy1

NewSortBy1WithDefaults instantiates a new SortBy1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SortBy1) GetDateCreated 

func (o *SortBy1) GetDateCreated() string

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*SortBy1) GetDateCreatedOk 

func (o *SortBy1) GetDateCreatedOk() (*string, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy1) GetSendDate 

func (o *SortBy1) GetSendDate() string

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*SortBy1) GetSendDateOk 

func (o *SortBy1) GetSendDateOk() (*string, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy1) HasDateCreated 

func (o *SortBy1) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*SortBy1) HasSendDate 

func (o *SortBy1) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (SortBy1) MarshalJSON 

func (o SortBy1) MarshalJSON() ([]byte, error)

func (*SortBy1) SetDateCreated 

func (o *SortBy1) SetDateCreated(v string)

SetDateCreated gets a reference to the given string and assigns it to the DateCreated field.

func (*SortBy1) SetSendDate 

func (o *SortBy1) SetSendDate(v string)

SetSendDate gets a reference to the given string and assigns it to the SendDate field.

type SortBy2 

type SortBy2 struct {
	DateCreated *string `json:"date_created,omitempty"`
	SendDate    *string `json:"send_date,omitempty"`
}

SortBy2 struct for SortBy2

func NewSortBy2 

func NewSortBy2() *SortBy2

NewSortBy2 instantiates a new SortBy2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSortBy2WithDefaults 

func NewSortBy2WithDefaults() *SortBy2

NewSortBy2WithDefaults instantiates a new SortBy2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SortBy2) GetDateCreated 

func (o *SortBy2) GetDateCreated() string

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*SortBy2) GetDateCreatedOk 

func (o *SortBy2) GetDateCreatedOk() (*string, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy2) GetSendDate 

func (o *SortBy2) GetSendDate() string

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*SortBy2) GetSendDateOk 

func (o *SortBy2) GetSendDateOk() (*string, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy2) HasDateCreated 

func (o *SortBy2) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*SortBy2) HasSendDate 

func (o *SortBy2) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (SortBy2) MarshalJSON 

func (o SortBy2) MarshalJSON() ([]byte, error)

func (*SortBy2) SetDateCreated 

func (o *SortBy2) SetDateCreated(v string)

SetDateCreated gets a reference to the given string and assigns it to the DateCreated field.

func (*SortBy2) SetSendDate 

func (o *SortBy2) SetSendDate(v string)

SetSendDate gets a reference to the given string and assigns it to the SendDate field.

type SortBy3 

type SortBy3 struct {
	DateCreated *string `json:"date_created,omitempty"`
	SendDate    *string `json:"send_date,omitempty"`
}

SortBy3 struct for SortBy3

func NewSortBy3 

func NewSortBy3() *SortBy3

NewSortBy3 instantiates a new SortBy3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSortBy3WithDefaults 

func NewSortBy3WithDefaults() *SortBy3

NewSortBy3WithDefaults instantiates a new SortBy3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SortBy3) GetDateCreated 

func (o *SortBy3) GetDateCreated() string

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*SortBy3) GetDateCreatedOk 

func (o *SortBy3) GetDateCreatedOk() (*string, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy3) GetSendDate 

func (o *SortBy3) GetSendDate() string

GetSendDate returns the SendDate field value if set, zero value otherwise.

func (*SortBy3) GetSendDateOk 

func (o *SortBy3) GetSendDateOk() (*string, bool)

GetSendDateOk returns a tuple with the SendDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortBy3) HasDateCreated 

func (o *SortBy3) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*SortBy3) HasSendDate 

func (o *SortBy3) HasSendDate() bool

HasSendDate returns a boolean if a field has been set.

func (SortBy3) MarshalJSON 

func (o SortBy3) MarshalJSON() ([]byte, error)

func (*SortBy3) SetDateCreated 

func (o *SortBy3) SetDateCreated(v string)

SetDateCreated gets a reference to the given string and assigns it to the DateCreated field.

func (*SortBy3) SetSendDate 

func (o *SortBy3) SetSendDate(v string)

SetSendDate gets a reference to the given string and assigns it to the SendDate field.

type SortByDateModified 

type SortByDateModified struct {
	DateCreated  *string `json:"date_created,omitempty"`
	DateModified *string `json:"date_modified,omitempty"`
}

SortByDateModified struct for SortByDateModified

func NewSortByDateModified 

func NewSortByDateModified() *SortByDateModified

NewSortByDateModified instantiates a new SortByDateModified object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSortByDateModifiedWithDefaults 

func NewSortByDateModifiedWithDefaults() *SortByDateModified

NewSortByDateModifiedWithDefaults instantiates a new SortByDateModified object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SortByDateModified) GetDateCreated 

func (o *SortByDateModified) GetDateCreated() string

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*SortByDateModified) GetDateCreatedOk 

func (o *SortByDateModified) GetDateCreatedOk() (*string, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortByDateModified) GetDateModified 

func (o *SortByDateModified) GetDateModified() string

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*SortByDateModified) GetDateModifiedOk 

func (o *SortByDateModified) GetDateModifiedOk() (*string, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SortByDateModified) HasDateCreated 

func (o *SortByDateModified) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*SortByDateModified) HasDateModified 

func (o *SortByDateModified) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (SortByDateModified) MarshalJSON 

func (o SortByDateModified) MarshalJSON() ([]byte, error)

func (*SortByDateModified) SetDateCreated 

func (o *SortByDateModified) SetDateCreated(v string)

SetDateCreated gets a reference to the given string and assigns it to the DateCreated field.

func (*SortByDateModified) SetDateModified 

func (o *SortByDateModified) SetDateModified(v string)

SetDateModified gets a reference to the given string and assigns it to the DateModified field.

type Suggestions 

type Suggestions struct {
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine string `json:"primary_line"`
	City        string `json:"city"`
	// The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.
	State string `json:"state"`
	// A 5-digit zip code. Left empty if a test key is used.
	ZipCode string `json:"zip_code"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

Suggestions struct for Suggestions

func NewSuggestions 

func NewSuggestions(primaryLine string, city string, state string, zipCode string) *Suggestions

NewSuggestions instantiates a new Suggestions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSuggestionsWithDefaults 

func NewSuggestionsWithDefaults() *Suggestions

NewSuggestionsWithDefaults instantiates a new Suggestions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Suggestions) GetCity 

func (o *Suggestions) GetCity() string

GetCity returns the City field value

func (*Suggestions) GetCityOk 

func (o *Suggestions) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value and a boolean to check if the value has been set.

func (*Suggestions) GetObject 

func (o *Suggestions) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*Suggestions) GetObjectOk 

func (o *Suggestions) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Suggestions) GetPrimaryLine 

func (o *Suggestions) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value

func (*Suggestions) GetPrimaryLineOk 

func (o *Suggestions) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value and a boolean to check if the value has been set.

func (*Suggestions) GetState 

func (o *Suggestions) GetState() string

GetState returns the State field value

func (*Suggestions) GetStateOk 

func (o *Suggestions) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value and a boolean to check if the value has been set.

func (*Suggestions) GetZipCode 

func (o *Suggestions) GetZipCode() string

GetZipCode returns the ZipCode field value

func (*Suggestions) GetZipCodeOk 

func (o *Suggestions) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value and a boolean to check if the value has been set.

func (*Suggestions) HasObject 

func (o *Suggestions) HasObject() bool

HasObject returns a boolean if a field has been set.

func (Suggestions) MarshalJSON 

func (o Suggestions) MarshalJSON() ([]byte, error)

func (*Suggestions) SetCity 

func (o *Suggestions) SetCity(v string)

SetCity sets field value

func (*Suggestions) SetObject 

func (o *Suggestions) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*Suggestions) SetPrimaryLine 

func (o *Suggestions) SetPrimaryLine(v string)

SetPrimaryLine sets field value

func (*Suggestions) SetState 

func (o *Suggestions) SetState(v string)

SetState sets field value

func (*Suggestions) SetZipCode 

func (o *Suggestions) SetZipCode(v string)

SetZipCode sets field value

type Template 

type Template struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
	Id string `json:"id"`
	// An array of all non-deleted [version objects](#tag/Template-Versions) associated with the template.
	Versions         []TemplateVersion `json:"versions"`
	PublishedVersion TemplateVersion   `json:"published_version"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified *time.Time `json:"date_modified,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
}

Template struct for Template

func NewTemplate 

func NewTemplate(id string, versions []TemplateVersion, publishedVersion TemplateVersion) *Template

NewTemplate instantiates a new Template object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateWithDefaults 

func NewTemplateWithDefaults() *Template

NewTemplateWithDefaults instantiates a new Template object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Template) GetDateCreated 

func (o *Template) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*Template) GetDateCreatedOk 

func (o *Template) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Template) GetDateModified 

func (o *Template) GetDateModified() time.Time

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*Template) GetDateModifiedOk 

func (o *Template) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Template) GetDeleted 

func (o *Template) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*Template) GetDeletedOk 

func (o *Template) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Template) GetDescription 

func (o *Template) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Template) GetDescriptionOk 

func (o *Template) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Template) GetId 

func (o *Template) GetId() string

GetId returns the Id field value

func (*Template) GetIdOk 

func (o *Template) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Template) GetMetadata 

func (o *Template) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*Template) GetMetadataOk 

func (o *Template) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Template) GetObject 

func (o *Template) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*Template) GetObjectOk 

func (o *Template) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Template) GetPublishedVersion 

func (o *Template) GetPublishedVersion() TemplateVersion

GetPublishedVersion returns the PublishedVersion field value

func (*Template) GetPublishedVersionOk 

func (o *Template) GetPublishedVersionOk() (*TemplateVersion, bool)

GetPublishedVersionOk returns a tuple with the PublishedVersion field value and a boolean to check if the value has been set.

func (*Template) GetVersions 

func (o *Template) GetVersions() []TemplateVersion

GetVersions returns the Versions field value

func (*Template) GetVersionsOk 

func (o *Template) GetVersionsOk() ([]TemplateVersion, bool)

GetVersionsOk returns a tuple with the Versions field value and a boolean to check if the value has been set.

func (*Template) HasDateCreated 

func (o *Template) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*Template) HasDateModified 

func (o *Template) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (*Template) HasDeleted 

func (o *Template) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*Template) HasDescription 

func (o *Template) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Template) HasMetadata 

func (o *Template) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*Template) HasObject 

func (o *Template) HasObject() bool

HasObject returns a boolean if a field has been set.

func (Template) MarshalJSON 

func (o Template) MarshalJSON() ([]byte, error)

func (*Template) SetDateCreated 

func (o *Template) SetDateCreated(v time.Time)

SetDateCreated gets a reference to the given time.Time and assigns it to the DateCreated field.

func (*Template) SetDateModified 

func (o *Template) SetDateModified(v time.Time)

SetDateModified gets a reference to the given time.Time and assigns it to the DateModified field.

func (*Template) SetDeleted 

func (o *Template) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*Template) SetDescription 

func (o *Template) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*Template) SetDescriptionNil 

func (o *Template) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*Template) SetId 

func (o *Template) SetId(v string)

SetId sets field value

func (*Template) SetMetadata 

func (o *Template) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*Template) SetObject 

func (o *Template) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*Template) SetPublishedVersion 

func (o *Template) SetPublishedVersion(v TemplateVersion)

SetPublishedVersion sets field value

func (*Template) SetVersions 

func (o *Template) SetVersions(v []TemplateVersion)

SetVersions sets field value

func (*Template) UnsetDescription 

func (o *Template) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type TemplateDeletion 

type TemplateDeletion struct {
	// Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

TemplateDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewTemplateDeletion 

func NewTemplateDeletion() *TemplateDeletion

NewTemplateDeletion instantiates a new TemplateDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateDeletionWithDefaults 

func NewTemplateDeletionWithDefaults() *TemplateDeletion

NewTemplateDeletionWithDefaults instantiates a new TemplateDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateDeletion) GetDeleted 

func (o *TemplateDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*TemplateDeletion) GetDeletedOk 

func (o *TemplateDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateDeletion) GetId 

func (o *TemplateDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*TemplateDeletion) GetIdOk 

func (o *TemplateDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateDeletion) GetObject 

func (o *TemplateDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*TemplateDeletion) GetObjectOk 

func (o *TemplateDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateDeletion) HasDeleted 

func (o *TemplateDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*TemplateDeletion) HasId 

func (o *TemplateDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*TemplateDeletion) HasObject 

func (o *TemplateDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (TemplateDeletion) MarshalJSON 

func (o TemplateDeletion) MarshalJSON() ([]byte, error)

func (*TemplateDeletion) SetDeleted 

func (o *TemplateDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*TemplateDeletion) SetId 

func (o *TemplateDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*TemplateDeletion) SetObject 

func (o *TemplateDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type TemplateList 

type TemplateList struct {
	// list of templates
	Data []Template `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

TemplateList struct for TemplateList

func NewTemplateList 

func NewTemplateList() *TemplateList

NewTemplateList instantiates a new TemplateList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateListWithDefaults 

func NewTemplateListWithDefaults() *TemplateList

NewTemplateListWithDefaults instantiates a new TemplateList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateList) GetCount 

func (o *TemplateList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*TemplateList) GetCountOk 

func (o *TemplateList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateList) GetData 

func (o *TemplateList) GetData() []Template

GetData returns the Data field value if set, zero value otherwise.

func (*TemplateList) GetDataOk 

func (o *TemplateList) GetDataOk() ([]Template, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateList) GetNextPageToken 

func (o *TemplateList) GetNextPageToken() string

func (*TemplateList) GetNextUrl 

func (o *TemplateList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateList) GetNextUrlOk 

func (o *TemplateList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateList) GetObject 

func (o *TemplateList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*TemplateList) GetObjectOk 

func (o *TemplateList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateList) GetPrevPageToken 

func (o *TemplateList) GetPrevPageToken() string

func (*TemplateList) GetPreviousUrl 

func (o *TemplateList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateList) GetPreviousUrlOk 

func (o *TemplateList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateList) GetTotalCount 

func (o *TemplateList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*TemplateList) GetTotalCountOk 

func (o *TemplateList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateList) HasCount 

func (o *TemplateList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*TemplateList) HasData 

func (o *TemplateList) HasData() bool

HasData returns a boolean if a field has been set.

func (*TemplateList) HasNextUrl 

func (o *TemplateList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*TemplateList) HasObject 

func (o *TemplateList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*TemplateList) HasPreviousUrl 

func (o *TemplateList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*TemplateList) HasTotalCount 

func (o *TemplateList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (TemplateList) MarshalJSON 

func (o TemplateList) MarshalJSON() ([]byte, error)

func (*TemplateList) SetCount 

func (o *TemplateList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*TemplateList) SetData 

func (o *TemplateList) SetData(v []Template)

SetData gets a reference to the given []Template and assigns it to the Data field.

func (*TemplateList) SetNextUrl 

func (o *TemplateList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*TemplateList) SetNextUrlNil 

func (o *TemplateList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*TemplateList) SetObject 

func (o *TemplateList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*TemplateList) SetPreviousUrl 

func (o *TemplateList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*TemplateList) SetPreviousUrlNil 

func (o *TemplateList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*TemplateList) SetTotalCount 

func (o *TemplateList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*TemplateList) UnsetNextUrl 

func (o *TemplateList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*TemplateList) UnsetPreviousUrl 

func (o *TemplateList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type TemplateUpdate 

type TemplateUpdate struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// Unique identifier prefixed with `vrsn_`.
	PublishedVersion *string `json:"published_version,omitempty"`
}

TemplateUpdate struct for TemplateUpdate

func NewTemplateUpdate 

func NewTemplateUpdate() *TemplateUpdate

NewTemplateUpdate instantiates a new TemplateUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateUpdateWithDefaults 

func NewTemplateUpdateWithDefaults() *TemplateUpdate

NewTemplateUpdateWithDefaults instantiates a new TemplateUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateUpdate) GetDescription 

func (o *TemplateUpdate) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateUpdate) GetDescriptionOk 

func (o *TemplateUpdate) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateUpdate) GetPublishedVersion 

func (o *TemplateUpdate) GetPublishedVersion() string

GetPublishedVersion returns the PublishedVersion field value if set, zero value otherwise.

func (*TemplateUpdate) GetPublishedVersionOk 

func (o *TemplateUpdate) GetPublishedVersionOk() (*string, bool)

GetPublishedVersionOk returns a tuple with the PublishedVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateUpdate) HasDescription 

func (o *TemplateUpdate) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*TemplateUpdate) HasPublishedVersion 

func (o *TemplateUpdate) HasPublishedVersion() bool

HasPublishedVersion returns a boolean if a field has been set.

func (TemplateUpdate) MarshalJSON 

func (o TemplateUpdate) MarshalJSON() ([]byte, error)

func (*TemplateUpdate) SetDescription 

func (o *TemplateUpdate) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*TemplateUpdate) SetDescriptionNil 

func (o *TemplateUpdate) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*TemplateUpdate) SetPublishedVersion 

func (o *TemplateUpdate) SetPublishedVersion(v string)

SetPublishedVersion gets a reference to the given string and assigns it to the PublishedVersion field.

func (*TemplateUpdate) UnsetDescription 

func (o *TemplateUpdate) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

type TemplateVersion 

type TemplateVersion struct {
	// Unique identifier prefixed with `vrsn_`.
	Id string `json:"id"`
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back`  If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`.
	Html   string             `json:"html"`
	Engine NullableEngineHtml `json:"engine,omitempty"`
	// Used by frontend, true if the template uses advanced features.
	SuggestJsonEditor *bool `json:"suggest_json_editor,omitempty"`
	// Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named 'keys', and its value is an array of strings.
	MergeVariables map[string]interface{} `json:"merge_variables,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified *time.Time `json:"date_modified,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

TemplateVersion struct for TemplateVersion

func NewTemplateVersion 

func NewTemplateVersion(id string, html string) *TemplateVersion

NewTemplateVersion instantiates a new TemplateVersion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateVersionWithDefaults 

func NewTemplateVersionWithDefaults() *TemplateVersion

NewTemplateVersionWithDefaults instantiates a new TemplateVersion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateVersion) GetDateCreated 

func (o *TemplateVersion) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*TemplateVersion) GetDateCreatedOk 

func (o *TemplateVersion) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersion) GetDateModified 

func (o *TemplateVersion) GetDateModified() time.Time

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*TemplateVersion) GetDateModifiedOk 

func (o *TemplateVersion) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersion) GetDeleted 

func (o *TemplateVersion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*TemplateVersion) GetDeletedOk 

func (o *TemplateVersion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersion) GetDescription 

func (o *TemplateVersion) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersion) GetDescriptionOk 

func (o *TemplateVersion) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersion) GetEngine 

func (o *TemplateVersion) GetEngine() EngineHtml

GetEngine returns the Engine field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersion) GetEngineOk 

func (o *TemplateVersion) GetEngineOk() (*EngineHtml, bool)

GetEngineOk returns a tuple with the Engine field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersion) GetHtml 

func (o *TemplateVersion) GetHtml() string

GetHtml returns the Html field value

func (*TemplateVersion) GetHtmlOk 

func (o *TemplateVersion) GetHtmlOk() (*string, bool)

GetHtmlOk returns a tuple with the Html field value and a boolean to check if the value has been set.

func (*TemplateVersion) GetId 

func (o *TemplateVersion) GetId() string

GetId returns the Id field value

func (*TemplateVersion) GetIdOk 

func (o *TemplateVersion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*TemplateVersion) GetMergeVariables 

func (o *TemplateVersion) GetMergeVariables() map[string]interface{}

GetMergeVariables returns the MergeVariables field value if set, zero value otherwise.

func (*TemplateVersion) GetMergeVariablesOk 

func (o *TemplateVersion) GetMergeVariablesOk() (map[string]interface{}, bool)

GetMergeVariablesOk returns a tuple with the MergeVariables field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersion) GetObject 

func (o *TemplateVersion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*TemplateVersion) GetObjectOk 

func (o *TemplateVersion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersion) GetSuggestJsonEditor 

func (o *TemplateVersion) GetSuggestJsonEditor() bool

GetSuggestJsonEditor returns the SuggestJsonEditor field value if set, zero value otherwise.

func (*TemplateVersion) GetSuggestJsonEditorOk 

func (o *TemplateVersion) GetSuggestJsonEditorOk() (*bool, bool)

GetSuggestJsonEditorOk returns a tuple with the SuggestJsonEditor field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersion) HasDateCreated 

func (o *TemplateVersion) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*TemplateVersion) HasDateModified 

func (o *TemplateVersion) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (*TemplateVersion) HasDeleted 

func (o *TemplateVersion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*TemplateVersion) HasDescription 

func (o *TemplateVersion) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*TemplateVersion) HasEngine 

func (o *TemplateVersion) HasEngine() bool

HasEngine returns a boolean if a field has been set.

func (*TemplateVersion) HasMergeVariables 

func (o *TemplateVersion) HasMergeVariables() bool

HasMergeVariables returns a boolean if a field has been set.

func (*TemplateVersion) HasObject 

func (o *TemplateVersion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*TemplateVersion) HasSuggestJsonEditor 

func (o *TemplateVersion) HasSuggestJsonEditor() bool

HasSuggestJsonEditor returns a boolean if a field has been set.

func (TemplateVersion) MarshalJSON 

func (o TemplateVersion) MarshalJSON() ([]byte, error)

func (*TemplateVersion) SetDateCreated 

func (o *TemplateVersion) SetDateCreated(v time.Time)

SetDateCreated gets a reference to the given time.Time and assigns it to the DateCreated field.

func (*TemplateVersion) SetDateModified 

func (o *TemplateVersion) SetDateModified(v time.Time)

SetDateModified gets a reference to the given time.Time and assigns it to the DateModified field.

func (*TemplateVersion) SetDeleted 

func (o *TemplateVersion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*TemplateVersion) SetDescription 

func (o *TemplateVersion) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*TemplateVersion) SetDescriptionNil 

func (o *TemplateVersion) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*TemplateVersion) SetEngine 

func (o *TemplateVersion) SetEngine(v EngineHtml)

SetEngine gets a reference to the given NullableEngineHtml and assigns it to the Engine field.

func (*TemplateVersion) SetEngineNil 

func (o *TemplateVersion) SetEngineNil()

SetEngineNil sets the value for Engine to be an explicit nil

func (*TemplateVersion) SetHtml 

func (o *TemplateVersion) SetHtml(v string)

SetHtml sets field value

func (*TemplateVersion) SetId 

func (o *TemplateVersion) SetId(v string)

SetId sets field value

func (*TemplateVersion) SetMergeVariables 

func (o *TemplateVersion) SetMergeVariables(v map[string]interface{})

SetMergeVariables gets a reference to the given map[string]interface{} and assigns it to the MergeVariables field.

func (*TemplateVersion) SetObject 

func (o *TemplateVersion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*TemplateVersion) SetSuggestJsonEditor 

func (o *TemplateVersion) SetSuggestJsonEditor(v bool)

SetSuggestJsonEditor gets a reference to the given bool and assigns it to the SuggestJsonEditor field.

func (*TemplateVersion) UnsetDescription 

func (o *TemplateVersion) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*TemplateVersion) UnsetEngine 

func (o *TemplateVersion) UnsetEngine()

UnsetEngine ensures that no value is present for Engine, not even an explicit nil

type TemplateVersionDeletion 

type TemplateVersionDeletion struct {
	// Unique identifier prefixed with `vrsn_`.
	Id *string `json:"id,omitempty"`
	// Only returned if the resource has been successfully deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
}

TemplateVersionDeletion Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.

func NewTemplateVersionDeletion 

func NewTemplateVersionDeletion() *TemplateVersionDeletion

NewTemplateVersionDeletion instantiates a new TemplateVersionDeletion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateVersionDeletionWithDefaults 

func NewTemplateVersionDeletionWithDefaults() *TemplateVersionDeletion

NewTemplateVersionDeletionWithDefaults instantiates a new TemplateVersionDeletion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateVersionDeletion) GetDeleted 

func (o *TemplateVersionDeletion) GetDeleted() bool

GetDeleted returns the Deleted field value if set, zero value otherwise.

func (*TemplateVersionDeletion) GetDeletedOk 

func (o *TemplateVersionDeletion) GetDeletedOk() (*bool, bool)

GetDeletedOk returns a tuple with the Deleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersionDeletion) GetId 

func (o *TemplateVersionDeletion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*TemplateVersionDeletion) GetIdOk 

func (o *TemplateVersionDeletion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersionDeletion) GetObject 

func (o *TemplateVersionDeletion) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*TemplateVersionDeletion) GetObjectOk 

func (o *TemplateVersionDeletion) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersionDeletion) HasDeleted 

func (o *TemplateVersionDeletion) HasDeleted() bool

HasDeleted returns a boolean if a field has been set.

func (*TemplateVersionDeletion) HasId 

func (o *TemplateVersionDeletion) HasId() bool

HasId returns a boolean if a field has been set.

func (*TemplateVersionDeletion) HasObject 

func (o *TemplateVersionDeletion) HasObject() bool

HasObject returns a boolean if a field has been set.

func (TemplateVersionDeletion) MarshalJSON 

func (o TemplateVersionDeletion) MarshalJSON() ([]byte, error)

func (*TemplateVersionDeletion) SetDeleted 

func (o *TemplateVersionDeletion) SetDeleted(v bool)

SetDeleted gets a reference to the given bool and assigns it to the Deleted field.

func (*TemplateVersionDeletion) SetId 

func (o *TemplateVersionDeletion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*TemplateVersionDeletion) SetObject 

func (o *TemplateVersionDeletion) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

type TemplateVersionList 

type TemplateVersionList struct {
	// list of template versions
	Data []TemplateVersion `json:"data,omitempty"`
	// Value is type of resource.
	Object *string `json:"object,omitempty"`
	// url of next page of items in list.
	NextUrl NullableString `json:"next_url,omitempty"`
	// url of previous page of items in list.
	PreviousUrl NullableString `json:"previous_url,omitempty"`
	// number of resources in a set
	Count *int32 `json:"count,omitempty"`
	// indicates the total number of records. Provided when the request specifies an \"include\" query parameter
	TotalCount *int32 `json:"total_count,omitempty"`
}

TemplateVersionList struct for TemplateVersionList

func NewTemplateVersionList 

func NewTemplateVersionList() *TemplateVersionList

NewTemplateVersionList instantiates a new TemplateVersionList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateVersionListWithDefaults 

func NewTemplateVersionListWithDefaults() *TemplateVersionList

NewTemplateVersionListWithDefaults instantiates a new TemplateVersionList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateVersionList) GetCount 

func (o *TemplateVersionList) GetCount() int32

GetCount returns the Count field value if set, zero value otherwise.

func (*TemplateVersionList) GetCountOk 

func (o *TemplateVersionList) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersionList) GetData 

func (o *TemplateVersionList) GetData() []TemplateVersion

GetData returns the Data field value if set, zero value otherwise.

func (*TemplateVersionList) GetDataOk 

func (o *TemplateVersionList) GetDataOk() ([]TemplateVersion, bool)

GetDataOk returns a tuple with the Data field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersionList) GetNextPageToken 

func (o *TemplateVersionList) GetNextPageToken() string

func (*TemplateVersionList) GetNextUrl 

func (o *TemplateVersionList) GetNextUrl() string

GetNextUrl returns the NextUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersionList) GetNextUrlOk 

func (o *TemplateVersionList) GetNextUrlOk() (*string, bool)

GetNextUrlOk returns a tuple with the NextUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersionList) GetObject 

func (o *TemplateVersionList) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*TemplateVersionList) GetObjectOk 

func (o *TemplateVersionList) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersionList) GetPrevPageToken 

func (o *TemplateVersionList) GetPrevPageToken() string

func (*TemplateVersionList) GetPreviousUrl 

func (o *TemplateVersionList) GetPreviousUrl() string

GetPreviousUrl returns the PreviousUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersionList) GetPreviousUrlOk 

func (o *TemplateVersionList) GetPreviousUrlOk() (*string, bool)

GetPreviousUrlOk returns a tuple with the PreviousUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersionList) GetTotalCount 

func (o *TemplateVersionList) GetTotalCount() int32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*TemplateVersionList) GetTotalCountOk 

func (o *TemplateVersionList) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateVersionList) HasCount 

func (o *TemplateVersionList) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*TemplateVersionList) HasData 

func (o *TemplateVersionList) HasData() bool

HasData returns a boolean if a field has been set.

func (*TemplateVersionList) HasNextUrl 

func (o *TemplateVersionList) HasNextUrl() bool

HasNextUrl returns a boolean if a field has been set.

func (*TemplateVersionList) HasObject 

func (o *TemplateVersionList) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*TemplateVersionList) HasPreviousUrl 

func (o *TemplateVersionList) HasPreviousUrl() bool

HasPreviousUrl returns a boolean if a field has been set.

func (*TemplateVersionList) HasTotalCount 

func (o *TemplateVersionList) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (TemplateVersionList) MarshalJSON 

func (o TemplateVersionList) MarshalJSON() ([]byte, error)

func (*TemplateVersionList) SetCount 

func (o *TemplateVersionList) SetCount(v int32)

SetCount gets a reference to the given int32 and assigns it to the Count field.

func (*TemplateVersionList) SetData 

func (o *TemplateVersionList) SetData(v []TemplateVersion)

SetData gets a reference to the given []TemplateVersion and assigns it to the Data field.

func (*TemplateVersionList) SetNextUrl 

func (o *TemplateVersionList) SetNextUrl(v string)

SetNextUrl gets a reference to the given NullableString and assigns it to the NextUrl field.

func (*TemplateVersionList) SetNextUrlNil 

func (o *TemplateVersionList) SetNextUrlNil()

SetNextUrlNil sets the value for NextUrl to be an explicit nil

func (*TemplateVersionList) SetObject 

func (o *TemplateVersionList) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*TemplateVersionList) SetPreviousUrl 

func (o *TemplateVersionList) SetPreviousUrl(v string)

SetPreviousUrl gets a reference to the given NullableString and assigns it to the PreviousUrl field.

func (*TemplateVersionList) SetPreviousUrlNil 

func (o *TemplateVersionList) SetPreviousUrlNil()

SetPreviousUrlNil sets the value for PreviousUrl to be an explicit nil

func (*TemplateVersionList) SetTotalCount 

func (o *TemplateVersionList) SetTotalCount(v int32)

SetTotalCount gets a reference to the given int32 and assigns it to the TotalCount field.

func (*TemplateVersionList) UnsetNextUrl 

func (o *TemplateVersionList) UnsetNextUrl()

UnsetNextUrl ensures that no value is present for NextUrl, not even an explicit nil

func (*TemplateVersionList) UnsetPreviousUrl 

func (o *TemplateVersionList) UnsetPreviousUrl()

UnsetPreviousUrl ensures that no value is present for PreviousUrl, not even an explicit nil

type TemplateVersionUpdatable 

type TemplateVersionUpdatable struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString     `json:"description,omitempty"`
	Engine      NullableEngineHtml `json:"engine,omitempty"`
}

TemplateVersionUpdatable struct for TemplateVersionUpdatable

func NewTemplateVersionUpdatable 

func NewTemplateVersionUpdatable() *TemplateVersionUpdatable

NewTemplateVersionUpdatable instantiates a new TemplateVersionUpdatable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateVersionUpdatableWithDefaults 

func NewTemplateVersionUpdatableWithDefaults() *TemplateVersionUpdatable

NewTemplateVersionUpdatableWithDefaults instantiates a new TemplateVersionUpdatable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateVersionUpdatable) GetDescription 

func (o *TemplateVersionUpdatable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersionUpdatable) GetDescriptionOk 

func (o *TemplateVersionUpdatable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersionUpdatable) GetEngine 

func (o *TemplateVersionUpdatable) GetEngine() EngineHtml

GetEngine returns the Engine field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersionUpdatable) GetEngineOk 

func (o *TemplateVersionUpdatable) GetEngineOk() (*EngineHtml, bool)

GetEngineOk returns a tuple with the Engine field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersionUpdatable) HasDescription 

func (o *TemplateVersionUpdatable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*TemplateVersionUpdatable) HasEngine 

func (o *TemplateVersionUpdatable) HasEngine() bool

HasEngine returns a boolean if a field has been set.

func (TemplateVersionUpdatable) MarshalJSON 

func (o TemplateVersionUpdatable) MarshalJSON() ([]byte, error)

func (*TemplateVersionUpdatable) SetDescription 

func (o *TemplateVersionUpdatable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*TemplateVersionUpdatable) SetDescriptionNil 

func (o *TemplateVersionUpdatable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*TemplateVersionUpdatable) SetEngine 

func (o *TemplateVersionUpdatable) SetEngine(v EngineHtml)

SetEngine gets a reference to the given NullableEngineHtml and assigns it to the Engine field.

func (*TemplateVersionUpdatable) SetEngineNil 

func (o *TemplateVersionUpdatable) SetEngineNil()

SetEngineNil sets the value for Engine to be an explicit nil

func (*TemplateVersionUpdatable) UnsetDescription 

func (o *TemplateVersionUpdatable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*TemplateVersionUpdatable) UnsetEngine 

func (o *TemplateVersionUpdatable) UnsetEngine()

UnsetEngine ensures that no value is present for Engine, not even an explicit nil

type TemplateVersionWritable 

type TemplateVersionWritable struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back`  If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`.
	Html   string             `json:"html"`
	Engine NullableEngineHtml `json:"engine,omitempty"`
}

TemplateVersionWritable struct for TemplateVersionWritable

func NewTemplateVersionWritable 

func NewTemplateVersionWritable(html string) *TemplateVersionWritable

NewTemplateVersionWritable instantiates a new TemplateVersionWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateVersionWritableWithDefaults 

func NewTemplateVersionWritableWithDefaults() *TemplateVersionWritable

NewTemplateVersionWritableWithDefaults instantiates a new TemplateVersionWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateVersionWritable) GetDescription 

func (o *TemplateVersionWritable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersionWritable) GetDescriptionOk 

func (o *TemplateVersionWritable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersionWritable) GetEngine 

func (o *TemplateVersionWritable) GetEngine() EngineHtml

GetEngine returns the Engine field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateVersionWritable) GetEngineOk 

func (o *TemplateVersionWritable) GetEngineOk() (*EngineHtml, bool)

GetEngineOk returns a tuple with the Engine field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateVersionWritable) GetHtml 

func (o *TemplateVersionWritable) GetHtml() string

GetHtml returns the Html field value

func (*TemplateVersionWritable) GetHtmlOk 

func (o *TemplateVersionWritable) GetHtmlOk() (*string, bool)

GetHtmlOk returns a tuple with the Html field value and a boolean to check if the value has been set.

func (*TemplateVersionWritable) HasDescription 

func (o *TemplateVersionWritable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*TemplateVersionWritable) HasEngine 

func (o *TemplateVersionWritable) HasEngine() bool

HasEngine returns a boolean if a field has been set.

func (TemplateVersionWritable) MarshalJSON 

func (o TemplateVersionWritable) MarshalJSON() ([]byte, error)

func (*TemplateVersionWritable) SetDescription 

func (o *TemplateVersionWritable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*TemplateVersionWritable) SetDescriptionNil 

func (o *TemplateVersionWritable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*TemplateVersionWritable) SetEngine 

func (o *TemplateVersionWritable) SetEngine(v EngineHtml)

SetEngine gets a reference to the given NullableEngineHtml and assigns it to the Engine field.

func (*TemplateVersionWritable) SetEngineNil 

func (o *TemplateVersionWritable) SetEngineNil()

SetEngineNil sets the value for Engine to be an explicit nil

func (*TemplateVersionWritable) SetHtml 

func (o *TemplateVersionWritable) SetHtml(v string)

SetHtml sets field value

func (*TemplateVersionWritable) UnsetDescription 

func (o *TemplateVersionWritable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*TemplateVersionWritable) UnsetEngine 

func (o *TemplateVersionWritable) UnsetEngine()

UnsetEngine ensures that no value is present for Engine, not even an explicit nil

type TemplateVersionsApiService 

type TemplateVersionsApiService service

TemplateVersionsApiService TemplateVersionsApi service

func (*TemplateVersionsApiService) Create 

func (a *TemplateVersionsApiService) Create(ctx context.Context, tmplId string) ApiCreateTemplateVersionRequest

CreateTemplateVersion create

Creates a new template version attached to the specified template. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId The ID of the template the new version will be attached to
@return ApiCreateTemplateVersionRequest

func (*TemplateVersionsApiService) CreateTemplateVersionExecute 

func (a *TemplateVersionsApiService) CreateTemplateVersionExecute(r ApiCreateTemplateVersionRequest) (*TemplateVersion, *http.Response, error)

Execute executes the request 

@return TemplateVersion

func (*TemplateVersionsApiService) Delete 

func (a *TemplateVersionsApiService) Delete(ctx context.Context, tmplId string, vrsnId string) ApiTemplateVersionDeleteRequest

TemplateVersionDelete delete

Permanently deletes a template version. A template's `published_version` can not be deleted. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId The ID of the template to which the version belongs.
@param vrsnId id of the template_version
@return ApiTemplateVersionDeleteRequest

func (*TemplateVersionsApiService) Get 

func (a *TemplateVersionsApiService) Get(ctx context.Context, tmplId string, vrsnId string) ApiTemplateVersionRetrieveRequest

TemplateVersionRetrieve get

Retrieves the template version with the given template and version ids. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId The ID of the template to which the version belongs.
@param vrsnId id of the template_version
@return ApiTemplateVersionRetrieveRequest

func (*TemplateVersionsApiService) List 

func (a *TemplateVersionsApiService) List(ctx context.Context, tmplId string) ApiTemplateVersionsListRequest

TemplateVersionsList list

Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId The ID of the template associated with the retrieved versions
@return ApiTemplateVersionsListRequest

func (*TemplateVersionsApiService) TemplateVersionDeleteExecute 

func (a *TemplateVersionsApiService) TemplateVersionDeleteExecute(r ApiTemplateVersionDeleteRequest) (*TemplateVersionDeletion, *http.Response, error)

Execute executes the request 

@return TemplateVersionDeletion

func (*TemplateVersionsApiService) TemplateVersionRetrieveExecute 

func (a *TemplateVersionsApiService) TemplateVersionRetrieveExecute(r ApiTemplateVersionRetrieveRequest) (*TemplateVersion, *http.Response, error)

Execute executes the request 

@return TemplateVersion

func (*TemplateVersionsApiService) TemplateVersionUpdateExecute 

func (a *TemplateVersionsApiService) TemplateVersionUpdateExecute(r ApiTemplateVersionUpdateRequest) (*TemplateVersion, *http.Response, error)

Execute executes the request 

@return TemplateVersion

func (*TemplateVersionsApiService) TemplateVersionsListExecute 

func (a *TemplateVersionsApiService) TemplateVersionsListExecute(r ApiTemplateVersionsListRequest) (*TemplateVersionList, *http.Response, error)

Execute executes the request 

@return TemplateVersionList

func (*TemplateVersionsApiService) Update 

func (a *TemplateVersionsApiService) Update(ctx context.Context, tmplId string, vrsnId string) ApiTemplateVersionUpdateRequest

TemplateVersionUpdate update

Updates the template version with the given template and version ids. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId The ID of the template to which the version belongs.
@param vrsnId id of the template_version
@return ApiTemplateVersionUpdateRequest

type TemplateWritable 

type TemplateWritable struct {
	// An internal description that identifies this resource. Must be no longer than 255 characters.
	Description NullableString `json:"description,omitempty"`
	// An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back`  If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`.
	Html string `json:"html"`
	// Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	Engine   NullableEngineHtml `json:"engine,omitempty"`
}

TemplateWritable struct for TemplateWritable

func NewTemplateWritable 

func NewTemplateWritable(html string) *TemplateWritable

NewTemplateWritable instantiates a new TemplateWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTemplateWritableWithDefaults 

func NewTemplateWritableWithDefaults() *TemplateWritable

NewTemplateWritableWithDefaults instantiates a new TemplateWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TemplateWritable) GetDescription 

func (o *TemplateWritable) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateWritable) GetDescriptionOk 

func (o *TemplateWritable) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateWritable) GetEngine 

func (o *TemplateWritable) GetEngine() EngineHtml

GetEngine returns the Engine field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateWritable) GetEngineOk 

func (o *TemplateWritable) GetEngineOk() (*EngineHtml, bool)

GetEngineOk returns a tuple with the Engine field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateWritable) GetHtml 

func (o *TemplateWritable) GetHtml() string

GetHtml returns the Html field value

func (*TemplateWritable) GetHtmlOk 

func (o *TemplateWritable) GetHtmlOk() (*string, bool)

GetHtmlOk returns a tuple with the Html field value and a boolean to check if the value has been set.

func (*TemplateWritable) GetMetadata 

func (o *TemplateWritable) GetMetadata() map[string]string

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*TemplateWritable) GetMetadataOk 

func (o *TemplateWritable) GetMetadataOk() (*map[string]string, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TemplateWritable) HasDescription 

func (o *TemplateWritable) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*TemplateWritable) HasEngine 

func (o *TemplateWritable) HasEngine() bool

HasEngine returns a boolean if a field has been set.

func (*TemplateWritable) HasMetadata 

func (o *TemplateWritable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (TemplateWritable) MarshalJSON 

func (o TemplateWritable) MarshalJSON() ([]byte, error)

func (*TemplateWritable) SetDescription 

func (o *TemplateWritable) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*TemplateWritable) SetDescriptionNil 

func (o *TemplateWritable) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*TemplateWritable) SetEngine 

func (o *TemplateWritable) SetEngine(v EngineHtml)

SetEngine gets a reference to the given NullableEngineHtml and assigns it to the Engine field.

func (*TemplateWritable) SetEngineNil 

func (o *TemplateWritable) SetEngineNil()

SetEngineNil sets the value for Engine to be an explicit nil

func (*TemplateWritable) SetHtml 

func (o *TemplateWritable) SetHtml(v string)

SetHtml sets field value

func (*TemplateWritable) SetMetadata 

func (o *TemplateWritable) SetMetadata(v map[string]string)

SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field.

func (*TemplateWritable) UnsetDescription 

func (o *TemplateWritable) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*TemplateWritable) UnsetEngine 

func (o *TemplateWritable) UnsetEngine()

UnsetEngine ensures that no value is present for Engine, not even an explicit nil

type TemplatesApiService 

type TemplatesApiService service

TemplatesApiService TemplatesApi service

func (*TemplatesApiService) Create 

func (a *TemplatesApiService) Create(ctx context.Context) ApiCreateTemplateRequest

CreateTemplate create

Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateTemplateRequest

func (*TemplatesApiService) CreateTemplateExecute 

func (a *TemplatesApiService) CreateTemplateExecute(r ApiCreateTemplateRequest) (*Template, *http.Response, error)

Execute executes the request 

@return Template

func (*TemplatesApiService) Delete 

func (a *TemplatesApiService) Delete(ctx context.Context, tmplId string) ApiTemplateDeleteRequest

TemplateDelete delete

Permanently deletes a template. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId id of the template
@return ApiTemplateDeleteRequest

func (*TemplatesApiService) Get 

func (a *TemplatesApiService) Get(ctx context.Context, tmplId string) ApiTemplateRetrieveRequest

TemplateRetrieve get

Retrieves the details of an existing template. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId id of the template
@return ApiTemplateRetrieveRequest

func (*TemplatesApiService) List 

func (a *TemplatesApiService) List(ctx context.Context) ApiTemplatesListRequest

TemplatesList list

Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiTemplatesListRequest

func (*TemplatesApiService) TemplateDeleteExecute 

func (a *TemplatesApiService) TemplateDeleteExecute(r ApiTemplateDeleteRequest) (*TemplateDeletion, *http.Response, error)

Execute executes the request 

@return TemplateDeletion

func (*TemplatesApiService) TemplateRetrieveExecute 

func (a *TemplatesApiService) TemplateRetrieveExecute(r ApiTemplateRetrieveRequest) (*Template, *http.Response, error)

Execute executes the request 

@return Template

func (*TemplatesApiService) TemplateUpdateExecute 

func (a *TemplatesApiService) TemplateUpdateExecute(r ApiTemplateUpdateRequest) (*Template, *http.Response, error)

Execute executes the request 

@return Template

func (*TemplatesApiService) TemplatesListExecute 

func (a *TemplatesApiService) TemplatesListExecute(r ApiTemplatesListRequest) (*TemplateList, *http.Response, error)

Execute executes the request 

@return TemplateList

func (*TemplatesApiService) Update 

func (a *TemplatesApiService) Update(ctx context.Context, tmplId string) ApiTemplateUpdateRequest

TemplateUpdate update

Updates the description and/or published version of the template with the given id. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tmplId id of the template
@return ApiTemplateUpdateRequest

type Thumbnail 

type Thumbnail struct {
	// A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
	Small *string `json:"small,omitempty"`
	// A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
	Medium *string `json:"medium,omitempty"`
	// A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
	Large *string `json:"large,omitempty"`
}

Thumbnail struct for Thumbnail

func NewThumbnail 

func NewThumbnail() *Thumbnail

NewThumbnail instantiates a new Thumbnail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewThumbnailWithDefaults 

func NewThumbnailWithDefaults() *Thumbnail

NewThumbnailWithDefaults instantiates a new Thumbnail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Thumbnail) GetLarge 

func (o *Thumbnail) GetLarge() string

GetLarge returns the Large field value if set, zero value otherwise.

func (*Thumbnail) GetLargeOk 

func (o *Thumbnail) GetLargeOk() (*string, bool)

GetLargeOk returns a tuple with the Large field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Thumbnail) GetMedium 

func (o *Thumbnail) GetMedium() string

GetMedium returns the Medium field value if set, zero value otherwise.

func (*Thumbnail) GetMediumOk 

func (o *Thumbnail) GetMediumOk() (*string, bool)

GetMediumOk returns a tuple with the Medium field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Thumbnail) GetSmall 

func (o *Thumbnail) GetSmall() string

GetSmall returns the Small field value if set, zero value otherwise.

func (*Thumbnail) GetSmallOk 

func (o *Thumbnail) GetSmallOk() (*string, bool)

GetSmallOk returns a tuple with the Small field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Thumbnail) HasLarge 

func (o *Thumbnail) HasLarge() bool

HasLarge returns a boolean if a field has been set.

func (*Thumbnail) HasMedium 

func (o *Thumbnail) HasMedium() bool

HasMedium returns a boolean if a field has been set.

func (*Thumbnail) HasSmall 

func (o *Thumbnail) HasSmall() bool

HasSmall returns a boolean if a field has been set.

func (Thumbnail) MarshalJSON 

func (o Thumbnail) MarshalJSON() ([]byte, error)

func (*Thumbnail) SetLarge 

func (o *Thumbnail) SetLarge(v string)

SetLarge gets a reference to the given string and assigns it to the Large field.

func (*Thumbnail) SetMedium 

func (o *Thumbnail) SetMedium(v string)

SetMedium gets a reference to the given string and assigns it to the Medium field.

func (*Thumbnail) SetSmall 

func (o *Thumbnail) SetSmall(v string)

SetSmall gets a reference to the given string and assigns it to the Small field.

type TrackingEventCertified 

type TrackingEventCertified struct {
	// a Certified letter tracking event
	Type string `json:"type"`
	// Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings.    * `Mailed` - Package has been accepted into the carrier network for delivery.    * `In Transit` - Maps to four distinct stages of transit.    * `In Local Area` - Package is at a location near the end destination.    * `Processed for Delivery` - Maps to two distinct stages of delivery.    * `Pickup Available` - Package is available for pickup at carrier location.    * `Delivered` - Package has been delivered.    * `Re-Routed` - Package has been forwarded.    * `Returned to Sender` - Package is to be returned to sender.    * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable.
	Name    string                `json:"name"`
	Details *TrackingEventDetails `json:"details,omitempty"`
	// The zip code in which the event occurred if it exists, otherwise will be the name of a Regional Distribution Center if it exists, otherwise will be null.
	Location NullableString `json:"location,omitempty"`
	// Unique identifier prefixed with `evnt_`.
	Id string `json:"id"`
	// A timestamp in ISO 8601 format of the date USPS registered the event.
	Time *time.Time `json:"time,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated time.Time `json:"date_created"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified time.Time `json:"date_modified"`
	Object       string    `json:"object"`
}

TrackingEventCertified struct for TrackingEventCertified

func NewTrackingEventCertified 

func NewTrackingEventCertified(type_ string, name string, id string, dateCreated time.Time, dateModified time.Time, object string) *TrackingEventCertified

NewTrackingEventCertified instantiates a new TrackingEventCertified object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTrackingEventCertifiedWithDefaults 

func NewTrackingEventCertifiedWithDefaults() *TrackingEventCertified

NewTrackingEventCertifiedWithDefaults instantiates a new TrackingEventCertified object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TrackingEventCertified) GetDateCreated 

func (o *TrackingEventCertified) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*TrackingEventCertified) GetDateCreatedOk 

func (o *TrackingEventCertified) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*TrackingEventCertified) GetDateModified 

func (o *TrackingEventCertified) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*TrackingEventCertified) GetDateModifiedOk 

func (o *TrackingEventCertified) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*TrackingEventCertified) GetDetails 

func (o *TrackingEventCertified) GetDetails() TrackingEventDetails

GetDetails returns the Details field value if set, zero value otherwise.

func (*TrackingEventCertified) GetDetailsOk 

func (o *TrackingEventCertified) GetDetailsOk() (*TrackingEventDetails, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventCertified) GetId 

func (o *TrackingEventCertified) GetId() string

GetId returns the Id field value

func (*TrackingEventCertified) GetIdOk 

func (o *TrackingEventCertified) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*TrackingEventCertified) GetLocation 

func (o *TrackingEventCertified) GetLocation() string

GetLocation returns the Location field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TrackingEventCertified) GetLocationOk 

func (o *TrackingEventCertified) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TrackingEventCertified) GetName 

func (o *TrackingEventCertified) GetName() string

GetName returns the Name field value

func (*TrackingEventCertified) GetNameOk 

func (o *TrackingEventCertified) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*TrackingEventCertified) GetObject 

func (o *TrackingEventCertified) GetObject() string

GetObject returns the Object field value

func (*TrackingEventCertified) GetObjectOk 

func (o *TrackingEventCertified) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*TrackingEventCertified) GetTime 

func (o *TrackingEventCertified) GetTime() time.Time

GetTime returns the Time field value if set, zero value otherwise.

func (*TrackingEventCertified) GetTimeOk 

func (o *TrackingEventCertified) GetTimeOk() (*time.Time, bool)

GetTimeOk returns a tuple with the Time field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventCertified) GetType 

func (o *TrackingEventCertified) GetType() string

GetType returns the Type field value

func (*TrackingEventCertified) GetTypeOk 

func (o *TrackingEventCertified) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*TrackingEventCertified) HasDetails 

func (o *TrackingEventCertified) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*TrackingEventCertified) HasLocation 

func (o *TrackingEventCertified) HasLocation() bool

HasLocation returns a boolean if a field has been set.

func (*TrackingEventCertified) HasTime 

func (o *TrackingEventCertified) HasTime() bool

HasTime returns a boolean if a field has been set.

func (TrackingEventCertified) MarshalJSON 

func (o TrackingEventCertified) MarshalJSON() ([]byte, error)

func (*TrackingEventCertified) SetDateCreated 

func (o *TrackingEventCertified) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*TrackingEventCertified) SetDateModified 

func (o *TrackingEventCertified) SetDateModified(v time.Time)

SetDateModified sets field value

func (*TrackingEventCertified) SetDetails 

func (o *TrackingEventCertified) SetDetails(v TrackingEventDetails)

SetDetails gets a reference to the given TrackingEventDetails and assigns it to the Details field.

func (*TrackingEventCertified) SetId 

func (o *TrackingEventCertified) SetId(v string)

SetId sets field value

func (*TrackingEventCertified) SetLocation 

func (o *TrackingEventCertified) SetLocation(v string)

SetLocation gets a reference to the given NullableString and assigns it to the Location field.

func (*TrackingEventCertified) SetLocationNil 

func (o *TrackingEventCertified) SetLocationNil()

SetLocationNil sets the value for Location to be an explicit nil

func (*TrackingEventCertified) SetName 

func (o *TrackingEventCertified) SetName(v string)

SetName sets field value

func (*TrackingEventCertified) SetObject 

func (o *TrackingEventCertified) SetObject(v string)

SetObject sets field value

func (*TrackingEventCertified) SetTime 

func (o *TrackingEventCertified) SetTime(v time.Time)

SetTime gets a reference to the given time.Time and assigns it to the Time field.

func (*TrackingEventCertified) SetType 

func (o *TrackingEventCertified) SetType(v string)

SetType sets field value

func (*TrackingEventCertified) UnsetLocation 

func (o *TrackingEventCertified) UnsetLocation()

UnsetLocation ensures that no value is present for Location, not even an explicit nil

type TrackingEventDetails 

type TrackingEventDetails struct {
	// Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status.
	Event string `json:"event"`
	// The description as listed in the description for event.
	Description string `json:"description"`
	// Event-specific notes from USPS about the tracking event.
	Notes *string `json:"notes,omitempty"`
	// `true` if action is required by the end recipient, `false` otherwise.
	ActionRequired bool `json:"action_required"`
}

TrackingEventDetails struct for TrackingEventDetails

func NewTrackingEventDetails 

func NewTrackingEventDetails(event string, description string, actionRequired bool) *TrackingEventDetails

NewTrackingEventDetails instantiates a new TrackingEventDetails object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTrackingEventDetailsWithDefaults 

func NewTrackingEventDetailsWithDefaults() *TrackingEventDetails

NewTrackingEventDetailsWithDefaults instantiates a new TrackingEventDetails object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TrackingEventDetails) GetActionRequired 

func (o *TrackingEventDetails) GetActionRequired() bool

GetActionRequired returns the ActionRequired field value

func (*TrackingEventDetails) GetActionRequiredOk 

func (o *TrackingEventDetails) GetActionRequiredOk() (*bool, bool)

GetActionRequiredOk returns a tuple with the ActionRequired field value and a boolean to check if the value has been set.

func (*TrackingEventDetails) GetDescription 

func (o *TrackingEventDetails) GetDescription() string

GetDescription returns the Description field value

func (*TrackingEventDetails) GetDescriptionOk 

func (o *TrackingEventDetails) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value and a boolean to check if the value has been set.

func (*TrackingEventDetails) GetEvent 

func (o *TrackingEventDetails) GetEvent() string

GetEvent returns the Event field value

func (*TrackingEventDetails) GetEventOk 

func (o *TrackingEventDetails) GetEventOk() (*string, bool)

GetEventOk returns a tuple with the Event field value and a boolean to check if the value has been set.

func (*TrackingEventDetails) GetNotes 

func (o *TrackingEventDetails) GetNotes() string

GetNotes returns the Notes field value if set, zero value otherwise.

func (*TrackingEventDetails) GetNotesOk 

func (o *TrackingEventDetails) GetNotesOk() (*string, bool)

GetNotesOk returns a tuple with the Notes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventDetails) HasNotes 

func (o *TrackingEventDetails) HasNotes() bool

HasNotes returns a boolean if a field has been set.

func (TrackingEventDetails) MarshalJSON 

func (o TrackingEventDetails) MarshalJSON() ([]byte, error)

func (*TrackingEventDetails) SetActionRequired 

func (o *TrackingEventDetails) SetActionRequired(v bool)

SetActionRequired sets field value

func (*TrackingEventDetails) SetDescription 

func (o *TrackingEventDetails) SetDescription(v string)

SetDescription sets field value

func (*TrackingEventDetails) SetEvent 

func (o *TrackingEventDetails) SetEvent(v string)

SetEvent sets field value

func (*TrackingEventDetails) SetNotes 

func (o *TrackingEventDetails) SetNotes(v string)

SetNotes gets a reference to the given string and assigns it to the Notes field.

type TrackingEventNormal 

type TrackingEventNormal struct {
	// non-Certified postcards, self mailers, letters, and checks
	Type string `json:"type"`
	// Name of tracking event (for normal postcards, self mailers, letters, and checks):    * `In Transit` - The mailpiece is being processed at the entry/origin facility.    * `In Local Area` - The mailpiece is being processed at the destination facility.    * `Processed for Delivery` - The mailpiece has been greenlit for     delivery at the recipient's nearest postal facility. The mailpiece     should reach the mailbox within 1 business day of this tracking     event.    * `Re-Routed` - The mailpiece is re-routed due to recipient change of     address, address errors, or USPS relabeling of barcode/ID tag     area.    * `Returned to Sender` - The mailpiece is being returned to sender due     to barcode, ID tag area, or address errors.    * `Mailed` - The mailpiece has been handed off to and accepted by USPS     and is en route. [More about     Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-)     Note this data is only available in Enterprise editions of     Lob. [Contact Sales](https://lob.com/support/contact#contact) if     you want access to this feature.  [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-)
	Name string `json:"name"`
	// Will be `null` for `type=normal` events
	Details map[string]interface{} `json:"details,omitempty"`
	// The zip code in which the scan event occurred. Null for `Mailed` events.
	Location NullableString `json:"location,omitempty"`
	// Unique identifier prefixed with `evnt_`.
	Id *string `json:"id,omitempty"`
	// A timestamp in ISO 8601 format of the date USPS registered the event.
	Time *time.Time `json:"time,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// A timestamp in ISO 8601 format of the date the resource was last modified.
	DateModified *time.Time `json:"date_modified,omitempty"`
	Object       *string    `json:"object,omitempty"`
}

TrackingEventNormal struct for TrackingEventNormal

func NewTrackingEventNormal 

func NewTrackingEventNormal(type_ string, name string) *TrackingEventNormal

NewTrackingEventNormal instantiates a new TrackingEventNormal object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTrackingEventNormalWithDefaults 

func NewTrackingEventNormalWithDefaults() *TrackingEventNormal

NewTrackingEventNormalWithDefaults instantiates a new TrackingEventNormal object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TrackingEventNormal) GetDateCreated 

func (o *TrackingEventNormal) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value if set, zero value otherwise.

func (*TrackingEventNormal) GetDateCreatedOk 

func (o *TrackingEventNormal) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventNormal) GetDateModified 

func (o *TrackingEventNormal) GetDateModified() time.Time

GetDateModified returns the DateModified field value if set, zero value otherwise.

func (*TrackingEventNormal) GetDateModifiedOk 

func (o *TrackingEventNormal) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventNormal) GetDetails 

func (o *TrackingEventNormal) GetDetails() map[string]interface{}

GetDetails returns the Details field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TrackingEventNormal) GetDetailsOk 

func (o *TrackingEventNormal) GetDetailsOk() (map[string]interface{}, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TrackingEventNormal) GetId 

func (o *TrackingEventNormal) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*TrackingEventNormal) GetIdOk 

func (o *TrackingEventNormal) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventNormal) GetLocation 

func (o *TrackingEventNormal) GetLocation() string

GetLocation returns the Location field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TrackingEventNormal) GetLocationOk 

func (o *TrackingEventNormal) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TrackingEventNormal) GetName 

func (o *TrackingEventNormal) GetName() string

GetName returns the Name field value

func (*TrackingEventNormal) GetNameOk 

func (o *TrackingEventNormal) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*TrackingEventNormal) GetObject 

func (o *TrackingEventNormal) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*TrackingEventNormal) GetObjectOk 

func (o *TrackingEventNormal) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventNormal) GetTime 

func (o *TrackingEventNormal) GetTime() time.Time

GetTime returns the Time field value if set, zero value otherwise.

func (*TrackingEventNormal) GetTimeOk 

func (o *TrackingEventNormal) GetTimeOk() (*time.Time, bool)

GetTimeOk returns a tuple with the Time field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TrackingEventNormal) GetType 

func (o *TrackingEventNormal) GetType() string

GetType returns the Type field value

func (*TrackingEventNormal) GetTypeOk 

func (o *TrackingEventNormal) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*TrackingEventNormal) HasDateCreated 

func (o *TrackingEventNormal) HasDateCreated() bool

HasDateCreated returns a boolean if a field has been set.

func (*TrackingEventNormal) HasDateModified 

func (o *TrackingEventNormal) HasDateModified() bool

HasDateModified returns a boolean if a field has been set.

func (*TrackingEventNormal) HasDetails 

func (o *TrackingEventNormal) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*TrackingEventNormal) HasId 

func (o *TrackingEventNormal) HasId() bool

HasId returns a boolean if a field has been set.

func (*TrackingEventNormal) HasLocation 

func (o *TrackingEventNormal) HasLocation() bool

HasLocation returns a boolean if a field has been set.

func (*TrackingEventNormal) HasObject 

func (o *TrackingEventNormal) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*TrackingEventNormal) HasTime 

func (o *TrackingEventNormal) HasTime() bool

HasTime returns a boolean if a field has been set.

func (TrackingEventNormal) MarshalJSON 

func (o TrackingEventNormal) MarshalJSON() ([]byte, error)

func (*TrackingEventNormal) SetDateCreated 

func (o *TrackingEventNormal) SetDateCreated(v time.Time)

SetDateCreated gets a reference to the given time.Time and assigns it to the DateCreated field.

func (*TrackingEventNormal) SetDateModified 

func (o *TrackingEventNormal) SetDateModified(v time.Time)

SetDateModified gets a reference to the given time.Time and assigns it to the DateModified field.

func (*TrackingEventNormal) SetDetails 

func (o *TrackingEventNormal) SetDetails(v map[string]interface{})

SetDetails gets a reference to the given map[string]interface{} and assigns it to the Details field.

func (*TrackingEventNormal) SetId 

func (o *TrackingEventNormal) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*TrackingEventNormal) SetLocation 

func (o *TrackingEventNormal) SetLocation(v string)

SetLocation gets a reference to the given NullableString and assigns it to the Location field.

func (*TrackingEventNormal) SetLocationNil 

func (o *TrackingEventNormal) SetLocationNil()

SetLocationNil sets the value for Location to be an explicit nil

func (*TrackingEventNormal) SetName 

func (o *TrackingEventNormal) SetName(v string)

SetName sets field value

func (*TrackingEventNormal) SetObject 

func (o *TrackingEventNormal) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*TrackingEventNormal) SetTime 

func (o *TrackingEventNormal) SetTime(v time.Time)

SetTime gets a reference to the given time.Time and assigns it to the Time field.

func (*TrackingEventNormal) SetType 

func (o *TrackingEventNormal) SetType(v string)

SetType sets field value

func (*TrackingEventNormal) UnsetLocation 

func (o *TrackingEventNormal) UnsetLocation()

UnsetLocation ensures that no value is present for Location, not even an explicit nil

type Upload 

type Upload struct {
	// Unique identifier prefixed with `upl_`.
	Id string `json:"id"`
	// Account ID that made the request
	AccountId string `json:"accountId"`
	// The environment in which the mailpieces were created. Today, will only be `live`.
	Mode string `json:"mode"`
	// Url where your campaign mailpiece failures can be retrieved
	FailuresUrl *string `json:"failuresUrl,omitempty"`
	// Filename of the upload
	OriginalFilename *string     `json:"originalFilename,omitempty"`
	State            UploadState `json:"state"`
	// Total number of recipients for the campaign
	TotalMailpieces int32 `json:"totalMailpieces"`
	// Number of mailpieces that failed to create
	FailedMailpieces int32 `json:"failedMailpieces"`
	// Number of mailpieces that were successfully created
	ValidatedMailpieces int32 `json:"validatedMailpieces"`
	// Number of bytes processed in your CSV
	BytesProcessed int32 `json:"bytesProcessed"`
	// A timestamp in ISO 8601 format of the date the upload was created
	DateCreated time.Time `json:"dateCreated"`
	// A timestamp in ISO 8601 format of the date the upload was last modified
	DateModified                 time.Time                    `json:"dateModified"`
	RequiredAddressColumnMapping RequiredAddressColumnMapping `json:"requiredAddressColumnMapping"`
	OptionalAddressColumnMapping OptionalAddressColumnMapping `json:"optionalAddressColumnMapping"`
	Metadata                     UploadsMetadata              `json:"metadata"`
	// The mapping of column headers in your file to the merge variables present in your creative. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7\" target=\"_blank\">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same \"name\" as a \"key\" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects.
	MergeVariableColumnMapping map[string]interface{} `json:"mergeVariableColumnMapping"`
}

Upload struct for Upload

func NewUpload 

func NewUpload(id string, accountId string, mode string, state UploadState, totalMailpieces int32, failedMailpieces int32, validatedMailpieces int32, bytesProcessed int32, dateCreated time.Time, dateModified time.Time, requiredAddressColumnMapping RequiredAddressColumnMapping, optionalAddressColumnMapping OptionalAddressColumnMapping, metadata UploadsMetadata, mergeVariableColumnMapping map[string]interface{}) *Upload

NewUpload instantiates a new Upload object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUploadWithDefaults 

func NewUploadWithDefaults() *Upload

NewUploadWithDefaults instantiates a new Upload object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Upload) GetAccountId 

func (o *Upload) GetAccountId() string

GetAccountId returns the AccountId field value

func (*Upload) GetAccountIdOk 

func (o *Upload) GetAccountIdOk() (*string, bool)

GetAccountIdOk returns a tuple with the AccountId field value and a boolean to check if the value has been set.

func (*Upload) GetBytesProcessed 

func (o *Upload) GetBytesProcessed() int32

GetBytesProcessed returns the BytesProcessed field value

func (*Upload) GetBytesProcessedOk 

func (o *Upload) GetBytesProcessedOk() (*int32, bool)

GetBytesProcessedOk returns a tuple with the BytesProcessed field value and a boolean to check if the value has been set.

func (*Upload) GetDateCreated 

func (o *Upload) GetDateCreated() time.Time

GetDateCreated returns the DateCreated field value

func (*Upload) GetDateCreatedOk 

func (o *Upload) GetDateCreatedOk() (*time.Time, bool)

GetDateCreatedOk returns a tuple with the DateCreated field value and a boolean to check if the value has been set.

func (*Upload) GetDateModified 

func (o *Upload) GetDateModified() time.Time

GetDateModified returns the DateModified field value

func (*Upload) GetDateModifiedOk 

func (o *Upload) GetDateModifiedOk() (*time.Time, bool)

GetDateModifiedOk returns a tuple with the DateModified field value and a boolean to check if the value has been set.

func (*Upload) GetFailedMailpieces 

func (o *Upload) GetFailedMailpieces() int32

GetFailedMailpieces returns the FailedMailpieces field value

func (*Upload) GetFailedMailpiecesOk 

func (o *Upload) GetFailedMailpiecesOk() (*int32, bool)

GetFailedMailpiecesOk returns a tuple with the FailedMailpieces field value and a boolean to check if the value has been set.

func (*Upload) GetFailuresUrl 

func (o *Upload) GetFailuresUrl() string

GetFailuresUrl returns the FailuresUrl field value if set, zero value otherwise.

func (*Upload) GetFailuresUrlOk 

func (o *Upload) GetFailuresUrlOk() (*string, bool)

GetFailuresUrlOk returns a tuple with the FailuresUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Upload) GetId 

func (o *Upload) GetId() string

GetId returns the Id field value

func (*Upload) GetIdOk 

func (o *Upload) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Upload) GetMergeVariableColumnMapping 

func (o *Upload) GetMergeVariableColumnMapping() map[string]interface{}

GetMergeVariableColumnMapping returns the MergeVariableColumnMapping field value If the value is explicit nil, the zero value for map[string]interface{} will be returned

func (*Upload) GetMergeVariableColumnMappingOk 

func (o *Upload) GetMergeVariableColumnMappingOk() (map[string]interface{}, bool)

GetMergeVariableColumnMappingOk returns a tuple with the MergeVariableColumnMapping field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Upload) GetMetadata 

func (o *Upload) GetMetadata() UploadsMetadata

GetMetadata returns the Metadata field value

func (*Upload) GetMetadataOk 

func (o *Upload) GetMetadataOk() (*UploadsMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field value and a boolean to check if the value has been set.

func (*Upload) GetMode 

func (o *Upload) GetMode() string

GetMode returns the Mode field value

func (*Upload) GetModeOk 

func (o *Upload) GetModeOk() (*string, bool)

GetModeOk returns a tuple with the Mode field value and a boolean to check if the value has been set.

func (*Upload) GetOptionalAddressColumnMapping 

func (o *Upload) GetOptionalAddressColumnMapping() OptionalAddressColumnMapping

GetOptionalAddressColumnMapping returns the OptionalAddressColumnMapping field value

func (*Upload) GetOptionalAddressColumnMappingOk 

func (o *Upload) GetOptionalAddressColumnMappingOk() (*OptionalAddressColumnMapping, bool)

GetOptionalAddressColumnMappingOk returns a tuple with the OptionalAddressColumnMapping field value and a boolean to check if the value has been set.

func (*Upload) GetOriginalFilename 

func (o *Upload) GetOriginalFilename() string

GetOriginalFilename returns the OriginalFilename field value if set, zero value otherwise.

func (*Upload) GetOriginalFilenameOk 

func (o *Upload) GetOriginalFilenameOk() (*string, bool)

GetOriginalFilenameOk returns a tuple with the OriginalFilename field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Upload) GetRequiredAddressColumnMapping 

func (o *Upload) GetRequiredAddressColumnMapping() RequiredAddressColumnMapping

GetRequiredAddressColumnMapping returns the RequiredAddressColumnMapping field value

func (*Upload) GetRequiredAddressColumnMappingOk 

func (o *Upload) GetRequiredAddressColumnMappingOk() (*RequiredAddressColumnMapping, bool)

GetRequiredAddressColumnMappingOk returns a tuple with the RequiredAddressColumnMapping field value and a boolean to check if the value has been set.

func (*Upload) GetState 

func (o *Upload) GetState() UploadState

GetState returns the State field value

func (*Upload) GetStateOk 

func (o *Upload) GetStateOk() (*UploadState, bool)

GetStateOk returns a tuple with the State field value and a boolean to check if the value has been set.

func (*Upload) GetTotalMailpieces 

func (o *Upload) GetTotalMailpieces() int32

GetTotalMailpieces returns the TotalMailpieces field value

func (*Upload) GetTotalMailpiecesOk 

func (o *Upload) GetTotalMailpiecesOk() (*int32, bool)

GetTotalMailpiecesOk returns a tuple with the TotalMailpieces field value and a boolean to check if the value has been set.

func (*Upload) GetValidatedMailpieces 

func (o *Upload) GetValidatedMailpieces() int32

GetValidatedMailpieces returns the ValidatedMailpieces field value

func (*Upload) GetValidatedMailpiecesOk 

func (o *Upload) GetValidatedMailpiecesOk() (*int32, bool)

GetValidatedMailpiecesOk returns a tuple with the ValidatedMailpieces field value and a boolean to check if the value has been set.

func (*Upload) HasFailuresUrl 

func (o *Upload) HasFailuresUrl() bool

HasFailuresUrl returns a boolean if a field has been set.

func (*Upload) HasOriginalFilename 

func (o *Upload) HasOriginalFilename() bool

HasOriginalFilename returns a boolean if a field has been set.

func (Upload) MarshalJSON 

func (o Upload) MarshalJSON() ([]byte, error)

func (*Upload) SetAccountId 

func (o *Upload) SetAccountId(v string)

SetAccountId sets field value

func (*Upload) SetBytesProcessed 

func (o *Upload) SetBytesProcessed(v int32)

SetBytesProcessed sets field value

func (*Upload) SetDateCreated 

func (o *Upload) SetDateCreated(v time.Time)

SetDateCreated sets field value

func (*Upload) SetDateModified 

func (o *Upload) SetDateModified(v time.Time)

SetDateModified sets field value

func (*Upload) SetFailedMailpieces 

func (o *Upload) SetFailedMailpieces(v int32)

SetFailedMailpieces sets field value

func (*Upload) SetFailuresUrl 

func (o *Upload) SetFailuresUrl(v string)

SetFailuresUrl gets a reference to the given string and assigns it to the FailuresUrl field.

func (*Upload) SetId 

func (o *Upload) SetId(v string)

SetId sets field value

func (*Upload) SetMergeVariableColumnMapping 

func (o *Upload) SetMergeVariableColumnMapping(v map[string]interface{})

SetMergeVariableColumnMapping sets field value

func (*Upload) SetMetadata 

func (o *Upload) SetMetadata(v UploadsMetadata)

SetMetadata sets field value

func (*Upload) SetMode 

func (o *Upload) SetMode(v string)

SetMode sets field value

func (*Upload) SetOptionalAddressColumnMapping 

func (o *Upload) SetOptionalAddressColumnMapping(v OptionalAddressColumnMapping)

SetOptionalAddressColumnMapping sets field value

func (*Upload) SetOriginalFilename 

func (o *Upload) SetOriginalFilename(v string)

SetOriginalFilename gets a reference to the given string and assigns it to the OriginalFilename field.

func (*Upload) SetRequiredAddressColumnMapping 

func (o *Upload) SetRequiredAddressColumnMapping(v RequiredAddressColumnMapping)

SetRequiredAddressColumnMapping sets field value

func (*Upload) SetState 

func (o *Upload) SetState(v UploadState)

SetState sets field value

func (*Upload) SetTotalMailpieces 

func (o *Upload) SetTotalMailpieces(v int32)

SetTotalMailpieces sets field value

func (*Upload) SetValidatedMailpieces 

func (o *Upload) SetValidatedMailpieces(v int32)

SetValidatedMailpieces sets field value

type UploadCreateExport 

type UploadCreateExport struct {
	Message  string `json:"message"`
	ExportId string `json:"exportId"`
}

UploadCreateExport struct for UploadCreateExport

func NewUploadCreateExport 

func NewUploadCreateExport(message string, exportId string) *UploadCreateExport

NewUploadCreateExport instantiates a new UploadCreateExport object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUploadCreateExportWithDefaults 

func NewUploadCreateExportWithDefaults() *UploadCreateExport

NewUploadCreateExportWithDefaults instantiates a new UploadCreateExport object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UploadCreateExport) GetExportId 

func (o *UploadCreateExport) GetExportId() string

GetExportId returns the ExportId field value

func (*UploadCreateExport) GetExportIdOk 

func (o *UploadCreateExport) GetExportIdOk() (*string, bool)

GetExportIdOk returns a tuple with the ExportId field value and a boolean to check if the value has been set.

func (*UploadCreateExport) GetMessage 

func (o *UploadCreateExport) GetMessage() string

GetMessage returns the Message field value

func (*UploadCreateExport) GetMessageOk 

func (o *UploadCreateExport) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (UploadCreateExport) MarshalJSON 

func (o UploadCreateExport) MarshalJSON() ([]byte, error)

func (*UploadCreateExport) SetExportId 

func (o *UploadCreateExport) SetExportId(v string)

SetExportId sets field value

func (*UploadCreateExport) SetMessage 

func (o *UploadCreateExport) SetMessage(v string)

SetMessage sets field value

type UploadFile 

type UploadFile struct {
	Message  string `json:"message"`
	Filename string `json:"filename"`
}

UploadFile struct for UploadFile

func NewUploadFile 

func NewUploadFile(message string, filename string) *UploadFile

NewUploadFile instantiates a new UploadFile object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUploadFileWithDefaults 

func NewUploadFileWithDefaults() *UploadFile

NewUploadFileWithDefaults instantiates a new UploadFile object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UploadFile) GetFilename 

func (o *UploadFile) GetFilename() string

GetFilename returns the Filename field value

func (*UploadFile) GetFilenameOk 

func (o *UploadFile) GetFilenameOk() (*string, bool)

GetFilenameOk returns a tuple with the Filename field value and a boolean to check if the value has been set.

func (*UploadFile) GetMessage 

func (o *UploadFile) GetMessage() string

GetMessage returns the Message field value

func (*UploadFile) GetMessageOk 

func (o *UploadFile) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (UploadFile) MarshalJSON 

func (o UploadFile) MarshalJSON() ([]byte, error)

func (*UploadFile) SetFilename 

func (o *UploadFile) SetFilename(v string)

SetFilename sets field value

func (*UploadFile) SetMessage 

func (o *UploadFile) SetMessage(v string)

SetMessage sets field value

type UploadState 

type UploadState string

UploadState The `state` property on the `upload` object. As the file is processed, the `state` will change from `Ready for Validation` to `Validating` and then will be either `Scheduled` (successfully processed) or `Errored` (Unsuccessfully processed). 

const (
	UPLOADSTATE_PREPROCESSING        UploadState = "Preprocessing"
	UPLOADSTATE_DRAFT                UploadState = "Draft"
	UPLOADSTATE_READY_FOR_VALIDATION UploadState = "Ready for Validation"
	UPLOADSTATE_VALIDATING           UploadState = "Validating"
	UPLOADSTATE_SCHEDULED            UploadState = "Scheduled"
	UPLOADSTATE_CANCELLED            UploadState = "Cancelled"
	UPLOADSTATE_ERRORED              UploadState = "Errored"
)

List of upload_state

func NewUploadStateFromValue 

func NewUploadStateFromValue(v string) (*UploadState, error)

NewUploadStateFromValue returns a pointer to a valid UploadState for the value passed as argument, or an error if the value passed is not allowed by the enum

func (UploadState) IsValid 

func (v UploadState) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (UploadState) Ptr 

func (v UploadState) Ptr() *UploadState

Ptr returns reference to upload_state value

func (*UploadState) UnmarshalJSON 

func (v *UploadState) UnmarshalJSON(src []byte) error

type UploadUpdatable 

type UploadUpdatable struct {
	// Original filename provided when the upload is created.
	OriginalFilename             *string                       `json:"originalFilename,omitempty"`
	RequiredAddressColumnMapping *RequiredAddressColumnMapping `json:"requiredAddressColumnMapping,omitempty"`
	OptionalAddressColumnMapping *OptionalAddressColumnMapping `json:"optionalAddressColumnMapping,omitempty"`
	Metadata                     *UploadsMetadata              `json:"metadata,omitempty"`
	// The mapping of column headers in your file to the merge variables present in your creative. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7\" target=\"_blank\">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same \"name\" as a \"key\" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects.
	MergeVariableColumnMapping map[string]interface{} `json:"mergeVariableColumnMapping,omitempty"`
}

UploadUpdatable struct for UploadUpdatable

func NewUploadUpdatable 

func NewUploadUpdatable() *UploadUpdatable

NewUploadUpdatable instantiates a new UploadUpdatable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUploadUpdatableWithDefaults 

func NewUploadUpdatableWithDefaults() *UploadUpdatable

NewUploadUpdatableWithDefaults instantiates a new UploadUpdatable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UploadUpdatable) GetMergeVariableColumnMapping 

func (o *UploadUpdatable) GetMergeVariableColumnMapping() map[string]interface{}

GetMergeVariableColumnMapping returns the MergeVariableColumnMapping field value if set, zero value otherwise (both if not set or set to explicit null).

func (*UploadUpdatable) GetMergeVariableColumnMappingOk 

func (o *UploadUpdatable) GetMergeVariableColumnMappingOk() (map[string]interface{}, bool)

GetMergeVariableColumnMappingOk returns a tuple with the MergeVariableColumnMapping field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*UploadUpdatable) GetMetadata 

func (o *UploadUpdatable) GetMetadata() UploadsMetadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*UploadUpdatable) GetMetadataOk 

func (o *UploadUpdatable) GetMetadataOk() (*UploadsMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UploadUpdatable) GetOptionalAddressColumnMapping 

func (o *UploadUpdatable) GetOptionalAddressColumnMapping() OptionalAddressColumnMapping

GetOptionalAddressColumnMapping returns the OptionalAddressColumnMapping field value if set, zero value otherwise.

func (*UploadUpdatable) GetOptionalAddressColumnMappingOk 

func (o *UploadUpdatable) GetOptionalAddressColumnMappingOk() (*OptionalAddressColumnMapping, bool)

GetOptionalAddressColumnMappingOk returns a tuple with the OptionalAddressColumnMapping field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UploadUpdatable) GetOriginalFilename 

func (o *UploadUpdatable) GetOriginalFilename() string

GetOriginalFilename returns the OriginalFilename field value if set, zero value otherwise.

func (*UploadUpdatable) GetOriginalFilenameOk 

func (o *UploadUpdatable) GetOriginalFilenameOk() (*string, bool)

GetOriginalFilenameOk returns a tuple with the OriginalFilename field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UploadUpdatable) GetRequiredAddressColumnMapping 

func (o *UploadUpdatable) GetRequiredAddressColumnMapping() RequiredAddressColumnMapping

GetRequiredAddressColumnMapping returns the RequiredAddressColumnMapping field value if set, zero value otherwise.

func (*UploadUpdatable) GetRequiredAddressColumnMappingOk 

func (o *UploadUpdatable) GetRequiredAddressColumnMappingOk() (*RequiredAddressColumnMapping, bool)

GetRequiredAddressColumnMappingOk returns a tuple with the RequiredAddressColumnMapping field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UploadUpdatable) HasMergeVariableColumnMapping 

func (o *UploadUpdatable) HasMergeVariableColumnMapping() bool

HasMergeVariableColumnMapping returns a boolean if a field has been set.

func (*UploadUpdatable) HasMetadata 

func (o *UploadUpdatable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*UploadUpdatable) HasOptionalAddressColumnMapping 

func (o *UploadUpdatable) HasOptionalAddressColumnMapping() bool

HasOptionalAddressColumnMapping returns a boolean if a field has been set.

func (*UploadUpdatable) HasOriginalFilename 

func (o *UploadUpdatable) HasOriginalFilename() bool

HasOriginalFilename returns a boolean if a field has been set.

func (*UploadUpdatable) HasRequiredAddressColumnMapping 

func (o *UploadUpdatable) HasRequiredAddressColumnMapping() bool

HasRequiredAddressColumnMapping returns a boolean if a field has been set.

func (UploadUpdatable) MarshalJSON 

func (o UploadUpdatable) MarshalJSON() ([]byte, error)

func (*UploadUpdatable) SetMergeVariableColumnMapping 

func (o *UploadUpdatable) SetMergeVariableColumnMapping(v map[string]interface{})

SetMergeVariableColumnMapping gets a reference to the given map[string]interface{} and assigns it to the MergeVariableColumnMapping field.

func (*UploadUpdatable) SetMetadata 

func (o *UploadUpdatable) SetMetadata(v UploadsMetadata)

SetMetadata gets a reference to the given UploadsMetadata and assigns it to the Metadata field.

func (*UploadUpdatable) SetOptionalAddressColumnMapping 

func (o *UploadUpdatable) SetOptionalAddressColumnMapping(v OptionalAddressColumnMapping)

SetOptionalAddressColumnMapping gets a reference to the given OptionalAddressColumnMapping and assigns it to the OptionalAddressColumnMapping field.

func (*UploadUpdatable) SetOriginalFilename 

func (o *UploadUpdatable) SetOriginalFilename(v string)

SetOriginalFilename gets a reference to the given string and assigns it to the OriginalFilename field.

func (*UploadUpdatable) SetRequiredAddressColumnMapping 

func (o *UploadUpdatable) SetRequiredAddressColumnMapping(v RequiredAddressColumnMapping)

SetRequiredAddressColumnMapping gets a reference to the given RequiredAddressColumnMapping and assigns it to the RequiredAddressColumnMapping field.

type UploadWritable 

type UploadWritable struct {
	CampaignId                   string                        `json:"campaignId"`
	RequiredAddressColumnMapping *RequiredAddressColumnMapping `json:"requiredAddressColumnMapping,omitempty"`
	OptionalAddressColumnMapping *OptionalAddressColumnMapping `json:"optionalAddressColumnMapping,omitempty"`
	Metadata                     *UploadsMetadata              `json:"metadata,omitempty"`
	// The mapping of column headers in your file to the merge variables present in your creative. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7\" target=\"_blank\">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same \"name\" as a \"key\" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects.
	MergeVariableColumnMapping map[string]interface{} `json:"mergeVariableColumnMapping,omitempty"`
}

UploadWritable struct for UploadWritable

func NewUploadWritable 

func NewUploadWritable(campaignId string) *UploadWritable

NewUploadWritable instantiates a new UploadWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUploadWritableWithDefaults 

func NewUploadWritableWithDefaults() *UploadWritable

NewUploadWritableWithDefaults instantiates a new UploadWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UploadWritable) GetCampaignId 

func (o *UploadWritable) GetCampaignId() string

GetCampaignId returns the CampaignId field value

func (*UploadWritable) GetCampaignIdOk 

func (o *UploadWritable) GetCampaignIdOk() (*string, bool)

GetCampaignIdOk returns a tuple with the CampaignId field value and a boolean to check if the value has been set.

func (*UploadWritable) GetMergeVariableColumnMapping 

func (o *UploadWritable) GetMergeVariableColumnMapping() map[string]interface{}

GetMergeVariableColumnMapping returns the MergeVariableColumnMapping field value if set, zero value otherwise (both if not set or set to explicit null).

func (*UploadWritable) GetMergeVariableColumnMappingOk 

func (o *UploadWritable) GetMergeVariableColumnMappingOk() (map[string]interface{}, bool)

GetMergeVariableColumnMappingOk returns a tuple with the MergeVariableColumnMapping field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*UploadWritable) GetMetadata 

func (o *UploadWritable) GetMetadata() UploadsMetadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*UploadWritable) GetMetadataOk 

func (o *UploadWritable) GetMetadataOk() (*UploadsMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UploadWritable) GetOptionalAddressColumnMapping 

func (o *UploadWritable) GetOptionalAddressColumnMapping() OptionalAddressColumnMapping

GetOptionalAddressColumnMapping returns the OptionalAddressColumnMapping field value if set, zero value otherwise.

func (*UploadWritable) GetOptionalAddressColumnMappingOk 

func (o *UploadWritable) GetOptionalAddressColumnMappingOk() (*OptionalAddressColumnMapping, bool)

GetOptionalAddressColumnMappingOk returns a tuple with the OptionalAddressColumnMapping field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UploadWritable) GetRequiredAddressColumnMapping 

func (o *UploadWritable) GetRequiredAddressColumnMapping() RequiredAddressColumnMapping

GetRequiredAddressColumnMapping returns the RequiredAddressColumnMapping field value if set, zero value otherwise.

func (*UploadWritable) GetRequiredAddressColumnMappingOk 

func (o *UploadWritable) GetRequiredAddressColumnMappingOk() (*RequiredAddressColumnMapping, bool)

GetRequiredAddressColumnMappingOk returns a tuple with the RequiredAddressColumnMapping field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UploadWritable) HasMergeVariableColumnMapping 

func (o *UploadWritable) HasMergeVariableColumnMapping() bool

HasMergeVariableColumnMapping returns a boolean if a field has been set.

func (*UploadWritable) HasMetadata 

func (o *UploadWritable) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*UploadWritable) HasOptionalAddressColumnMapping 

func (o *UploadWritable) HasOptionalAddressColumnMapping() bool

HasOptionalAddressColumnMapping returns a boolean if a field has been set.

func (*UploadWritable) HasRequiredAddressColumnMapping 

func (o *UploadWritable) HasRequiredAddressColumnMapping() bool

HasRequiredAddressColumnMapping returns a boolean if a field has been set.

func (UploadWritable) MarshalJSON 

func (o UploadWritable) MarshalJSON() ([]byte, error)

func (*UploadWritable) SetCampaignId 

func (o *UploadWritable) SetCampaignId(v string)

SetCampaignId sets field value

func (*UploadWritable) SetMergeVariableColumnMapping 

func (o *UploadWritable) SetMergeVariableColumnMapping(v map[string]interface{})

SetMergeVariableColumnMapping gets a reference to the given map[string]interface{} and assigns it to the MergeVariableColumnMapping field.

func (*UploadWritable) SetMetadata 

func (o *UploadWritable) SetMetadata(v UploadsMetadata)

SetMetadata gets a reference to the given UploadsMetadata and assigns it to the Metadata field.

func (*UploadWritable) SetOptionalAddressColumnMapping 

func (o *UploadWritable) SetOptionalAddressColumnMapping(v OptionalAddressColumnMapping)

SetOptionalAddressColumnMapping gets a reference to the given OptionalAddressColumnMapping and assigns it to the OptionalAddressColumnMapping field.

func (*UploadWritable) SetRequiredAddressColumnMapping 

func (o *UploadWritable) SetRequiredAddressColumnMapping(v RequiredAddressColumnMapping)

SetRequiredAddressColumnMapping gets a reference to the given RequiredAddressColumnMapping and assigns it to the RequiredAddressColumnMapping field.

type UploadsMetadata 

type UploadsMetadata struct {
	// The list of column names from the csv file which you want associated with each of your mailpieces
	Columns []string `json:"columns"`
}

UploadsMetadata The list of column headers in your file as an array that you want as metadata associated with each mailpiece. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#required-columns-2\" target=\"_blank\">Campaign Audience Guide</a> for additional details.

func NewUploadsMetadata 

func NewUploadsMetadata(columns []string) *UploadsMetadata

NewUploadsMetadata instantiates a new UploadsMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUploadsMetadataWithDefaults 

func NewUploadsMetadataWithDefaults() *UploadsMetadata

NewUploadsMetadataWithDefaults instantiates a new UploadsMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UploadsMetadata) GetColumns 

func (o *UploadsMetadata) GetColumns() []string

GetColumns returns the Columns field value

func (*UploadsMetadata) GetColumnsOk 

func (o *UploadsMetadata) GetColumnsOk() ([]string, bool)

GetColumnsOk returns a tuple with the Columns field value and a boolean to check if the value has been set.

func (UploadsMetadata) MarshalJSON 

func (o UploadsMetadata) MarshalJSON() ([]byte, error)

func (*UploadsMetadata) SetColumns 

func (o *UploadsMetadata) SetColumns(v []string)

SetColumns sets field value

type UsAutocompletions 

type UsAutocompletions struct {
	// Unique identifier prefixed with `us_auto_`.
	Id *string `json:"id,omitempty"`
	// An array of objects representing suggested addresses.
	Suggestions []Suggestions `json:"suggestions,omitempty"`
	// Value is resource type.
	Object *string `json:"object,omitempty"`
}

UsAutocompletions struct for UsAutocompletions

func NewUsAutocompletions 

func NewUsAutocompletions() *UsAutocompletions

NewUsAutocompletions instantiates a new UsAutocompletions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsAutocompletionsWithDefaults 

func NewUsAutocompletionsWithDefaults() *UsAutocompletions

NewUsAutocompletionsWithDefaults instantiates a new UsAutocompletions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsAutocompletions) GetId 

func (o *UsAutocompletions) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*UsAutocompletions) GetIdOk 

func (o *UsAutocompletions) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsAutocompletions) GetObject 

func (o *UsAutocompletions) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*UsAutocompletions) GetObjectOk 

func (o *UsAutocompletions) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsAutocompletions) GetSuggestions 

func (o *UsAutocompletions) GetSuggestions() []Suggestions

GetSuggestions returns the Suggestions field value if set, zero value otherwise.

func (*UsAutocompletions) GetSuggestionsOk 

func (o *UsAutocompletions) GetSuggestionsOk() ([]Suggestions, bool)

GetSuggestionsOk returns a tuple with the Suggestions field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsAutocompletions) HasId 

func (o *UsAutocompletions) HasId() bool

HasId returns a boolean if a field has been set.

func (*UsAutocompletions) HasObject 

func (o *UsAutocompletions) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*UsAutocompletions) HasSuggestions 

func (o *UsAutocompletions) HasSuggestions() bool

HasSuggestions returns a boolean if a field has been set.

func (UsAutocompletions) MarshalJSON 

func (o UsAutocompletions) MarshalJSON() ([]byte, error)

func (*UsAutocompletions) SetId 

func (o *UsAutocompletions) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*UsAutocompletions) SetObject 

func (o *UsAutocompletions) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*UsAutocompletions) SetSuggestions 

func (o *UsAutocompletions) SetSuggestions(v []Suggestions)

SetSuggestions gets a reference to the given []Suggestions and assigns it to the Suggestions field.

type UsAutocompletionsApiService 

type UsAutocompletionsApiService service

UsAutocompletionsApiService UsAutocompletionsApi service

func (*UsAutocompletionsApiService) Autocomplete 

func (a *UsAutocompletionsApiService) Autocomplete(ctx context.Context) ApiUsAutocompletionRequest

UsAutocompletion autocomplete

Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiUsAutocompletionRequest

func (*UsAutocompletionsApiService) UsAutocompletionExecute 

func (a *UsAutocompletionsApiService) UsAutocompletionExecute(r ApiUsAutocompletionRequest) (*UsAutocompletions, *http.Response, error)

Execute executes the request 

@return UsAutocompletions

type UsAutocompletionsWritable 

type UsAutocompletionsWritable struct {
	// Only accepts numbers and street names in an alphanumeric format.
	AddressPrefix string `json:"address_prefix"`
	// An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations.
	City *string `json:"city,omitempty"`
	// An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations.
	State *string `json:"state,omitempty"`
	// An optional ZIP Code input used to filter suggestions. Matches partial entries.
	ZipCode *string `json:"zip_code,omitempty"`
	// If `true`, sort suggestions by proximity to the IP set in the `X-Forwarded-For` header.
	GeoIpSort *bool `json:"geo_ip_sort,omitempty"`
}

UsAutocompletionsWritable struct for UsAutocompletionsWritable

func NewUsAutocompletionsWritable 

func NewUsAutocompletionsWritable(addressPrefix string) *UsAutocompletionsWritable

NewUsAutocompletionsWritable instantiates a new UsAutocompletionsWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsAutocompletionsWritableWithDefaults 

func NewUsAutocompletionsWritableWithDefaults() *UsAutocompletionsWritable

NewUsAutocompletionsWritableWithDefaults instantiates a new UsAutocompletionsWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsAutocompletionsWritable) GetAddressPrefix 

func (o *UsAutocompletionsWritable) GetAddressPrefix() string

GetAddressPrefix returns the AddressPrefix field value

func (*UsAutocompletionsWritable) GetAddressPrefixOk 

func (o *UsAutocompletionsWritable) GetAddressPrefixOk() (*string, bool)

GetAddressPrefixOk returns a tuple with the AddressPrefix field value and a boolean to check if the value has been set.

func (*UsAutocompletionsWritable) GetCity 

func (o *UsAutocompletionsWritable) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*UsAutocompletionsWritable) GetCityOk 

func (o *UsAutocompletionsWritable) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsAutocompletionsWritable) GetGeoIpSort 

func (o *UsAutocompletionsWritable) GetGeoIpSort() bool

GetGeoIpSort returns the GeoIpSort field value if set, zero value otherwise.

func (*UsAutocompletionsWritable) GetGeoIpSortOk 

func (o *UsAutocompletionsWritable) GetGeoIpSortOk() (*bool, bool)

GetGeoIpSortOk returns a tuple with the GeoIpSort field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsAutocompletionsWritable) GetState 

func (o *UsAutocompletionsWritable) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*UsAutocompletionsWritable) GetStateOk 

func (o *UsAutocompletionsWritable) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsAutocompletionsWritable) GetZipCode 

func (o *UsAutocompletionsWritable) GetZipCode() string

GetZipCode returns the ZipCode field value if set, zero value otherwise.

func (*UsAutocompletionsWritable) GetZipCodeOk 

func (o *UsAutocompletionsWritable) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsAutocompletionsWritable) HasCity 

func (o *UsAutocompletionsWritable) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*UsAutocompletionsWritable) HasGeoIpSort 

func (o *UsAutocompletionsWritable) HasGeoIpSort() bool

HasGeoIpSort returns a boolean if a field has been set.

func (*UsAutocompletionsWritable) HasState 

func (o *UsAutocompletionsWritable) HasState() bool

HasState returns a boolean if a field has been set.

func (*UsAutocompletionsWritable) HasZipCode 

func (o *UsAutocompletionsWritable) HasZipCode() bool

HasZipCode returns a boolean if a field has been set.

func (UsAutocompletionsWritable) MarshalJSON 

func (o UsAutocompletionsWritable) MarshalJSON() ([]byte, error)

func (*UsAutocompletionsWritable) SetAddressPrefix 

func (o *UsAutocompletionsWritable) SetAddressPrefix(v string)

SetAddressPrefix sets field value

func (*UsAutocompletionsWritable) SetCity 

func (o *UsAutocompletionsWritable) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*UsAutocompletionsWritable) SetGeoIpSort 

func (o *UsAutocompletionsWritable) SetGeoIpSort(v bool)

SetGeoIpSort gets a reference to the given bool and assigns it to the GeoIpSort field.

func (*UsAutocompletionsWritable) SetState 

func (o *UsAutocompletionsWritable) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*UsAutocompletionsWritable) SetZipCode 

func (o *UsAutocompletionsWritable) SetZipCode(v string)

SetZipCode gets a reference to the given string and assigns it to the ZipCode field.

type UsComponents 

type UsComponents struct {
	// The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number.
	PrimaryNumber string `json:"primary_number"`
	// Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).
	StreetPredirection string `json:"street_predirection"`
	// The name of the street.
	StreetName string `json:"street_name"`
	// The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc).
	StreetSuffix string `json:"street_suffix"`
	// Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).
	StreetPostdirection string `json:"street_postdirection"`
	// The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc).
	SecondaryDesignator string `json:"secondary_designator"`
	// Number of the apartment/unit/etc.
	SecondaryNumber string `json:"secondary_number"`
	// Designator of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox.
	PmbDesignator string `json:"pmb_designator"`
	// Number of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox.
	PmbNumber string `json:"pmb_number"`
	// An extra (often unnecessary) secondary designator provided with the input address.
	ExtraSecondaryDesignator string `json:"extra_secondary_designator"`
	// An extra (often unnecessary) secondary number provided with the input address.
	ExtraSecondaryNumber string `json:"extra_secondary_number"`
	City                 string `json:"city"`
	// The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.
	State string `json:"state"`
	// The 5-digit ZIP code
	ZipCode      string      `json:"zip_code"`
	ZipCodePlus4 string      `json:"zip_code_plus_4"`
	ZipCodeType  ZipCodeType `json:"zip_code_type"`
	// A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit.
	DeliveryPointBarcode string `json:"delivery_point_barcode"`
	// Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `”` –– Not enough information provided to be determined.
	AddressType string `json:"address_type"`
	// A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types).
	RecordType string `json:"record_type"`
	// Designates whether or not the address is the default address for a building containing multiple delivery points.
	DefaultBuildingAddress bool `json:"default_building_address"`
	// County name of the address city.
	County string `json:"county"`
	// A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code.
	CountyFips string `json:"county_fips"`
	// A 4-character code assigned to a mail delivery route within a ZIP code.
	CarrierRoute string `json:"carrier_route"`
	// The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types).
	CarrierRouteType string `json:"carrier_route_type"`
	// Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available.
	PoBoxOnlyFlag string `json:"po_box_only_flag"`
	// A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
	Latitude NullableFloat32 `json:"latitude,omitempty"`
	// A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
	Longitude NullableFloat32 `json:"longitude,omitempty"`
}

UsComponents A nested object containing a breakdown of each component of an address.

func NewUsComponents 

func NewUsComponents(primaryNumber string, streetPredirection string, streetName string, streetSuffix string, streetPostdirection string, secondaryDesignator string, secondaryNumber string, pmbDesignator string, pmbNumber string, extraSecondaryDesignator string, extraSecondaryNumber string, city string, state string, zipCode string, zipCodePlus4 string, zipCodeType ZipCodeType, deliveryPointBarcode string, addressType string, recordType string, defaultBuildingAddress bool, county string, countyFips string, carrierRoute string, carrierRouteType string, poBoxOnlyFlag string) *UsComponents

NewUsComponents instantiates a new UsComponents object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsComponentsWithDefaults 

func NewUsComponentsWithDefaults() *UsComponents

NewUsComponentsWithDefaults instantiates a new UsComponents object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsComponents) GetAddressType 

func (o *UsComponents) GetAddressType() string

GetAddressType returns the AddressType field value

func (*UsComponents) GetAddressTypeOk 

func (o *UsComponents) GetAddressTypeOk() (*string, bool)

GetAddressTypeOk returns a tuple with the AddressType field value and a boolean to check if the value has been set.

func (*UsComponents) GetCarrierRoute 

func (o *UsComponents) GetCarrierRoute() string

GetCarrierRoute returns the CarrierRoute field value

func (*UsComponents) GetCarrierRouteOk 

func (o *UsComponents) GetCarrierRouteOk() (*string, bool)

GetCarrierRouteOk returns a tuple with the CarrierRoute field value and a boolean to check if the value has been set.

func (*UsComponents) GetCarrierRouteType 

func (o *UsComponents) GetCarrierRouteType() string

GetCarrierRouteType returns the CarrierRouteType field value

func (*UsComponents) GetCarrierRouteTypeOk 

func (o *UsComponents) GetCarrierRouteTypeOk() (*string, bool)

GetCarrierRouteTypeOk returns a tuple with the CarrierRouteType field value and a boolean to check if the value has been set.

func (*UsComponents) GetCity 

func (o *UsComponents) GetCity() string

GetCity returns the City field value

func (*UsComponents) GetCityOk 

func (o *UsComponents) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value and a boolean to check if the value has been set.

func (*UsComponents) GetCounty 

func (o *UsComponents) GetCounty() string

GetCounty returns the County field value

func (*UsComponents) GetCountyFips 

func (o *UsComponents) GetCountyFips() string

GetCountyFips returns the CountyFips field value

func (*UsComponents) GetCountyFipsOk 

func (o *UsComponents) GetCountyFipsOk() (*string, bool)

GetCountyFipsOk returns a tuple with the CountyFips field value and a boolean to check if the value has been set.

func (*UsComponents) GetCountyOk 

func (o *UsComponents) GetCountyOk() (*string, bool)

GetCountyOk returns a tuple with the County field value and a boolean to check if the value has been set.

func (*UsComponents) GetDefaultBuildingAddress 

func (o *UsComponents) GetDefaultBuildingAddress() bool

GetDefaultBuildingAddress returns the DefaultBuildingAddress field value

func (*UsComponents) GetDefaultBuildingAddressOk 

func (o *UsComponents) GetDefaultBuildingAddressOk() (*bool, bool)

GetDefaultBuildingAddressOk returns a tuple with the DefaultBuildingAddress field value and a boolean to check if the value has been set.

func (*UsComponents) GetDeliveryPointBarcode 

func (o *UsComponents) GetDeliveryPointBarcode() string

GetDeliveryPointBarcode returns the DeliveryPointBarcode field value

func (*UsComponents) GetDeliveryPointBarcodeOk 

func (o *UsComponents) GetDeliveryPointBarcodeOk() (*string, bool)

GetDeliveryPointBarcodeOk returns a tuple with the DeliveryPointBarcode field value and a boolean to check if the value has been set.

func (*UsComponents) GetExtraSecondaryDesignator 

func (o *UsComponents) GetExtraSecondaryDesignator() string

GetExtraSecondaryDesignator returns the ExtraSecondaryDesignator field value

func (*UsComponents) GetExtraSecondaryDesignatorOk 

func (o *UsComponents) GetExtraSecondaryDesignatorOk() (*string, bool)

GetExtraSecondaryDesignatorOk returns a tuple with the ExtraSecondaryDesignator field value and a boolean to check if the value has been set.

func (*UsComponents) GetExtraSecondaryNumber 

func (o *UsComponents) GetExtraSecondaryNumber() string

GetExtraSecondaryNumber returns the ExtraSecondaryNumber field value

func (*UsComponents) GetExtraSecondaryNumberOk 

func (o *UsComponents) GetExtraSecondaryNumberOk() (*string, bool)

GetExtraSecondaryNumberOk returns a tuple with the ExtraSecondaryNumber field value and a boolean to check if the value has been set.

func (*UsComponents) GetLatitude 

func (o *UsComponents) GetLatitude() float32

GetLatitude returns the Latitude field value if set, zero value otherwise (both if not set or set to explicit null).

func (*UsComponents) GetLatitudeOk 

func (o *UsComponents) GetLatitudeOk() (*float32, bool)

GetLatitudeOk returns a tuple with the Latitude field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*UsComponents) GetLongitude 

func (o *UsComponents) GetLongitude() float32

GetLongitude returns the Longitude field value if set, zero value otherwise (both if not set or set to explicit null).

func (*UsComponents) GetLongitudeOk 

func (o *UsComponents) GetLongitudeOk() (*float32, bool)

GetLongitudeOk returns a tuple with the Longitude field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*UsComponents) GetPmbDesignator 

func (o *UsComponents) GetPmbDesignator() string

GetPmbDesignator returns the PmbDesignator field value

func (*UsComponents) GetPmbDesignatorOk 

func (o *UsComponents) GetPmbDesignatorOk() (*string, bool)

GetPmbDesignatorOk returns a tuple with the PmbDesignator field value and a boolean to check if the value has been set.

func (*UsComponents) GetPmbNumber 

func (o *UsComponents) GetPmbNumber() string

GetPmbNumber returns the PmbNumber field value

func (*UsComponents) GetPmbNumberOk 

func (o *UsComponents) GetPmbNumberOk() (*string, bool)

GetPmbNumberOk returns a tuple with the PmbNumber field value and a boolean to check if the value has been set.

func (*UsComponents) GetPoBoxOnlyFlag added in v1.1.0 

func (o *UsComponents) GetPoBoxOnlyFlag() string

GetPoBoxOnlyFlag returns the PoBoxOnlyFlag field value

func (*UsComponents) GetPoBoxOnlyFlagOk added in v1.1.0 

func (o *UsComponents) GetPoBoxOnlyFlagOk() (*string, bool)

GetPoBoxOnlyFlagOk returns a tuple with the PoBoxOnlyFlag field value and a boolean to check if the value has been set.

func (*UsComponents) GetPrimaryNumber 

func (o *UsComponents) GetPrimaryNumber() string

GetPrimaryNumber returns the PrimaryNumber field value

func (*UsComponents) GetPrimaryNumberOk 

func (o *UsComponents) GetPrimaryNumberOk() (*string, bool)

GetPrimaryNumberOk returns a tuple with the PrimaryNumber field value and a boolean to check if the value has been set.

func (*UsComponents) GetRecordType 

func (o *UsComponents) GetRecordType() string

GetRecordType returns the RecordType field value

func (*UsComponents) GetRecordTypeOk 

func (o *UsComponents) GetRecordTypeOk() (*string, bool)

GetRecordTypeOk returns a tuple with the RecordType field value and a boolean to check if the value has been set.

func (*UsComponents) GetSecondaryDesignator 

func (o *UsComponents) GetSecondaryDesignator() string

GetSecondaryDesignator returns the SecondaryDesignator field value

func (*UsComponents) GetSecondaryDesignatorOk 

func (o *UsComponents) GetSecondaryDesignatorOk() (*string, bool)

GetSecondaryDesignatorOk returns a tuple with the SecondaryDesignator field value and a boolean to check if the value has been set.

func (*UsComponents) GetSecondaryNumber 

func (o *UsComponents) GetSecondaryNumber() string

GetSecondaryNumber returns the SecondaryNumber field value

func (*UsComponents) GetSecondaryNumberOk 

func (o *UsComponents) GetSecondaryNumberOk() (*string, bool)

GetSecondaryNumberOk returns a tuple with the SecondaryNumber field value and a boolean to check if the value has been set.

func (*UsComponents) GetState 

func (o *UsComponents) GetState() string

GetState returns the State field value

func (*UsComponents) GetStateOk 

func (o *UsComponents) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value and a boolean to check if the value has been set.

func (*UsComponents) GetStreetName 

func (o *UsComponents) GetStreetName() string

GetStreetName returns the StreetName field value

func (*UsComponents) GetStreetNameOk 

func (o *UsComponents) GetStreetNameOk() (*string, bool)

GetStreetNameOk returns a tuple with the StreetName field value and a boolean to check if the value has been set.

func (*UsComponents) GetStreetPostdirection 

func (o *UsComponents) GetStreetPostdirection() string

GetStreetPostdirection returns the StreetPostdirection field value

func (*UsComponents) GetStreetPostdirectionOk 

func (o *UsComponents) GetStreetPostdirectionOk() (*string, bool)

GetStreetPostdirectionOk returns a tuple with the StreetPostdirection field value and a boolean to check if the value has been set.

func (*UsComponents) GetStreetPredirection 

func (o *UsComponents) GetStreetPredirection() string

GetStreetPredirection returns the StreetPredirection field value

func (*UsComponents) GetStreetPredirectionOk 

func (o *UsComponents) GetStreetPredirectionOk() (*string, bool)

GetStreetPredirectionOk returns a tuple with the StreetPredirection field value and a boolean to check if the value has been set.

func (*UsComponents) GetStreetSuffix 

func (o *UsComponents) GetStreetSuffix() string

GetStreetSuffix returns the StreetSuffix field value

func (*UsComponents) GetStreetSuffixOk 

func (o *UsComponents) GetStreetSuffixOk() (*string, bool)

GetStreetSuffixOk returns a tuple with the StreetSuffix field value and a boolean to check if the value has been set.

func (*UsComponents) GetZipCode 

func (o *UsComponents) GetZipCode() string

GetZipCode returns the ZipCode field value

func (*UsComponents) GetZipCodeOk 

func (o *UsComponents) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value and a boolean to check if the value has been set.

func (*UsComponents) GetZipCodePlus4 

func (o *UsComponents) GetZipCodePlus4() string

GetZipCodePlus4 returns the ZipCodePlus4 field value

func (*UsComponents) GetZipCodePlus4Ok 

func (o *UsComponents) GetZipCodePlus4Ok() (*string, bool)

GetZipCodePlus4Ok returns a tuple with the ZipCodePlus4 field value and a boolean to check if the value has been set.

func (*UsComponents) GetZipCodeType 

func (o *UsComponents) GetZipCodeType() ZipCodeType

GetZipCodeType returns the ZipCodeType field value

func (*UsComponents) GetZipCodeTypeOk 

func (o *UsComponents) GetZipCodeTypeOk() (*ZipCodeType, bool)

GetZipCodeTypeOk returns a tuple with the ZipCodeType field value and a boolean to check if the value has been set.

func (*UsComponents) HasLatitude 

func (o *UsComponents) HasLatitude() bool

HasLatitude returns a boolean if a field has been set.

func (*UsComponents) HasLongitude 

func (o *UsComponents) HasLongitude() bool

HasLongitude returns a boolean if a field has been set.

func (UsComponents) MarshalJSON 

func (o UsComponents) MarshalJSON() ([]byte, error)

func (*UsComponents) SetAddressType 

func (o *UsComponents) SetAddressType(v string)

SetAddressType sets field value

func (*UsComponents) SetCarrierRoute 

func (o *UsComponents) SetCarrierRoute(v string)

SetCarrierRoute sets field value

func (*UsComponents) SetCarrierRouteType 

func (o *UsComponents) SetCarrierRouteType(v string)

SetCarrierRouteType sets field value

func (*UsComponents) SetCity 

func (o *UsComponents) SetCity(v string)

SetCity sets field value

func (*UsComponents) SetCounty 

func (o *UsComponents) SetCounty(v string)

SetCounty sets field value

func (*UsComponents) SetCountyFips 

func (o *UsComponents) SetCountyFips(v string)

SetCountyFips sets field value

func (*UsComponents) SetDefaultBuildingAddress 

func (o *UsComponents) SetDefaultBuildingAddress(v bool)

SetDefaultBuildingAddress sets field value

func (*UsComponents) SetDeliveryPointBarcode 

func (o *UsComponents) SetDeliveryPointBarcode(v string)

SetDeliveryPointBarcode sets field value

func (*UsComponents) SetExtraSecondaryDesignator 

func (o *UsComponents) SetExtraSecondaryDesignator(v string)

SetExtraSecondaryDesignator sets field value

func (*UsComponents) SetExtraSecondaryNumber 

func (o *UsComponents) SetExtraSecondaryNumber(v string)

SetExtraSecondaryNumber sets field value

func (*UsComponents) SetLatitude 

func (o *UsComponents) SetLatitude(v float32)

SetLatitude gets a reference to the given NullableFloat32 and assigns it to the Latitude field.

func (*UsComponents) SetLatitudeNil 

func (o *UsComponents) SetLatitudeNil()

SetLatitudeNil sets the value for Latitude to be an explicit nil

func (*UsComponents) SetLongitude 

func (o *UsComponents) SetLongitude(v float32)

SetLongitude gets a reference to the given NullableFloat32 and assigns it to the Longitude field.

func (*UsComponents) SetLongitudeNil 

func (o *UsComponents) SetLongitudeNil()

SetLongitudeNil sets the value for Longitude to be an explicit nil

func (*UsComponents) SetPmbDesignator 

func (o *UsComponents) SetPmbDesignator(v string)

SetPmbDesignator sets field value

func (*UsComponents) SetPmbNumber 

func (o *UsComponents) SetPmbNumber(v string)

SetPmbNumber sets field value

func (*UsComponents) SetPoBoxOnlyFlag added in v1.1.0 

func (o *UsComponents) SetPoBoxOnlyFlag(v string)

SetPoBoxOnlyFlag sets field value

func (*UsComponents) SetPrimaryNumber 

func (o *UsComponents) SetPrimaryNumber(v string)

SetPrimaryNumber sets field value

func (*UsComponents) SetRecordType 

func (o *UsComponents) SetRecordType(v string)

SetRecordType sets field value

func (*UsComponents) SetSecondaryDesignator 

func (o *UsComponents) SetSecondaryDesignator(v string)

SetSecondaryDesignator sets field value

func (*UsComponents) SetSecondaryNumber 

func (o *UsComponents) SetSecondaryNumber(v string)

SetSecondaryNumber sets field value

func (*UsComponents) SetState 

func (o *UsComponents) SetState(v string)

SetState sets field value

func (*UsComponents) SetStreetName 

func (o *UsComponents) SetStreetName(v string)

SetStreetName sets field value

func (*UsComponents) SetStreetPostdirection 

func (o *UsComponents) SetStreetPostdirection(v string)

SetStreetPostdirection sets field value

func (*UsComponents) SetStreetPredirection 

func (o *UsComponents) SetStreetPredirection(v string)

SetStreetPredirection sets field value

func (*UsComponents) SetStreetSuffix 

func (o *UsComponents) SetStreetSuffix(v string)

SetStreetSuffix sets field value

func (*UsComponents) SetZipCode 

func (o *UsComponents) SetZipCode(v string)

SetZipCode sets field value

func (*UsComponents) SetZipCodePlus4 

func (o *UsComponents) SetZipCodePlus4(v string)

SetZipCodePlus4 sets field value

func (*UsComponents) SetZipCodeType 

func (o *UsComponents) SetZipCodeType(v ZipCodeType)

SetZipCodeType sets field value

func (*UsComponents) UnsetLatitude 

func (o *UsComponents) UnsetLatitude()

UnsetLatitude ensures that no value is present for Latitude, not even an explicit nil

func (*UsComponents) UnsetLongitude 

func (o *UsComponents) UnsetLongitude()

UnsetLongitude ensures that no value is present for Longitude, not even an explicit nil

type UsVerification 

type UsVerification struct {
	// Unique identifier prefixed with `us_ver_`.
	Id *string `json:"id,omitempty"`
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine *string `json:"primary_line,omitempty"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	// Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
	Urbanization *string `json:"urbanization,omitempty"`
	// Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)
	LastLine *string `json:"last_line,omitempty"`
	// Summarizes the deliverability of the `us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building's default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * `deliverable_missing_unit` – The address is deliverable to the building's default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * `undeliverable` – The address is not deliverable according to the USPS.
	Deliverability *string `json:"deliverability,omitempty"`
	// This field indicates whether an address was found in a more comprehensive address dataset that includes sources from the USPS, open source mapping data, and our proprietary mail delivery data. This field can be interpreted as a representation of whether an address is a real location or not. Additionally a valid address may contradict the deliverability field since an address can be a real valid location but the USPS may not deliver to that address.
	ValidAddress           *bool                   `json:"valid_address,omitempty"`
	Components             *UsComponents           `json:"components,omitempty"`
	DeliverabilityAnalysis *DeliverabilityAnalysis `json:"deliverability_analysis,omitempty"`
	LobConfidenceScore     *LobConfidenceScore     `json:"lob_confidence_score,omitempty"`
	Object                 *string                 `json:"object,omitempty"`
	// ID that is returned in the response body for the verification
	TransientId *string `json:"transient_id,omitempty"`
}

UsVerification struct for UsVerification

func NewUsVerification 

func NewUsVerification() *UsVerification

NewUsVerification instantiates a new UsVerification object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsVerificationWithDefaults 

func NewUsVerificationWithDefaults() *UsVerification

NewUsVerificationWithDefaults instantiates a new UsVerification object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsVerification) GetComponents 

func (o *UsVerification) GetComponents() UsComponents

GetComponents returns the Components field value if set, zero value otherwise.

func (*UsVerification) GetComponentsOk 

func (o *UsVerification) GetComponentsOk() (*UsComponents, bool)

GetComponentsOk returns a tuple with the Components field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetDeliverability 

func (o *UsVerification) GetDeliverability() string

GetDeliverability returns the Deliverability field value if set, zero value otherwise.

func (*UsVerification) GetDeliverabilityAnalysis 

func (o *UsVerification) GetDeliverabilityAnalysis() DeliverabilityAnalysis

GetDeliverabilityAnalysis returns the DeliverabilityAnalysis field value if set, zero value otherwise.

func (*UsVerification) GetDeliverabilityAnalysisOk 

func (o *UsVerification) GetDeliverabilityAnalysisOk() (*DeliverabilityAnalysis, bool)

GetDeliverabilityAnalysisOk returns a tuple with the DeliverabilityAnalysis field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetDeliverabilityOk 

func (o *UsVerification) GetDeliverabilityOk() (*string, bool)

GetDeliverabilityOk returns a tuple with the Deliverability field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetId 

func (o *UsVerification) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*UsVerification) GetIdOk 

func (o *UsVerification) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetLastLine 

func (o *UsVerification) GetLastLine() string

GetLastLine returns the LastLine field value if set, zero value otherwise.

func (*UsVerification) GetLastLineOk 

func (o *UsVerification) GetLastLineOk() (*string, bool)

GetLastLineOk returns a tuple with the LastLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetLobConfidenceScore 

func (o *UsVerification) GetLobConfidenceScore() LobConfidenceScore

GetLobConfidenceScore returns the LobConfidenceScore field value if set, zero value otherwise.

func (*UsVerification) GetLobConfidenceScoreOk 

func (o *UsVerification) GetLobConfidenceScoreOk() (*LobConfidenceScore, bool)

GetLobConfidenceScoreOk returns a tuple with the LobConfidenceScore field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetObject 

func (o *UsVerification) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*UsVerification) GetObjectOk 

func (o *UsVerification) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetPrimaryLine 

func (o *UsVerification) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value if set, zero value otherwise.

func (*UsVerification) GetPrimaryLineOk 

func (o *UsVerification) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetRecipient 

func (o *UsVerification) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*UsVerification) GetRecipientOk 

func (o *UsVerification) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*UsVerification) GetSecondaryLine 

func (o *UsVerification) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*UsVerification) GetSecondaryLineOk 

func (o *UsVerification) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetTransientId added in v1.1.1 

func (o *UsVerification) GetTransientId() string

GetTransientId returns the TransientId field value if set, zero value otherwise.

func (*UsVerification) GetTransientIdOk added in v1.1.1 

func (o *UsVerification) GetTransientIdOk() (*string, bool)

GetTransientIdOk returns a tuple with the TransientId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetUrbanization 

func (o *UsVerification) GetUrbanization() string

GetUrbanization returns the Urbanization field value if set, zero value otherwise.

func (*UsVerification) GetUrbanizationOk 

func (o *UsVerification) GetUrbanizationOk() (*string, bool)

GetUrbanizationOk returns a tuple with the Urbanization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) GetValidAddress 

func (o *UsVerification) GetValidAddress() bool

GetValidAddress returns the ValidAddress field value if set, zero value otherwise.

func (*UsVerification) GetValidAddressOk 

func (o *UsVerification) GetValidAddressOk() (*bool, bool)

GetValidAddressOk returns a tuple with the ValidAddress field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerification) HasComponents 

func (o *UsVerification) HasComponents() bool

HasComponents returns a boolean if a field has been set.

func (*UsVerification) HasDeliverability 

func (o *UsVerification) HasDeliverability() bool

HasDeliverability returns a boolean if a field has been set.

func (*UsVerification) HasDeliverabilityAnalysis 

func (o *UsVerification) HasDeliverabilityAnalysis() bool

HasDeliverabilityAnalysis returns a boolean if a field has been set.

func (*UsVerification) HasId 

func (o *UsVerification) HasId() bool

HasId returns a boolean if a field has been set.

func (*UsVerification) HasLastLine 

func (o *UsVerification) HasLastLine() bool

HasLastLine returns a boolean if a field has been set.

func (*UsVerification) HasLobConfidenceScore 

func (o *UsVerification) HasLobConfidenceScore() bool

HasLobConfidenceScore returns a boolean if a field has been set.

func (*UsVerification) HasObject 

func (o *UsVerification) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*UsVerification) HasPrimaryLine 

func (o *UsVerification) HasPrimaryLine() bool

HasPrimaryLine returns a boolean if a field has been set.

func (*UsVerification) HasRecipient 

func (o *UsVerification) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*UsVerification) HasSecondaryLine 

func (o *UsVerification) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*UsVerification) HasTransientId added in v1.1.1 

func (o *UsVerification) HasTransientId() bool

HasTransientId returns a boolean if a field has been set.

func (*UsVerification) HasUrbanization 

func (o *UsVerification) HasUrbanization() bool

HasUrbanization returns a boolean if a field has been set.

func (*UsVerification) HasValidAddress 

func (o *UsVerification) HasValidAddress() bool

HasValidAddress returns a boolean if a field has been set.

func (UsVerification) MarshalJSON 

func (o UsVerification) MarshalJSON() ([]byte, error)

func (*UsVerification) SetComponents 

func (o *UsVerification) SetComponents(v UsComponents)

SetComponents gets a reference to the given UsComponents and assigns it to the Components field.

func (*UsVerification) SetDeliverability 

func (o *UsVerification) SetDeliverability(v string)

SetDeliverability gets a reference to the given string and assigns it to the Deliverability field.

func (*UsVerification) SetDeliverabilityAnalysis 

func (o *UsVerification) SetDeliverabilityAnalysis(v DeliverabilityAnalysis)

SetDeliverabilityAnalysis gets a reference to the given DeliverabilityAnalysis and assigns it to the DeliverabilityAnalysis field.

func (*UsVerification) SetId 

func (o *UsVerification) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*UsVerification) SetLastLine 

func (o *UsVerification) SetLastLine(v string)

SetLastLine gets a reference to the given string and assigns it to the LastLine field.

func (*UsVerification) SetLobConfidenceScore 

func (o *UsVerification) SetLobConfidenceScore(v LobConfidenceScore)

SetLobConfidenceScore gets a reference to the given LobConfidenceScore and assigns it to the LobConfidenceScore field.

func (*UsVerification) SetObject 

func (o *UsVerification) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*UsVerification) SetPrimaryLine 

func (o *UsVerification) SetPrimaryLine(v string)

SetPrimaryLine gets a reference to the given string and assigns it to the PrimaryLine field.

func (*UsVerification) SetRecipient 

func (o *UsVerification) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*UsVerification) SetRecipientNil 

func (o *UsVerification) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*UsVerification) SetSecondaryLine 

func (o *UsVerification) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*UsVerification) SetTransientId added in v1.1.1 

func (o *UsVerification) SetTransientId(v string)

SetTransientId gets a reference to the given string and assigns it to the TransientId field.

func (*UsVerification) SetUrbanization 

func (o *UsVerification) SetUrbanization(v string)

SetUrbanization gets a reference to the given string and assigns it to the Urbanization field.

func (*UsVerification) SetValidAddress 

func (o *UsVerification) SetValidAddress(v bool)

SetValidAddress gets a reference to the given bool and assigns it to the ValidAddress field.

func (*UsVerification) UnsetRecipient 

func (o *UsVerification) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type UsVerificationOrError 

type UsVerificationOrError struct {
	// Unique identifier prefixed with `us_ver_`.
	Id *string `json:"id,omitempty"`
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine *string `json:"primary_line,omitempty"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	// Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
	Urbanization           *string                 `json:"urbanization,omitempty"`
	LastLine               *string                 `json:"last_line,omitempty"`
	Deliverability         *string                 `json:"deliverability,omitempty"`
	Components             *UsComponents           `json:"components,omitempty"`
	DeliverabilityAnalysis *DeliverabilityAnalysis `json:"deliverability_analysis,omitempty"`
	LobConfidenceScore     *LobConfidenceScore     `json:"lob_confidence_score,omitempty"`
	Object                 *string                 `json:"object,omitempty"`
	// ID that is returned in the response body for the verification
	TransientId *string    `json:"transient_id,omitempty"`
	Error       *BulkError `json:"error,omitempty"`
}

UsVerificationOrError A model used to represent an entry in a result list where the entry can either be a us_verification or an Error. The SDK will perform necessary casting into the correct corresponding type.

func NewUsVerificationOrError 

func NewUsVerificationOrError() *UsVerificationOrError

NewUsVerificationOrError instantiates a new UsVerificationOrError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsVerificationOrErrorWithDefaults 

func NewUsVerificationOrErrorWithDefaults() *UsVerificationOrError

NewUsVerificationOrErrorWithDefaults instantiates a new UsVerificationOrError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsVerificationOrError) GetComponents 

func (o *UsVerificationOrError) GetComponents() UsComponents

GetComponents returns the Components field value if set, zero value otherwise.

func (*UsVerificationOrError) GetComponentsOk 

func (o *UsVerificationOrError) GetComponentsOk() (*UsComponents, bool)

GetComponentsOk returns a tuple with the Components field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetDeliverability 

func (o *UsVerificationOrError) GetDeliverability() string

GetDeliverability returns the Deliverability field value if set, zero value otherwise.

func (*UsVerificationOrError) GetDeliverabilityAnalysis 

func (o *UsVerificationOrError) GetDeliverabilityAnalysis() DeliverabilityAnalysis

GetDeliverabilityAnalysis returns the DeliverabilityAnalysis field value if set, zero value otherwise.

func (*UsVerificationOrError) GetDeliverabilityAnalysisOk 

func (o *UsVerificationOrError) GetDeliverabilityAnalysisOk() (*DeliverabilityAnalysis, bool)

GetDeliverabilityAnalysisOk returns a tuple with the DeliverabilityAnalysis field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetDeliverabilityOk 

func (o *UsVerificationOrError) GetDeliverabilityOk() (*string, bool)

GetDeliverabilityOk returns a tuple with the Deliverability field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetError 

func (o *UsVerificationOrError) GetError() BulkError

GetError returns the Error field value if set, zero value otherwise.

func (*UsVerificationOrError) GetErrorOk 

func (o *UsVerificationOrError) GetErrorOk() (*BulkError, bool)

GetErrorOk returns a tuple with the Error field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetId 

func (o *UsVerificationOrError) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*UsVerificationOrError) GetIdOk 

func (o *UsVerificationOrError) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetLastLine 

func (o *UsVerificationOrError) GetLastLine() string

GetLastLine returns the LastLine field value if set, zero value otherwise.

func (*UsVerificationOrError) GetLastLineOk 

func (o *UsVerificationOrError) GetLastLineOk() (*string, bool)

GetLastLineOk returns a tuple with the LastLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetLobConfidenceScore 

func (o *UsVerificationOrError) GetLobConfidenceScore() LobConfidenceScore

GetLobConfidenceScore returns the LobConfidenceScore field value if set, zero value otherwise.

func (*UsVerificationOrError) GetLobConfidenceScoreOk 

func (o *UsVerificationOrError) GetLobConfidenceScoreOk() (*LobConfidenceScore, bool)

GetLobConfidenceScoreOk returns a tuple with the LobConfidenceScore field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetObject 

func (o *UsVerificationOrError) GetObject() string

GetObject returns the Object field value if set, zero value otherwise.

func (*UsVerificationOrError) GetObjectOk 

func (o *UsVerificationOrError) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetPrimaryLine 

func (o *UsVerificationOrError) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value if set, zero value otherwise.

func (*UsVerificationOrError) GetPrimaryLineOk 

func (o *UsVerificationOrError) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetRecipient 

func (o *UsVerificationOrError) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*UsVerificationOrError) GetRecipientOk 

func (o *UsVerificationOrError) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*UsVerificationOrError) GetSecondaryLine 

func (o *UsVerificationOrError) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*UsVerificationOrError) GetSecondaryLineOk 

func (o *UsVerificationOrError) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetTransientId added in v1.1.1 

func (o *UsVerificationOrError) GetTransientId() string

GetTransientId returns the TransientId field value if set, zero value otherwise.

func (*UsVerificationOrError) GetTransientIdOk added in v1.1.1 

func (o *UsVerificationOrError) GetTransientIdOk() (*string, bool)

GetTransientIdOk returns a tuple with the TransientId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) GetUrbanization 

func (o *UsVerificationOrError) GetUrbanization() string

GetUrbanization returns the Urbanization field value if set, zero value otherwise.

func (*UsVerificationOrError) GetUrbanizationOk 

func (o *UsVerificationOrError) GetUrbanizationOk() (*string, bool)

GetUrbanizationOk returns a tuple with the Urbanization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationOrError) HasComponents 

func (o *UsVerificationOrError) HasComponents() bool

HasComponents returns a boolean if a field has been set.

func (*UsVerificationOrError) HasDeliverability 

func (o *UsVerificationOrError) HasDeliverability() bool

HasDeliverability returns a boolean if a field has been set.

func (*UsVerificationOrError) HasDeliverabilityAnalysis 

func (o *UsVerificationOrError) HasDeliverabilityAnalysis() bool

HasDeliverabilityAnalysis returns a boolean if a field has been set.

func (*UsVerificationOrError) HasError 

func (o *UsVerificationOrError) HasError() bool

HasError returns a boolean if a field has been set.

func (*UsVerificationOrError) HasId 

func (o *UsVerificationOrError) HasId() bool

HasId returns a boolean if a field has been set.

func (*UsVerificationOrError) HasLastLine 

func (o *UsVerificationOrError) HasLastLine() bool

HasLastLine returns a boolean if a field has been set.

func (*UsVerificationOrError) HasLobConfidenceScore 

func (o *UsVerificationOrError) HasLobConfidenceScore() bool

HasLobConfidenceScore returns a boolean if a field has been set.

func (*UsVerificationOrError) HasObject 

func (o *UsVerificationOrError) HasObject() bool

HasObject returns a boolean if a field has been set.

func (*UsVerificationOrError) HasPrimaryLine 

func (o *UsVerificationOrError) HasPrimaryLine() bool

HasPrimaryLine returns a boolean if a field has been set.

func (*UsVerificationOrError) HasRecipient 

func (o *UsVerificationOrError) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*UsVerificationOrError) HasSecondaryLine 

func (o *UsVerificationOrError) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*UsVerificationOrError) HasTransientId added in v1.1.1 

func (o *UsVerificationOrError) HasTransientId() bool

HasTransientId returns a boolean if a field has been set.

func (*UsVerificationOrError) HasUrbanization 

func (o *UsVerificationOrError) HasUrbanization() bool

HasUrbanization returns a boolean if a field has been set.

func (UsVerificationOrError) MarshalJSON 

func (o UsVerificationOrError) MarshalJSON() ([]byte, error)

func (*UsVerificationOrError) SetComponents 

func (o *UsVerificationOrError) SetComponents(v UsComponents)

SetComponents gets a reference to the given UsComponents and assigns it to the Components field.

func (*UsVerificationOrError) SetDeliverability 

func (o *UsVerificationOrError) SetDeliverability(v string)

SetDeliverability gets a reference to the given string and assigns it to the Deliverability field.

func (*UsVerificationOrError) SetDeliverabilityAnalysis 

func (o *UsVerificationOrError) SetDeliverabilityAnalysis(v DeliverabilityAnalysis)

SetDeliverabilityAnalysis gets a reference to the given DeliverabilityAnalysis and assigns it to the DeliverabilityAnalysis field.

func (*UsVerificationOrError) SetError 

func (o *UsVerificationOrError) SetError(v BulkError)

SetError gets a reference to the given BulkError and assigns it to the Error field.

func (*UsVerificationOrError) SetId 

func (o *UsVerificationOrError) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*UsVerificationOrError) SetLastLine 

func (o *UsVerificationOrError) SetLastLine(v string)

SetLastLine gets a reference to the given string and assigns it to the LastLine field.

func (*UsVerificationOrError) SetLobConfidenceScore 

func (o *UsVerificationOrError) SetLobConfidenceScore(v LobConfidenceScore)

SetLobConfidenceScore gets a reference to the given LobConfidenceScore and assigns it to the LobConfidenceScore field.

func (*UsVerificationOrError) SetObject 

func (o *UsVerificationOrError) SetObject(v string)

SetObject gets a reference to the given string and assigns it to the Object field.

func (*UsVerificationOrError) SetPrimaryLine 

func (o *UsVerificationOrError) SetPrimaryLine(v string)

SetPrimaryLine gets a reference to the given string and assigns it to the PrimaryLine field.

func (*UsVerificationOrError) SetRecipient 

func (o *UsVerificationOrError) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*UsVerificationOrError) SetRecipientNil 

func (o *UsVerificationOrError) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*UsVerificationOrError) SetSecondaryLine 

func (o *UsVerificationOrError) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*UsVerificationOrError) SetTransientId added in v1.1.1 

func (o *UsVerificationOrError) SetTransientId(v string)

SetTransientId gets a reference to the given string and assigns it to the TransientId field.

func (*UsVerificationOrError) SetUrbanization 

func (o *UsVerificationOrError) SetUrbanization(v string)

SetUrbanization gets a reference to the given string and assigns it to the Urbanization field.

func (*UsVerificationOrError) UnsetRecipient 

func (o *UsVerificationOrError) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type UsVerifications 

type UsVerifications struct {
	Addresses []UsVerificationOrError `json:"addresses"`
	// Indicates whether any errors occurred during the verification process.
	Errors bool `json:"errors"`
}

UsVerifications struct for UsVerifications

func NewUsVerifications 

func NewUsVerifications(addresses []UsVerificationOrError, errors bool) *UsVerifications

NewUsVerifications instantiates a new UsVerifications object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsVerificationsWithDefaults 

func NewUsVerificationsWithDefaults() *UsVerifications

NewUsVerificationsWithDefaults instantiates a new UsVerifications object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsVerifications) GetAddresses 

func (o *UsVerifications) GetAddresses() []UsVerificationOrError

GetAddresses returns the Addresses field value

func (*UsVerifications) GetAddressesOk 

func (o *UsVerifications) GetAddressesOk() ([]UsVerificationOrError, bool)

GetAddressesOk returns a tuple with the Addresses field value and a boolean to check if the value has been set.

func (*UsVerifications) GetErrors 

func (o *UsVerifications) GetErrors() bool

GetErrors returns the Errors field value

func (*UsVerifications) GetErrorsOk 

func (o *UsVerifications) GetErrorsOk() (*bool, bool)

GetErrorsOk returns a tuple with the Errors field value and a boolean to check if the value has been set.

func (UsVerifications) MarshalJSON 

func (o UsVerifications) MarshalJSON() ([]byte, error)

func (*UsVerifications) SetAddresses 

func (o *UsVerifications) SetAddresses(v []UsVerificationOrError)

SetAddresses sets field value

func (*UsVerifications) SetErrors 

func (o *UsVerifications) SetErrors(v bool)

SetErrors sets field value

type UsVerificationsApiService 

type UsVerificationsApiService service

UsVerificationsApiService UsVerificationsApi service

func (*UsVerificationsApiService) BulkUsVerificationsExecute 

func (a *UsVerificationsApiService) BulkUsVerificationsExecute(r ApiBulkUsVerificationsRequest) (*UsVerifications, *http.Response, error)

Execute executes the request 

@return UsVerifications

func (*UsVerificationsApiService) UsVerificationExecute 

func (a *UsVerificationsApiService) UsVerificationExecute(r ApiUsVerificationRequest) (*UsVerification, *http.Response, error)

Execute executes the request 

@return UsVerification

func (*UsVerificationsApiService) VerifyBulk 

func (a *UsVerificationsApiService) VerifyBulk(ctx context.Context) ApiBulkUsVerificationsRequest

BulkUsVerifications verifyBulk

Verify a list of US or US territory addresses with a live API key. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiBulkUsVerificationsRequest

func (*UsVerificationsApiService) VerifySingle 

func (a *UsVerificationsApiService) VerifySingle(ctx context.Context) ApiUsVerificationRequest

UsVerification verifySingle

Verify a US or US territory address with a live API key. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiUsVerificationRequest

type UsVerificationsWritable 

type UsVerificationsWritable struct {
	// The entire address in one string (e.g., \"2261 Market Street 94114\"). _Does not support a recipient and will error when other payload parameters are provided._
	Address *string `json:"address,omitempty"`
	// The intended recipient, typically a person's or firm's name.
	Recipient NullableString `json:"recipient,omitempty"`
	// The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
	PrimaryLine *string `json:"primary_line,omitempty"`
	// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
	SecondaryLine *string `json:"secondary_line,omitempty"`
	// Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
	Urbanization *string `json:"urbanization,omitempty"`
	City         *string `json:"city,omitempty"`
	// The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.
	State *string `json:"state,omitempty"`
	// Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`).
	ZipCode *string `json:"zip_code,omitempty"`
	// ID that is returned in the response body for the verification
	TransientId *string `json:"transient_id,omitempty"`
}

UsVerificationsWritable struct for UsVerificationsWritable

func NewUsVerificationsWritable 

func NewUsVerificationsWritable() *UsVerificationsWritable

NewUsVerificationsWritable instantiates a new UsVerificationsWritable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsVerificationsWritableWithDefaults 

func NewUsVerificationsWritableWithDefaults() *UsVerificationsWritable

NewUsVerificationsWritableWithDefaults instantiates a new UsVerificationsWritable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsVerificationsWritable) GetAddress 

func (o *UsVerificationsWritable) GetAddress() string

GetAddress returns the Address field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetAddressOk 

func (o *UsVerificationsWritable) GetAddressOk() (*string, bool)

GetAddressOk returns a tuple with the Address field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) GetCity 

func (o *UsVerificationsWritable) GetCity() string

GetCity returns the City field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetCityOk 

func (o *UsVerificationsWritable) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) GetPrimaryLine 

func (o *UsVerificationsWritable) GetPrimaryLine() string

GetPrimaryLine returns the PrimaryLine field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetPrimaryLineOk 

func (o *UsVerificationsWritable) GetPrimaryLineOk() (*string, bool)

GetPrimaryLineOk returns a tuple with the PrimaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) GetRecipient 

func (o *UsVerificationsWritable) GetRecipient() string

GetRecipient returns the Recipient field value if set, zero value otherwise (both if not set or set to explicit null).

func (*UsVerificationsWritable) GetRecipientOk 

func (o *UsVerificationsWritable) GetRecipientOk() (*string, bool)

GetRecipientOk returns a tuple with the Recipient field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*UsVerificationsWritable) GetSecondaryLine 

func (o *UsVerificationsWritable) GetSecondaryLine() string

GetSecondaryLine returns the SecondaryLine field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetSecondaryLineOk 

func (o *UsVerificationsWritable) GetSecondaryLineOk() (*string, bool)

GetSecondaryLineOk returns a tuple with the SecondaryLine field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) GetState 

func (o *UsVerificationsWritable) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetStateOk 

func (o *UsVerificationsWritable) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) GetTransientId added in v1.1.1 

func (o *UsVerificationsWritable) GetTransientId() string

GetTransientId returns the TransientId field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetTransientIdOk added in v1.1.1 

func (o *UsVerificationsWritable) GetTransientIdOk() (*string, bool)

GetTransientIdOk returns a tuple with the TransientId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) GetUrbanization 

func (o *UsVerificationsWritable) GetUrbanization() string

GetUrbanization returns the Urbanization field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetUrbanizationOk 

func (o *UsVerificationsWritable) GetUrbanizationOk() (*string, bool)

GetUrbanizationOk returns a tuple with the Urbanization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) GetZipCode 

func (o *UsVerificationsWritable) GetZipCode() string

GetZipCode returns the ZipCode field value if set, zero value otherwise.

func (*UsVerificationsWritable) GetZipCodeOk 

func (o *UsVerificationsWritable) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsVerificationsWritable) HasAddress 

func (o *UsVerificationsWritable) HasAddress() bool

HasAddress returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasCity 

func (o *UsVerificationsWritable) HasCity() bool

HasCity returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasPrimaryLine 

func (o *UsVerificationsWritable) HasPrimaryLine() bool

HasPrimaryLine returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasRecipient 

func (o *UsVerificationsWritable) HasRecipient() bool

HasRecipient returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasSecondaryLine 

func (o *UsVerificationsWritable) HasSecondaryLine() bool

HasSecondaryLine returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasState 

func (o *UsVerificationsWritable) HasState() bool

HasState returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasTransientId added in v1.1.1 

func (o *UsVerificationsWritable) HasTransientId() bool

HasTransientId returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasUrbanization 

func (o *UsVerificationsWritable) HasUrbanization() bool

HasUrbanization returns a boolean if a field has been set.

func (*UsVerificationsWritable) HasZipCode 

func (o *UsVerificationsWritable) HasZipCode() bool

HasZipCode returns a boolean if a field has been set.

func (UsVerificationsWritable) MarshalJSON 

func (o UsVerificationsWritable) MarshalJSON() ([]byte, error)

func (*UsVerificationsWritable) SetAddress 

func (o *UsVerificationsWritable) SetAddress(v string)

SetAddress gets a reference to the given string and assigns it to the Address field.

func (*UsVerificationsWritable) SetCity 

func (o *UsVerificationsWritable) SetCity(v string)

SetCity gets a reference to the given string and assigns it to the City field.

func (*UsVerificationsWritable) SetPrimaryLine 

func (o *UsVerificationsWritable) SetPrimaryLine(v string)

SetPrimaryLine gets a reference to the given string and assigns it to the PrimaryLine field.

func (*UsVerificationsWritable) SetRecipient 

func (o *UsVerificationsWritable) SetRecipient(v string)

SetRecipient gets a reference to the given NullableString and assigns it to the Recipient field.

func (*UsVerificationsWritable) SetRecipientNil 

func (o *UsVerificationsWritable) SetRecipientNil()

SetRecipientNil sets the value for Recipient to be an explicit nil

func (*UsVerificationsWritable) SetSecondaryLine 

func (o *UsVerificationsWritable) SetSecondaryLine(v string)

SetSecondaryLine gets a reference to the given string and assigns it to the SecondaryLine field.

func (*UsVerificationsWritable) SetState 

func (o *UsVerificationsWritable) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

func (*UsVerificationsWritable) SetTransientId added in v1.1.1 

func (o *UsVerificationsWritable) SetTransientId(v string)

SetTransientId gets a reference to the given string and assigns it to the TransientId field.

func (*UsVerificationsWritable) SetUrbanization 

func (o *UsVerificationsWritable) SetUrbanization(v string)

SetUrbanization gets a reference to the given string and assigns it to the Urbanization field.

func (*UsVerificationsWritable) SetZipCode 

func (o *UsVerificationsWritable) SetZipCode(v string)

SetZipCode gets a reference to the given string and assigns it to the ZipCode field.

func (*UsVerificationsWritable) UnsetRecipient 

func (o *UsVerificationsWritable) UnsetRecipient()

UnsetRecipient ensures that no value is present for Recipient, not even an explicit nil

type Zip 

type Zip struct {
	// A 5-digit ZIP code.
	ZipCode *string `json:"zip_code,omitempty"`
	// Unique identifier prefixed with `us_zip_`.
	Id string `json:"id"`
	// An array of city objects containing valid cities for the `zip_code`. Multiple cities will be returned if more than one city is associated with the input ZIP code.
	Cities      []ZipLookupCity `json:"cities"`
	ZipCodeType ZipCodeType     `json:"zip_code_type"`
	Object      string          `json:"object"`
}

Zip struct for Zip

func NewZip 

func NewZip(id string, cities []ZipLookupCity, zipCodeType ZipCodeType, object string) *Zip

NewZip instantiates a new Zip object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewZipWithDefaults 

func NewZipWithDefaults() *Zip

NewZipWithDefaults instantiates a new Zip object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Zip) GetCities 

func (o *Zip) GetCities() []ZipLookupCity

GetCities returns the Cities field value

func (*Zip) GetCitiesOk 

func (o *Zip) GetCitiesOk() ([]ZipLookupCity, bool)

GetCitiesOk returns a tuple with the Cities field value and a boolean to check if the value has been set.

func (*Zip) GetId 

func (o *Zip) GetId() string

GetId returns the Id field value

func (*Zip) GetIdOk 

func (o *Zip) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Zip) GetObject 

func (o *Zip) GetObject() string

GetObject returns the Object field value

func (*Zip) GetObjectOk 

func (o *Zip) GetObjectOk() (*string, bool)

GetObjectOk returns a tuple with the Object field value and a boolean to check if the value has been set.

func (*Zip) GetZipCode 

func (o *Zip) GetZipCode() string

GetZipCode returns the ZipCode field value if set, zero value otherwise.

func (*Zip) GetZipCodeOk 

func (o *Zip) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Zip) GetZipCodeType 

func (o *Zip) GetZipCodeType() ZipCodeType

GetZipCodeType returns the ZipCodeType field value

func (*Zip) GetZipCodeTypeOk 

func (o *Zip) GetZipCodeTypeOk() (*ZipCodeType, bool)

GetZipCodeTypeOk returns a tuple with the ZipCodeType field value and a boolean to check if the value has been set.

func (*Zip) HasZipCode 

func (o *Zip) HasZipCode() bool

HasZipCode returns a boolean if a field has been set.

func (Zip) MarshalJSON 

func (o Zip) MarshalJSON() ([]byte, error)

func (*Zip) SetCities 

func (o *Zip) SetCities(v []ZipLookupCity)

SetCities sets field value

func (*Zip) SetId 

func (o *Zip) SetId(v string)

SetId sets field value

func (*Zip) SetObject 

func (o *Zip) SetObject(v string)

SetObject sets field value

func (*Zip) SetZipCode 

func (o *Zip) SetZipCode(v string)

SetZipCode gets a reference to the given string and assigns it to the ZipCode field.

func (*Zip) SetZipCodeType 

func (o *Zip) SetZipCodeType(v ZipCodeType)

SetZipCodeType sets field value

type ZipCodeType 

type ZipCodeType string

ZipCodeType A description of the ZIP code type. For more detailed information about each ZIP code type, see [US Verification Details](#tag/US-Verification-Types). 

const (
	ZIPCODETYPE_STANDARD ZipCodeType = "standard"
	ZIPCODETYPE_PO_BOX   ZipCodeType = "po_box"
	ZIPCODETYPE_UNIQUE   ZipCodeType = "unique"
	ZIPCODETYPE_MILITARY ZipCodeType = "military"
	ZIPCODETYPE_EMPTY    ZipCodeType = ""
)

List of zip_code_type

func NewZipCodeTypeFromValue 

func NewZipCodeTypeFromValue(v string) (*ZipCodeType, error)

NewZipCodeTypeFromValue returns a pointer to a valid ZipCodeType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (ZipCodeType) IsValid 

func (v ZipCodeType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (ZipCodeType) Ptr 

func (v ZipCodeType) Ptr() *ZipCodeType

Ptr returns reference to zip_code_type value

func (*ZipCodeType) UnmarshalJSON 

func (v *ZipCodeType) UnmarshalJSON(src []byte) error

type ZipEditable 

type ZipEditable struct {
	// A 5-digit ZIP code.
	ZipCode *string `json:"zip_code,omitempty"`
}

ZipEditable struct for ZipEditable

func NewZipEditable 

func NewZipEditable() *ZipEditable

NewZipEditable instantiates a new ZipEditable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewZipEditableWithDefaults 

func NewZipEditableWithDefaults() *ZipEditable

NewZipEditableWithDefaults instantiates a new ZipEditable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ZipEditable) GetZipCode 

func (o *ZipEditable) GetZipCode() string

GetZipCode returns the ZipCode field value if set, zero value otherwise.

func (*ZipEditable) GetZipCodeOk 

func (o *ZipEditable) GetZipCodeOk() (*string, bool)

GetZipCodeOk returns a tuple with the ZipCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ZipEditable) HasZipCode 

func (o *ZipEditable) HasZipCode() bool

HasZipCode returns a boolean if a field has been set.

func (ZipEditable) MarshalJSON 

func (o ZipEditable) MarshalJSON() ([]byte, error)

func (*ZipEditable) SetZipCode 

func (o *ZipEditable) SetZipCode(v string)

SetZipCode gets a reference to the given string and assigns it to the ZipCode field.

type ZipLookupCity 

type ZipLookupCity struct {
	City string `json:"city"`
	// The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.
	State string `json:"state"`
	// County name of the address city.
	County string `json:"county"`
	// A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code.
	CountyFips string `json:"county_fips"`
	// Indicates whether or not the city is the [USPS default city](https://en.wikipedia.org/wiki/ZIP_Code#ZIP_Codes_and_previous_zoning_lines) (preferred city) of a ZIP code. There is only one preferred city per ZIP code, which will always be in position 0 in the array of cities.
	Preferred bool `json:"preferred"`
}

ZipLookupCity struct for ZipLookupCity

func NewZipLookupCity 

func NewZipLookupCity(city string, state string, county string, countyFips string, preferred bool) *ZipLookupCity

NewZipLookupCity instantiates a new ZipLookupCity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewZipLookupCityWithDefaults 

func NewZipLookupCityWithDefaults() *ZipLookupCity

NewZipLookupCityWithDefaults instantiates a new ZipLookupCity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ZipLookupCity) GetCity 

func (o *ZipLookupCity) GetCity() string

GetCity returns the City field value

func (*ZipLookupCity) GetCityOk 

func (o *ZipLookupCity) GetCityOk() (*string, bool)

GetCityOk returns a tuple with the City field value and a boolean to check if the value has been set.

func (*ZipLookupCity) GetCounty 

func (o *ZipLookupCity) GetCounty() string

GetCounty returns the County field value

func (*ZipLookupCity) GetCountyFips 

func (o *ZipLookupCity) GetCountyFips() string

GetCountyFips returns the CountyFips field value

func (*ZipLookupCity) GetCountyFipsOk 

func (o *ZipLookupCity) GetCountyFipsOk() (*string, bool)

GetCountyFipsOk returns a tuple with the CountyFips field value and a boolean to check if the value has been set.

func (*ZipLookupCity) GetCountyOk 

func (o *ZipLookupCity) GetCountyOk() (*string, bool)

GetCountyOk returns a tuple with the County field value and a boolean to check if the value has been set.

func (*ZipLookupCity) GetPreferred 

func (o *ZipLookupCity) GetPreferred() bool

GetPreferred returns the Preferred field value

func (*ZipLookupCity) GetPreferredOk 

func (o *ZipLookupCity) GetPreferredOk() (*bool, bool)

GetPreferredOk returns a tuple with the Preferred field value and a boolean to check if the value has been set.

func (*ZipLookupCity) GetState 

func (o *ZipLookupCity) GetState() string

GetState returns the State field value

func (*ZipLookupCity) GetStateOk 

func (o *ZipLookupCity) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field value and a boolean to check if the value has been set.

func (ZipLookupCity) MarshalJSON 

func (o ZipLookupCity) MarshalJSON() ([]byte, error)

func (*ZipLookupCity) SetCity 

func (o *ZipLookupCity) SetCity(v string)

SetCity sets field value

func (*ZipLookupCity) SetCounty 

func (o *ZipLookupCity) SetCounty(v string)

SetCounty sets field value

func (*ZipLookupCity) SetCountyFips 

func (o *ZipLookupCity) SetCountyFips(v string)

SetCountyFips sets field value

func (*ZipLookupCity) SetPreferred 

func (o *ZipLookupCity) SetPreferred(v bool)

SetPreferred sets field value

func (*ZipLookupCity) SetState 

func (o *ZipLookupCity) SetState(v string)

SetState sets field value

type ZipLookupsApiService 

type ZipLookupsApiService service

ZipLookupsApiService ZipLookupsApi service

func (*ZipLookupsApiService) Lookup 

func (a *ZipLookupsApiService) Lookup(ctx context.Context) ApiZipLookupRequest

ZipLookup lookup

Returns information about a ZIP code 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiZipLookupRequest

func (*ZipLookupsApiService) ZipLookupExecute 

func (a *ZipLookupsApiService) ZipLookupExecute(r ApiZipLookupRequest) (*Zip, *http.Response, error)

Execute executes the request 

@return Zip

Source Files

View all Source files

Directories

Path Synopsis

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.