Repository files navigation

A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com

This API client was generated by theOpenAPI Generator project. By using theOpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 5.3.0
• Package version: 5.3.0-beta1
• Build package: org.openapitools.codegen.languages.GoClientCodegenFor more information, please visithttps://onesignal.com

go get github.com/OneSignal/onesignal-go-api/v5

Install the following dependencies:

go get golang.org/x/oauth2

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

import"github.com/OneSignal/onesignal-go-api"

To use a proxy, set the environment variableHTTP_PROXY:

os.Setenv("HTTP_PROXY","http://proxy_name:proxy_port")

Default configuration comes withServers field that contains server objects as defined in the OpenAPI specification.

For using other server than the one defined on index 0 set context valuesw.ContextServerIndex of typeint.

ctx:=context.WithValue(context.Background(),onesignal.ContextServerIndex,1)

Templated server URL is formatted using default variables from configuration or from context valuesw.ContextServerVariables of typemap[string]string.

ctx:=context.WithValue(context.Background(),onesignal.ContextServerVariables,map[string]string{"basePath":"v2",})

Note, enum values are always validated and all unused variables are silently ignored.

Each operation can use different server URL defined usingOperationServers map in theConfiguration.An operation is uniquely identified by"{classname}Service.{nickname}" string.Similar rules for overriding default operation server index and variables applies by usingsw.ContextOperationServerIndices andsw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), onesignal.ContextOperationServerIndices, map[string]int{"{classname}Service.{nickname}": 2,})ctx = context.WithValue(context.Background(), onesignal.ContextOperationServerVariables, map[string]map[string]string{"{classname}Service.{nickname}": {"port": "8443",},})

All URIs are relative tohttps://api.onesignal.com

• ApiKeyToken
• ApiKeyTokensListResponse
• App
• BasicNotification
• BasicNotificationAllOf
• BasicNotificationAllOfAndroidBackgroundLayout
• Button
• CopyTemplateRequest
• CreateApiKeyRequest
• CreateApiKeyResponse
• CreateNotificationSuccessResponse
• CreateSegmentConflictResponse
• CreateSegmentSuccessResponse
• CreateTemplateRequest
• CreateUserConflictResponse
• CreateUserConflictResponseErrorsInner
• CreateUserConflictResponseErrorsItemsMeta
• CustomEvent
• CustomEventsRequest
• DeliveryData
• ExportEventsSuccessResponse
• ExportSubscriptionsRequestBody
• ExportSubscriptionsSuccessResponse
• Filter
• FilterExpression
• GenericError
• GenericSuccessBoolResponse
• GetNotificationHistoryRequestBody
• GetSegmentsSuccessResponse
• LanguageStringMap
• Notification
• NotificationAllOf
• NotificationHistorySuccessResponse
• NotificationSlice
• NotificationTarget
• NotificationWithMeta
• NotificationWithMetaAllOf
• Operator
• OutcomeData
• OutcomesData
• PlatformDeliveryData
• PlatformDeliveryDataEmailAllOf
• PlatformDeliveryDataSmsAllOf
• PropertiesBody
• PropertiesDeltas
• PropertiesObject
• Purchase
• RateLimitError
• Segment
• SegmentData
• SegmentNotificationTarget
• StartLiveActivityRequest
• StartLiveActivitySuccessResponse
• Subscription
• SubscriptionBody
• SubscriptionNotificationTarget
• TemplateResource
• TemplatesListResponse
• TransferSubscriptionRequestBody
• UpdateApiKeyRequest
• UpdateLiveActivityRequest
• UpdateLiveActivitySuccessResponse
• UpdateTemplateRequest
• UpdateUserRequest
• User
• UserIdentityBody
• WebButton

Use a OneSignal authentication context for each auth type:

• RestApiKey - For app-level REST API operations
• OrganizationApiKey - For organization-level operations

• Type: HTTP Bearer token authentication

Example

orgAuth:=context.WithValue(context.Background(),onesignal.OrganizationApiKey,"YOUR_ORGANIZATION_API_KEY")// Organization API key is only required for creating new apps and other top-level endpoints

• Type: HTTP Bearer token authentication

Example

restAuth:=context.WithValue(context.Background(),onesignal.RestApiKey,"YOUR_REST_API_KEY")// App REST API key required for most endpoints

Due to the fact that model structure members are all pointers, this package containsa number of utility functions to easily obtain pointers to values of basic types.Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

devrel@onesignal.com