textgrid

package module

Go to main page

Versions in this module

v0

v0.8.0

May 28, 2024

Changes in this version

+ type OptInStatus struct

+ Action OptInStatusAction

+ Date string

+ Verb string

+ type OptInStatusAction string

+ var OptInStatusActionNothing OptInStatusAction = "nothing"

+ var OptInStatusActionOptedIn OptInStatusAction = "optedin"

+ var OptInStatusActionOptedOut OptInStatusAction = "optedout"

type TextGrid

+ GetOptInStatus func(to, from string) (*OptInStatus, error)

v0.7.0

May 7, 2024

Changes in this version

type TextGrid

+ GetCampaigns func() ([]Campaign, error)

v0.6.0

Sep 27, 2023

Changes in this version

+ type Message struct

+ APIVersion string

+ AccountSID string

+ Body string

+ CarrierNetwork string

+ DateCreated TextGridTime

+ DateSent TextGridTime

+ DateUpdated TextGridTime

+ Direction string

+ Email bool

+ From string

+ MessageClass string

+ NumMedia string

+ NumSegments string

+ Price string

+ PriceUnit string

+ SID string

+ Status string

+ SubresourceUris MessageSubresourceUri

+ Surcharge string

+ To string

+ URI string

+ type MessageSubresourceUri struct

+ Media string

type TextGrid

+ GetMessage func(id string) (*Message, error)

v0.5.0

Sep 27, 2023

Changes in this version

type IncomingMessage

+ MediaContentType0 string

+ MediaContentType1 string

+ MediaContentType2 string

+ MediaContentType3 string

+ MediaUrl0 string

+ MediaUrl1 string

+ MediaUrl2 string

+ MediaUrl3 string

v0.4.0

Sep 15, 2023

Changes in this version

+ var ErrNumberNotFound = errors.New("number not found")

+ type CallerName struct

+ CallerName string

+ CallerType CallerType

+ type CallerType string

+ var CallerTypeBlank CallerType = ""

+ var CallerTypeBusiness CallerType = "BUSINESS"

+ var CallerTypeConsumer CallerType = "CONSUMER"

+ type Carrier struct

+ MobileCountryCode string

+ MobileNetworkCode string

+ Name string

+ Type CarrierType

+ type CarrierType string

+ var CarrierTypeBlank CarrierType = ""

+ var CarrierTypeLandline CarrierType = "landline"

+ var CarrierTypeMobile CarrierType = "mobile"

+ var CarrierTypeVoip CarrierType = "voip"

+ type Lookup struct

+ CallerName *CallerName

+ Carrier *Carrier

+ CountryCode string

+ NationalFormat string

+ PhoneNumber string

+ URL string

+ type NumberLookup interface

+ Get func(number string) (Lookup, error)

type TextGrid

+ Lookups func() NumberLookup

v0.3.0

Sep 15, 2023

Changes in this version

+ type Call struct

+ APIVersion string

+ AccountSid string

+ DateCreated string

+ DateUpdated string

+ Direction string

+ Duration int

+ EndTime TextGridTime

+ From string

+ PhoneNumberSid string

+ Price string

+ PriceUnit string

+ QueueTime TextGridTime

+ Sid string

+ StartTime TextGridTime

+ Status string

+ To string

+ URI string

+ type CallInitiatePayload struct

+ ActionURL string

+ From string

+ StatusCallback string

+ To string

type TextGrid

+ GetCall func(id string) (*Call, error)

+ InitiateCall func(call CallInitiatePayload) (*Call, error)

v0.2.3

Jul 31, 2023

Changes in this version

type Campaign

+ AccountSid string

+ DateCreated TextGridTime

+ DcaDeclineReason string

+ DcaSharingStatus SecondaryDcaSharingStatus

+ type SecondaryDcaSharingStatus string

+ var SecondaryDcaSharingStatusAccepted SecondaryDcaSharingStatus = "ACCEPTED"

+ var SecondaryDcaSharingStatusBlank SecondaryDcaSharingStatus = ""

+ var SecondaryDcaSharingStatusDeclined SecondaryDcaSharingStatus = "DECLINED"

+ var SecondaryDcaSharingStatusPending SecondaryDcaSharingStatus = "PENDING"

type TextGrid

+ GetCampaign func(id string) (*Campaign, error)

v0.2.2

Jul 28, 2023

v0.2.1

Jul 28, 2023

v0.2.0

Jul 28, 2023

Changes in this version

+ type BrandIdentityStatusType string

+ var BrandIdentityStatusTypeBlank BrandIdentityStatusType = ""

+ var BrandIdentityStatusTypePending BrandIdentityStatusType = "PENDING"

+ var BrandIdentityStatusTypeUnverified BrandIdentityStatusType = "UNVERIFIED"

+ var BrandIdentityStatusTypeVerified BrandIdentityStatusType = "VERIFIED"

+ type TcrWebhookEventType string

+ var TcrWebhookEventTypeBrandDelete TcrWebhookEventType = "BRAND_DELETE"

+ var TcrWebhookEventTypeBrandIdentityStatusUpdate TcrWebhookEventType = "BRAND_IDENTITY_STATUS_UPDATE"

+ var TcrWebhookEventTypeCampaignBilled TcrWebhookEventType = "CAMPAIGN_BILLED"

+ var TcrWebhookEventTypeCampaignDCAComplete TcrWebhookEventType = "CAMPAIGN_DCA_COMPLETE"

+ var TcrWebhookEventTypeCampaignExpired TcrWebhookEventType = "CAMPAIGN_EXPIRED"

+ type TcrWebhookPayload struct

+ BrandID string

+ BrandIdentityStatus string

+ BrandName string

+ BrandReferenceID any

+ CampaignID string

+ CampaignReferenceID string

+ CspID string

+ CspName string

+ Description string

+ EventType string

+ Mock bool

v0.1.2

Jul 27, 2023

v0.1.1

Jul 27, 2023

v0.1.0

Jul 15, 2023

Changes in this version

+ const APISearchLayout

+ const APIVersion

+ const BaseAPI

+ const TimeLayout

+ var Epoch = time.Date(2005, 1, 1, 0, 0, 0, 0, time.UTC)

+ var HeatDeath = time.Date(6000, 1, 1, 0, 0, 0, 0, time.UTC)

+ func NewTextGrid(baseAPI, accountSid, authToken string) *textGrid

+ type Account struct

+ AuthToken string

+ DateCreated TextGridTime

+ DateUpdated TextGridTime

+ FriendlyName string

+ OwnerAccountSid string

+ Sid string

+ Status string

+ SubresourceURIs map[string]string

+ Type string

+ URI string

+ WebhookSecret string

+ type AddIncomingPhoneNumberPayload struct

+ FriendlyName string

+ PhoneNumber string

+ SmsFallbackMethod WebhookHTTPMethod

+ SmsFallbackURL string

+ SmsMethod WebhookHTTPMethod

+ SmsURL string

+ StatusCallbackMethod WebhookHTTPMethod

+ StatusCallbackURL string

+ VoiceFallbackMethod WebhookHTTPMethod

+ VoiceFallbackURL string

+ VoiceMethod WebhookHTTPMethod

+ VoiceURL string

+ type AvailableNumber struct

+ Beta bool

+ Capabilities NumberCapabilities

+ FriendlyName string

+ IsoCountry string

+ Lata string

+ PhoneNumber string

+ RateCenter string

+ Region string

+ type AvailableNumbers struct

+ AvailablePhoneNumbers []AvailableNumber

+ URI string

+ type AvailableNumbersSearch struct

+ AreaCode string

+ Contains string

+ Lata string

+ PostalCode string

+ RateCenter string

+ Region string

+ type Brand struct

+ AccountSid string

+ AltBusinessID string

+ AltBusinessIDType BrandAltBusinessIDType

+ BrandRelationship BrandRelationship

+ City string

+ CompanyName string

+ Country string

+ CspID string

+ DisplayName string

+ Ein string

+ EinIssuingCountry string

+ Email string

+ EntityType BrandEntityType

+ FirstName string

+ ID string

+ IPAddress string

+ IdentityStatus string

+ LastName string

+ MobilePhone string

+ Mock bool

+ Phone string

+ PostalCode string

+ ReferenceID string

+ State string

+ StockExchange string

+ StockSymbol string

+ Street string

+ UniversalEin string

+ Vertical BrandVertical

+ Website string

+ type BrandAltBusinessIDType string

+ var BrandAltBusinessIDTypeDUNS BrandAltBusinessIDType = "DUNS"

+ var BrandAltBusinessIDTypeGIIN BrandAltBusinessIDType = "GIIN"

+ var BrandAltBusinessIDTypeLEI BrandAltBusinessIDType = "LEI"

+ var BrandAltBusinessIDTypeNone BrandAltBusinessIDType = "NONE"

+ type BrandEntityType string

+ var BrandEntityTypeGovernment BrandEntityType = "GOVERNMENT"

+ var BrandEntityTypeNonProfit BrandEntityType = "NON_PROFIT"

+ var BrandEntityTypePrivateProfit BrandEntityType = "PRIVATE_PROFIT"

+ var BrandEntityTypePublicProfit BrandEntityType = "PUBLIC_PROFIT"

+ var BrandEntityTypeSoleProprietor BrandEntityType = "SOLE_PROPRIETOR"

+ type BrandRelationship string

+ var BrandRelationshipBasicAccount BrandRelationship = "BASIC_ACCOUNT"

+ var BrandRelationshipKeyAccount BrandRelationship = "KEY_ACCOUNT"

+ var BrandRelationshipLargeAccount BrandRelationship = "LARGE_ACCOUNT"

+ var BrandRelationshipMediumAccount BrandRelationship = "MEDIUM_ACCOUNT"

+ var BrandRelationshipSmallAccount BrandRelationship = "SMALL_ACCOUNT"

+ type BrandVertical string

+ var BrandVerticalAgriculture BrandVertical = "AGRICULTURE"

+ var BrandVerticalCommunication BrandVertical = "COMMUNICATION"

+ var BrandVerticalConstruction BrandVertical = "CONSTRUCTION"

+ var BrandVerticalEducation BrandVertical = "EDUCATION"

+ var BrandVerticalEnergy BrandVertical = "ENERGY"

+ var BrandVerticalEntertainment BrandVertical = "ENTERTAINMENT"

+ var BrandVerticalFinancial BrandVertical = "FINANCIAL"

+ var BrandVerticalGambling BrandVertical = "GAMBLING"

+ var BrandVerticalGovernment BrandVertical = "GOVERNMENT"

+ var BrandVerticalHealthcare BrandVertical = "HEALTHCARE"

+ var BrandVerticalHospitality BrandVertical = "HOSPITALITY"

+ var BrandVerticalHumanResources BrandVertical = "HUMAN_RESOURCES"

+ var BrandVerticalInsurance BrandVertical = "INSURANCE"

+ var BrandVerticalLegal BrandVertical = "LEGAL"

+ var BrandVerticalManufacturing BrandVertical = "MANUFACTURING"

+ var BrandVerticalNonProfit BrandVertical = "NGO"

+ var BrandVerticalPolitical BrandVertical = "POLITICAL"

+ var BrandVerticalPostal BrandVertical = "POSTAL"

+ var BrandVerticalProfessional BrandVertical = "PROFESSIONAL"

+ var BrandVerticalRealEstate BrandVertical = "REAL_ESTATE"

+ var BrandVerticalRetail BrandVertical = "RETAIL"

+ var BrandVerticalTechnology BrandVertical = "TECHNOLOGY"

+ var BrandVerticalTransportation BrandVertical = "TRANSPORTATION"

+ type Campaign struct

+ AffiliateMarketing bool

+ AgeGated bool

+ AutoRenewal bool

+ BilledDate string

+ BrandID string

+ CreateDate string

+ CspID string

+ Description string

+ DirectLending bool

+ EmbeddedLink bool

+ EmbeddedPhone bool

+ HelpKeywords string

+ HelpMessage string

+ ID string

+ MessageFlow string

+ NumberPool bool

+ OptinKeywords string

+ OptinMessage string

+ OptoutKeywords string

+ OptoutMessage string

+ ReferenceID string

+ ResellerID string

+ Sample1 string

+ Sample2 string

+ Sample3 string

+ Sample4 string

+ Sample5 string

+ Status string

+ SubUsecases []UseCase

+ SubscriberHelp bool

+ SubscriberOptin bool

+ SubscriberOptout bool

+ Usecase UseCase

+ type CountryCode string

+ var CountryCodeCanada CountryCode = "CA"

+ var CountryCodeUnitedStates CountryCode = "US"

+ type CreateBrandPayload struct

+ AltBusinessID string

+ AltBusinessIDType BrandAltBusinessIDType

+ BrandRelationship BrandRelationship

+ City string

+ CompanyName string

+ Country string

+ DisplayName string

+ Ein string

+ EinIssuingCountry string

+ Email string

+ EntityType BrandEntityType

+ FirstName string

+ IPAddress string

+ LastName string

+ MobilePhone string

+ Mock bool

+ Phone string

+ PostalCode string

+ ReferenceID string

+ State string

+ StockExchange string

+ StockSymbol string

+ Street string

+ Vertical BrandVertical

+ Website string

+ type CreateCampaignPayload struct

+ AffiliateMarketing bool

+ AgeGated bool

+ AutoRenewal bool

+ BrandID string

+ Description string

+ DirectLending bool

+ EmbeddedLink bool

+ EmbeddedPhone bool

+ HelpKeywords string

+ HelpMessage string

+ MessageFlow string

+ NumberPool bool

+ OptinKeywords string

+ OptinMessage string

+ OptoutKeywords string

+ OptoutMessage string

+ ReferenceID string

+ Sample1 string

+ Sample2 string

+ Sample3 string

+ Sample4 string

+ Sample5 string

+ SubUsecases []UseCase

+ SubscriberHelp bool

+ SubscriberOptin bool

+ SubscriberOptout bool

+ Usecase UseCase

+ type IncomingMessage struct

+ APIVersion string

+ AccountSID string

+ Body string

+ From string

+ MessageSID string

+ NumberOfMedia int

+ NumberOfSegments int

+ SmsMessageSid string

+ SmsSID string

+ SmsStatus string

+ To string

+ type IncomingPhoneNumber struct

+ APIVersion string

+ AccountSid string

+ Beta bool

+ Capabilities NumberCapabilities

+ DateCreated string

+ DateUpdated string

+ FriendlyName string

+ ID string

+ PhoneNumber string

+ SmsFallbackMethod string

+ SmsFallbackURL string

+ SmsMethod string

+ SmsURL string

+ Status string

+ StatusCallback string

+ StatusCallbackMethod string

+ URI string

+ VoiceFallbackMethod string

+ VoiceFallbackURL string

+ VoiceMethod string

+ VoiceURL string

+ type NumberCapabilities struct

+ Mms bool

+ Sms bool

+ Voice bool

+ type TextGrid interface

+ AddIncomingPhoneNumber func(payload AddIncomingPhoneNumberPayload) (*IncomingPhoneNumber, error)

+ AttachNumberToCampaign func(id, numberID string) error

+ CreateAccount func(data url.Values) (*Account, error)

+ CreateBrand func(brand CreateBrandPayload) (*Brand, error)

+ CreateCampaign func(payload CreateCampaignPayload) (*Campaign, error)

+ DeactivateCampaign func(id string) error

+ DeleteBrand func(id string) error

+ GetBrand func(id string) (*Brand, error)

+ ListAvailablePhoneNumbers func(countryCode CountryCode, search AvailableNumbersSearch) (*AvailableNumbers, error)

+ type TextGridTime struct

+ Time time.Time

+ Valid bool

+ func NewTextGridTime(val string) *TextGridTime

+ func (t *TextGridTime) UnmarshalJSON(b []byte) error

+ func (t TextGridTime) MarshalJSON() ([]byte, error)

+ type UseCase string

+ var UseCase2FA UseCase = "2FA"

+ var UseCaseAccountNotification UseCase = "ACCOUNT_NOTIFICATION"

+ var UseCaseAgentsFranchises UseCase = "AGENTS_FRANCHISES"

+ var UseCaseCarrierExempt UseCase = "CARRIER_EXEMPT"

+ var UseCaseCharity UseCase = "CHARITY"

+ var UseCaseCustomerCare UseCase = "CUSTOMER_CARE"

+ var UseCaseDeliveryNotification UseCase = "DELIVERY_NOTIFICATION"

+ var UseCaseEmergency UseCase = "EMERGENCY"

+ var UseCaseFraudAlert UseCase = "FRAUD_ALERT"

+ var UseCaseHigherEducation UseCase = "HIGHER_EDUCATION"

+ var UseCaseK12Education UseCase = "K12_EDUCATION"

+ var UseCaseLowVolume UseCase = "LOW_VOLUME"

+ var UseCaseM2M UseCase = "M2M"

+ var UseCaseMarketing UseCase = "MARKETING"

+ var UseCaseMixed UseCase = "MIXED"

+ var UseCasePolitical UseCase = "POLITICAL"

+ var UseCasePollingVoting UseCase = "POLLING_VOTING"

+ var UseCaseProxy UseCase = "PROXY"

+ var UseCasePublicServiceAnnouncement UseCase = "PUBLIC_SERVICE_ANNOUNCEMENT"

+ var UseCaseSecurityAlert UseCase = "SECURITY_ALERT"

+ var UseCaseSocial UseCase = "SOCIAL"

+ var UseCaseSoleProprietor UseCase = "SOLE_PROPRIETOR"

+ var UseCaseSweepstake UseCase = "SWEEPSTAKE"

+ var UseCaseTrial UseCase = "TRIAL"

+ var UseCaseUcaasHigh UseCase = "UCAAS_HIGH"

+ var UseCaseUcaasLow UseCase = "UCAAS_LOW"

+ type WebhookHTTPMethod string

+ var WebhookHTTPMethodGet WebhookHTTPMethod = "GET"

+ var WebhookHTTPMethodPost WebhookHTTPMethod = "POST"

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL