Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

License

NotificationsYou must be signed in to change notification settings

OneSignal/onesignal-ruby-api

Repository files navigation

OneSignal - the Ruby gem for the OneSignal

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

This SDK is automatically generated by theOpenAPI Generator project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build onesignal.gemspec

Then either install the gem locally:

gem install ./onesignal-5.3.0-beta1.gem

(for development, rungem install --dev ./onesignal-5.3.0-beta1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g.RubyGems.

Finally add this to the Gemfile:

gem 'onesignal', '~> 5.3.0-beta1'

Install from Git

If the Ruby gem is hosted at a git repository:https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'onesignal', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using-I as follows:

ruby -Ilib script.rb

Getting Started

Please follow theinstallation procedure and then run the following code:

# Load the gemrequire'onesignal'# Setup authorizationOneSignal.configuredo |config|# Configure Bearer authorization: organization_api_keyconfig.organization_api_key='ORGANIZATION_API_KEY'# Organization key is only required for creating new apps and other top-level endpoints# Configure Bearer authorization: rest_api_keyconfig.rest_api_key='REST_API_KEY'# App REST API key required for most endpointsendapi_instance=OneSignal::DefaultApi.newapp_id='app_id_example'# String |notification_id='notification_id_example'# String |begin#Stop a scheduled or currently outgoing notificationresult=api_instance.cancel_notification(app_id,notification_id)presultrescueOneSignal::ApiError=>eputs"Exception when calling DefaultApi->cancel_notification:#{e}"end

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
OneSignal::DefaultApicancel_notificationDELETE /notifications/{notification_id}Stop a scheduled or currently outgoing notification
OneSignal::DefaultApicopy_template_to_appPOST /templates/{template_id}/copy_to_appCopy template to another app
OneSignal::DefaultApicreate_aliasPATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
OneSignal::DefaultApicreate_alias_by_subscriptionPATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
OneSignal::DefaultApicreate_api_keyPOST /apps/{app_id}/auth/tokensCreate API key
OneSignal::DefaultApicreate_appPOST /appsCreate an app
OneSignal::DefaultApicreate_custom_eventsPOST /apps/{app_id}/integrations/custom_eventsCreate custom events
OneSignal::DefaultApicreate_notificationPOST /notificationsCreate notification
OneSignal::DefaultApicreate_segmentPOST /apps/{app_id}/segmentsCreate Segment
OneSignal::DefaultApicreate_subscriptionPOST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions
OneSignal::DefaultApicreate_templatePOST /templatesCreate template
OneSignal::DefaultApicreate_userPOST /apps/{app_id}/users
OneSignal::DefaultApidelete_aliasDELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}
OneSignal::DefaultApidelete_api_keyDELETE /apps/{app_id}/auth/tokens/{token_id}Delete API key
OneSignal::DefaultApidelete_segmentDELETE /apps/{app_id}/segments/{segment_id}Delete Segment
OneSignal::DefaultApidelete_subscriptionDELETE /apps/{app_id}/subscriptions/{subscription_id}
OneSignal::DefaultApidelete_templateDELETE /templates/{template_id}Delete template
OneSignal::DefaultApidelete_userDELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}
OneSignal::DefaultApiexport_eventsPOST /notifications/{notification_id}/export_events?app_id={app_id}Export CSV of Events
OneSignal::DefaultApiexport_subscriptionsPOST /players/csv_export?app_id={app_id}Export CSV of Subscriptions
OneSignal::DefaultApiget_aliasesGET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
OneSignal::DefaultApiget_aliases_by_subscriptionGET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
OneSignal::DefaultApiget_appGET /apps/{app_id}View an app
OneSignal::DefaultApiget_appsGET /appsView apps
OneSignal::DefaultApiget_notificationGET /notifications/{notification_id}View notification
OneSignal::DefaultApiget_notification_historyPOST /notifications/{notification_id}/historyNotification History
OneSignal::DefaultApiget_notificationsGET /notificationsView notifications
OneSignal::DefaultApiget_outcomesGET /apps/{app_id}/outcomesView Outcomes
OneSignal::DefaultApiget_segmentsGET /apps/{app_id}/segmentsGet Segments
OneSignal::DefaultApiget_userGET /apps/{app_id}/users/by/{alias_label}/{alias_id}
OneSignal::DefaultApirotate_api_keyPOST /apps/{app_id}/auth/tokens/{token_id}/rotateRotate API key
OneSignal::DefaultApistart_live_activityPOST /apps/{app_id}/activities/activity/{activity_type}Start Live Activity
OneSignal::DefaultApitransfer_subscriptionPATCH /apps/{app_id}/subscriptions/{subscription_id}/owner
OneSignal::DefaultApiunsubscribe_email_with_tokenPOST /apps/{app_id}/notifications/{notification_id}/unsubscribeUnsubscribe with token
OneSignal::DefaultApiupdate_api_keyPATCH /apps/{app_id}/auth/tokens/{token_id}Update API key
OneSignal::DefaultApiupdate_appPUT /apps/{app_id}Update an app
OneSignal::DefaultApiupdate_live_activityPOST /apps/{app_id}/live_activities/{activity_id}/notificationsUpdate a Live Activity via Push
OneSignal::DefaultApiupdate_subscriptionPATCH /apps/{app_id}/subscriptions/{subscription_id}
OneSignal::DefaultApiupdate_subscription_by_tokenPATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}Update subscription by token
OneSignal::DefaultApiupdate_templatePATCH /templates/{template_id}Update template
OneSignal::DefaultApiupdate_userPATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}
OneSignal::DefaultApiview_api_keysGET /apps/{app_id}/auth/tokensView API keys
OneSignal::DefaultApiview_templateGET /templates/{template_id}View template
OneSignal::DefaultApiview_templatesGET /templatesView templates

Documentation for Models

Documentation for Authorization

organization_api_key

  • Type: Bearer authentication

rest_api_key

  • Type: Bearer authentication

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors6

Languages

[8]ページ先頭
©2009-2025 Movatter.jp