From 0d34669b6157f04c316b7d8af1b75d149de5aef6 Mon Sep 17 00:00:00 2001 From: OneSignal Date: Thu, 9 Apr 2026 21:33:18 +0000 Subject: [PATCH] feat: add v5.3.0 package updates --- README.md | 773 ++---------------- docs/ApiKeyToken.md | 2 +- docs/ApiKeyTokensListResponse.md | 2 +- docs/App.md | 2 +- docs/BasicNotification.md | 2 +- docs/BasicNotificationAllOf.md | 2 +- ...otificationAllOfAndroidBackgroundLayout.md | 2 +- docs/Button.md | 2 +- docs/CopyTemplateRequest.md | 2 +- docs/CreateApiKeyRequest.md | 2 +- docs/CreateApiKeyResponse.md | 2 +- docs/CreateNotificationSuccessResponse.md | 2 +- docs/CreateSegmentConflictResponse.md | 2 +- docs/CreateSegmentSuccessResponse.md | 2 +- docs/CreateTemplateRequest.md | 2 +- docs/CreateUserConflictResponse.md | 2 +- docs/CreateUserConflictResponseErrorsInner.md | 2 +- ...eateUserConflictResponseErrorsItemsMeta.md | 2 +- docs/CustomEvent.md | 2 +- docs/CustomEventsRequest.md | 2 +- docs/DefaultApi.md | 176 ++-- docs/DeliveryData.md | 2 +- docs/ExportEventsSuccessResponse.md | 2 +- docs/ExportSubscriptionsRequestBody.md | 2 +- docs/ExportSubscriptionsSuccessResponse.md | 2 +- docs/Filter.md | 2 +- docs/FilterExpression.md | 2 +- docs/GenericError.md | 2 +- docs/GenericSuccessBoolResponse.md | 2 +- docs/GetNotificationHistoryRequestBody.md | 2 +- docs/GetSegmentsSuccessResponse.md | 2 +- docs/LanguageStringMap.md | 2 +- docs/Notification.md | 2 +- docs/NotificationAllOf.md | 2 +- docs/NotificationHistorySuccessResponse.md | 2 +- docs/NotificationSlice.md | 2 +- docs/NotificationTarget.md | 2 +- docs/NotificationWithMeta.md | 2 +- docs/NotificationWithMetaAllOf.md | 2 +- docs/Operator.md | 2 +- docs/OutcomeData.md | 2 +- docs/OutcomesData.md | 2 +- docs/PlatformDeliveryData.md | 2 +- docs/PlatformDeliveryDataEmailAllOf.md | 2 +- docs/PlatformDeliveryDataSmsAllOf.md | 2 +- docs/PropertiesBody.md | 2 +- docs/PropertiesDeltas.md | 2 +- docs/PropertiesObject.md | 2 +- docs/Purchase.md | 2 +- docs/RateLimitError.md | 2 +- docs/Segment.md | 2 +- docs/SegmentData.md | 2 +- docs/SegmentNotificationTarget.md | 2 +- docs/StartLiveActivityRequest.md | 2 +- docs/StartLiveActivitySuccessResponse.md | 2 +- docs/Subscription.md | 2 +- docs/SubscriptionBody.md | 2 +- docs/SubscriptionNotificationTarget.md | 2 +- docs/TemplateResource.md | 2 +- docs/TemplatesListResponse.md | 2 +- docs/TransferSubscriptionRequestBody.md | 2 +- docs/UpdateApiKeyRequest.md | 2 +- docs/UpdateLiveActivityRequest.md | 2 +- docs/UpdateLiveActivitySuccessResponse.md | 2 +- docs/UpdateTemplateRequest.md | 2 +- docs/UpdateUserRequest.md | 2 +- docs/User.md | 2 +- docs/UserIdentityBody.md | 2 +- docs/WebButton.md | 2 +- 69 files changed, 201 insertions(+), 882 deletions(-) diff --git a/README.md b/README.md index 2835813..5cc1789 100644 --- a/README.md +++ b/README.md @@ -4,768 +4,87 @@ A powerful way to send personalized messages at scale and build effective custom For more information, please visit [https://onesignal.com](https://onesignal.com) -## Overview - -This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client. - - API version: 5.3.0 - Package version: 5.3.0 -- Build package: `org.openapitools.codegen.languages.RustClientCodegen` -- GitHub repository: [https://github.com/onesignal/onesignal-rust-api](https://github.com/onesignal/onesignal-rust-api) ## Installation -### Crates.io -You can install this library as a crate dependency https://crates.io/crates/onesignal-rust-api. -### Manual installation -Put the package under your project folder in a directory named `onesignal` and add the following to `Cargo.toml` under `[dependencies]`: - -``` -onesignal = { path = "./onesignal" } -``` - -## Examples -### Use the following dependency: -```rust -use onesignal::*; -use onesignal::apis::configuration::Configuration; -use onesignal::models::filter_expressions::RelationType; -use onesignal::models::{App, FilterExpressions, Notification, Player, Segment, StringMap, UpdatePlayerTagsRequestBody}; - -``` - -### Define the constants. You can find all the values on the dashboard page of your app. -```rust -const APP_ID: &str = ""; -const REST_API_KEY: &str = ""; // App REST API key required for most endpoints -const ORGANIZATION_API_KEY: &str = ""; // Organization key is only required for creating new apps and other top-level endpoints - -``` - -### Creating a configuration object: -```rust -fn create_configuration() -> Box { - let mut configuration = apis::configuration::Configuration::new(); - configuration.rest_api_key_token = Some(String::from(REST_API_KEY)); - configuration.organization_api_key_token = Some(String::from(ORGANIZATION_API_KEY)); - Box::new(configuration) -} -``` - -### Creating a notification object: -```rust -fn create_notification() -> Box { - let mut notification = Notification::new(String::from(APP_ID)); - let mut string_map = StringMap::new(); - - string_map.en = Some(String::from("Rust test notification")); - notification.contents = Some(Box::new(string_map)); - notification.is_chrome_web = Some(true); - notification.is_any_web = Some(true); - notification.included_segments = Some(vec![String::from("Subscribed Users")]); - - Box::new(notification) -} -``` - -### Sending a notification: -```rust -async fn send_notification() { - // Prepare configuration and the notification objects - let configuration = create_configuration(); - let notification = create_notification(); - - // Send notification to the server - let create_notification_response = apis::default_api::create_notification(&configuration, *notification).await; - - // Check the result - if let Ok(ref created_notification) = create_notification_response { - println!("Created notification id: {}", created_notification.id); - } - - if let Err(ref created_notification_error) = create_notification_response { - println!("Created notification error: {}", created_notification_error.to_string()); - } -} -``` - -### Sending a notification using filters: -Send this notification only to the users that have not spent any USD on IAP. -```rust -async fn send_notification() { - // Prepare configuration and the notification objects - let configuration = create_configuration(); - let mut notification = create_notification(); - - notification.filters = Some(vec![ - Filter { - field: "amount_spent".to_owned(), - relation: onesignal_rust_api::models::filter::RelationType::Equal, - value: Some("0".to_owned()), - key: None - }, - ]); - - // Send notification to the server - let create_notification_response = apis::default_api::create_notification(&configuration, *notification).await; - - // Check the result - if let Ok(ref created_notification) = create_notification_response { - println!("Created notification id: {}", created_notification.id); - } - - if let Err(ref created_notification_error) = create_notification_response { - println!("Created notification error: {}", created_notification_error.to_string()); - } -} -``` - -### Canceling a scheduled notification -```rust -async fn cancel_scheduled_notification() { - let configuration = create_configuration(); - let mut notification = create_notification(); - let send_after = Utc::now().checked_add_signed(Duration::seconds(30)); - notification.send_after = Some(String::from(send_after.unwrap().to_rfc2822())); - - let create_notification_response = - apis::default_api::create_notification(&configuration, *notification.clone()).await; - - let cancel_notification_response = - apis::default_api::cancel_notification( - &configuration, APP_ID, &create_notification_response.unwrap().id).await; - - assert_ok!(&cancel_notification_response); - assert!(cancel_notification_response.unwrap().success.unwrap()); -} -``` - -### Getting a notification -```rust -async fn get_notification() { - let configuration = create_configuration(); - let notification = create_notification(); - - let create_notification_response = - apis::default_api::create_notification(&configuration, *notification.clone()).await; - - let get_notification_response = - apis::default_api::get_notification( - &configuration, APP_ID, &create_notification_response.unwrap().id).await; - - assert_ok!(&get_notification_response); - assert!(get_notification_response.unwrap().id.unwrap().len() > 0); -} -``` - -### Getting a list of notifications -```rust -async fn get_multiple_notifications() { - let configuration = create_configuration(); - - // Limit: 100 - // Offset: 0 - // Kind: 1 - let get_notifications_response = - apis::default_api::get_notifications( - &configuration, APP_ID, Some(100), Some(0), Some(1)).await; - - assert_ok!(&get_notifications_response); - assert!(get_notifications_response.unwrap().notifications.unwrap().len() > 0); -} -``` - -### Creating a brand new player model -```rust -fn create_player() -> Box { - let mut player = Box::new(Player::new("Rust Test Player".to_string(), 1)); - player.app_id = Some(APP_ID.to_string()); - player -} -``` - -### Creating and deleting a segment -```rust -async fn create_and_get_player() { - let configuration = create_configuration(); - let player = create_player(); - - let create_player_response = - apis::default_api::create_player(&configuration, *player).await; - - let get_player_response = - apis::default_api::get_player( - &configuration, APP_ID, &create_player_response.unwrap().id.unwrap(), None).await; - - assert_ok!(&get_player_response); - assert!(get_player_response.unwrap().id.len() > 0); -} -``` - -### Creating and updating a player -```rust -async fn update_player() { - let configuration = create_configuration(); - let player = create_player(); - let mut updated_player = create_player(); - updated_player.external_user_id = Some(String::from("test_user")); - - let create_player_response = - apis::default_api::create_player(&configuration, *player).await; - - let update_player_response = - apis::default_api::update_player( - &configuration, &create_player_response.unwrap().id.unwrap(), *updated_player).await; - - assert_ok!(&update_player_response); - assert!(update_player_response.unwrap().success.unwrap()); -} -``` - -### Updating player tags -```rust -async fn update_player_tags() { - let configuration = create_configuration(); - - let mut updated_player_tags_request_body= UpdatePlayerTagsRequestBody::new(); - let tag_value = json!({"test_tag": 1}); - - updated_player_tags_request_body.tags = Some(tag_value); - - let update_player_tags_response = - apis::default_api::update_player_tags( - &configuration, - APP_ID, - "test_user", - Some(updated_player_tags_request_body)).await; - - assert_ok!(&update_player_tags_response); - assert!(update_player_tags_response.unwrap().success.unwrap()); -} -``` - -### Getting a list of players -```rust -async fn get_multiple_players() { - let configuration = create_configuration(); - // Limit: 10 - // Offset: 0 - let get_players_response = - apis::default_api::get_players(&configuration, APP_ID, Some(10), None).await; +Add to `Cargo.toml` under `[dependencies]`: - assert_ok!(&get_players_response); - assert!(get_players_response.unwrap().players.unwrap().len() > 0); -} -``` - -### Creating a segment model -```rust -fn create_segment(name: String) -> Box { - let mut filter_expressions = FilterExpressions::new( - "session_count".to_string(), - RelationType::Greater_Than); - filter_expressions.value = Some("1".to_string()); - let segment = Segment::new(name, vec![filter_expressions]); - - Box::new(segment) -} -``` - -### Creating and deleting a segment -```rust -async fn create_and_delete_segment() { - let configuration = create_configuration(); - let segment = create_segment("test_segment"); - - let create_segment_response = - apis::default_api::create_segments(&configuration, APP_ID, Some(*segment)).await; - - let delete_segment_response = - apis::default_api::delete_segments( - &configuration, APP_ID, &create_segment_response.unwrap().id.unwrap()).await; - - assert_ok!(&delete_segment_response); - assert!(delete_segment_response.unwrap().success.unwrap()); -} -``` - -### Getting an app -```rust -async fn get_app() { - let configuration = create_configuration(); - - let get_app_response = - apis::default_api::get_app(&configuration, APP_ID).await; - - assert_ok!(&get_app_response); - assert!(get_app_response.unwrap().id.len() > 0); -} -``` - -### Updating an app -```rust -async fn update_app() { - let configuration = create_configuration(); - let mut app = App::new(APP_ID.to_string()); - app.site_name = Some("rust_test_changed_name".to_string()); - - let update_app_response = - apis::default_api::update_app(&configuration, APP_ID, app).await; - - assert_ok!(&update_app_response); - assert!(update_app_response.unwrap().id.len() > 0); -} +```toml +onesignal-rust-api = "5.3.0" ``` -### Getting a list of apps -```rust -async fn get_multiple_apps() { - let configuration = create_configuration(); - - let get_apps_response = - apis::default_api::get_apps(&configuration).await; - - assert_ok!(&get_apps_response); - assert!(get_apps_response.unwrap().len() > 0); -} -``` - -### Getting outcomes -```rust -async fn get_outcomes() { - let configuration = create_configuration(); - let outcome_names = "os__session_duration.count,os__click.count"; - let outcome_time_range = "1d"; - let outcome_platforms = "5"; - let outcome_attribution = "direct"; - - let get_outcomes_response = - apis::default_api::get_outcomes( - &configuration, - APP_ID, - outcome_names, - None, - Some(outcome_time_range), - Some(outcome_platforms), - Some(outcome_attribution)).await; +## Configuration - assert_ok!(&get_outcomes_response); - assert!(get_outcomes_response.unwrap().outcomes.unwrap().len() > 0); -} -``` - -### Begin a Live Activity event -```rust -async fn begin_live_activity() { - // Create a player first - let configuration = create_configuration(); - let mut player = Box::new(Player::new("Rust Test Player".to_string(), 0)); - player.app_id = Some(APP_ID.to_string()); - let create_player_response = - apis::default_api::create_player(&configuration, *player).await; - let begin_live_activity_request = BeginLiveActivityRequest { - push_token: "", - subscription_id: create_player_response.unwrap().id.unwrap() - }; - let activity_id = ""; +Every SDK requires authentication via API keys. Two key types are available: - // Start live activity - let begin_alive_activity_response = - apis::default_api::begin_live_activity(&configuration, APP_ID, activity_id.as_str(), begin_live_activity_request).await; +- **REST API Key** — required for most endpoints (sending notifications, managing users, etc.). Found in your app's **Settings > Keys & IDs**. +- **Organization API Key** — only required for organization-level endpoints like creating or listing apps. Found in **Organization Settings**. - // Check the request completed successfully - assert_ok!(&begin_alive_activity_response); -} -``` +> **Warning:** Store your API keys in environment variables or a secrets manager. Never commit them to source control. -### Update a Live Activity event ```rust -async fn end_live_activity() { - let activity_id = ""; - let subscription_id = ""; - let update_live_activity_request = UpdateLiveActivityRequest { - name: NameType::Contents, - event: EventType::Update, - event_updates: json!({"data": "test"}), - dismiss_at: None, - }; - - // Stop Live Activity - let update_alive_activity_response = - apis::default_api::update_live_activity(&configuration, APP_ID, activity_id.as_str(), update_live_activity_request).await; - - // Check the request completed successfully - assert_ok!(&update_alive_activity_response); -} -``` - -### End a Live Activity event -```rust -async fn end_live_activity() { - let activity_id = ""; - let subscription_id = ""; - - // Stop Live Activity - let end_alive_activity_response = - apis::default_api::end_live_activity(&configuration, APP_ID, activity_id.as_str(), subscription_id.as_str()).await; +use onesignal::apis::configuration::Configuration; - // Check the request completed successfully - assert_ok!(&end_alive_activity_response); +fn create_configuration() -> Configuration { + let mut config = Configuration::new(); + config.rest_api_key_token = Some("YOUR_REST_API_KEY".to_string()); + config.organization_api_key_token = Some("YOUR_ORGANIZATION_API_KEY".to_string()); + config } ``` -## Users, Subscriptions and Aliases -### Subscription types -* iOSPush -* AndroidPush -* FireOSPush -* ChromeExtensionPush -* ChromePush -* WindowsPush -* SafariLegacyPush -* FirefoxPush -* macOSPush -* HuaweiPush -* SafariPush -* Email -* SMS +## Send a push notification -### Creating a OneSignal user ```rust -// Preparing a model -let mut user = User::new(); -user.identity = Some(HashMap::from([ - ("".as_string(), Value::from("".as_string())), -])); - -user.subscriptions = Some(vec![ - SubscriptionObject { - _type: Some(TypeType::IOSPush), - token: Some("".as_string()), - id: None, - enabled: None, - notification_types: None, - session_time: None, - session_count: None, - sdk: None, - device_model: None, - device_os: None, - rooted: None, - test_type: None, - app_version: None, - net_type: None, - carrier: None, - web_auth: None, - web_p256: None - } -]); - -// Send the request to the server -let create_user_response = apis::default_api::create_user(&configuration, APP_ID, *user).await; -``` +use onesignal::apis::default_api; +use onesignal::models::{Notification, StringMap}; -### Fetching a user by an alias -```rust -let fetch_user_response = apis::default_api::fetch_user(&configuration, APP_ID, "", "").await; -``` - -### Fetching a user by `onesignal_id`, which is a special case of an alias -```rust -let fetch_user_response = apis::default_api::fetch_user(&configuration, APP_ID, "onesignal_id", "").await; -``` +let mut contents = StringMap::new(); +contents.en = Some("Hello from OneSignal!".to_string()); -### Updating a user -```rust -let update_user_request = UpdateUserRequest { - properties: Some(Box::new(PropertiesObject { - tags: None, - language: Some("fr".to_owned()), - timezone_id: None, - lat: None, - long: None, - country: None, - first_active: None, - last_active: None, - amount_spent: None, - purchases: None, - ip: None - })), - refresh_device_metadata: None, - deltas: None -}; +let mut headings = StringMap::new(); +headings.en = Some("Push Notification".to_string()); -let update_user_response = apis::default_api::update_user(&configuration, - APP_ID, - "", - "", - update_user_request, - None)); -``` +let mut notification = Notification::new("YOUR_APP_ID".to_string()); +notification.contents = Some(Box::new(contents)); +notification.headings = Some(Box::new(headings)); +notification.included_segments = Some(vec!["Subscribed Users".to_string()]); -### Deleting a user -```rust -let delete_user_response = apis::default_api::delete_user(&configuration, - APP_ID, - "onesignal_id", // A special case of an alias label - "").await; +let config = create_configuration(); +let response = default_api::create_notification(&config, notification).await; ``` -### Creating new subscription -```rust -let create_subscription_request = CreateSubscriptionRequestBody { - subscription: Some(Box::new(SubscriptionObject { - id: None, - _type: Some(TypeType::AndroidPush), - token: Some("".as_string()), - enabled: None, - notification_types: None, - session_time: None, - session_count: None, - sdk: None, - device_model: None, - device_os: None, - rooted: None, - test_type: None, - app_version: None, - net_type: None, - carrier: None, - web_auth: None, - web_p256: None - })), - retain_previous_owner: None -}; - -let create_subscription_response = apis::default_api::create_subscription(&configuration, - APP_ID, - "", - "", - create_subscription_request).await; -``` +## Send an email -### Updating subscription token ```rust -let update_subscription_request = UpdateSubscriptionRequestBody { - subscription: Some(Box::new(SubscriptionObject { - id: None, - _type: Some(TypeType::AndroidPush), - token: Some("".as_string()), - enabled: None, - notification_types: None, - session_time: None, - session_count: None, - sdk: None, - device_model: None, - device_os: None, - rooted: None, - test_type: None, - app_version: None, - net_type: None, - carrier: None, - web_auth: None, - web_p256: None - })), - retain_previous_owner: None -}; +let mut notification = Notification::new("YOUR_APP_ID".to_string()); +notification.email_subject = Some("Important Update".to_string()); +notification.email_body = Some("

Hello!

This is an HTML email.

".to_string()); +notification.included_segments = Some(vec!["Subscribed Users".to_string()]); +notification.channel_for_external_user_ids = Some("email".to_string()); -let update_subscription_response = apis::default_api::update_subscription(&configuration, - APP_ID, - "", - update_subscription_request).await; +let response = default_api::create_notification(&config, notification).await; ``` -### Deleting a subscription -```rust -let delete_subscription_response = apis::default_api::delete_subscription(&configuration, - APP_ID, - "").await; -``` +## Send an SMS -### Fetching user aliases ```rust -let fetch_aliases_response = apis::default_api::fetch_aliases(&configuration, - APP_ID, - "").await; -``` +let mut contents = StringMap::new(); +contents.en = Some("Your SMS message content here".to_string()); -### Fetching user identity -```rust -let fetch_user_identity_response = apis::default_api::fetch_user_identity(&configuration, - APP_ID, - "", - "").await; -``` +let mut notification = Notification::new("YOUR_APP_ID".to_string()); +notification.contents = Some(Box::new(contents)); +notification.included_segments = Some(vec!["Subscribed Users".to_string()]); +notification.channel_for_external_user_ids = Some("sms".to_string()); +notification.sms_from = Some("+15551234567".to_string()); -### Identifying user by `subscription_id` -```rust -let user_identity_request_body = UserIdentityRequestBody { - identity: Some(HashMap::from([ - ("".as_string(), Value::from("".as_string())), - ])) -}; -let identify_user_response = apis::default_api::identify_user_by_subscription_id(&configuration, - APP_ID, - "", - user_identity_request_body).await; -``` - -### Identifying user by an alias -```rust -let user_identity_request_body = UserIdentityRequestBody { - identity: Some(HashMap::from([ - ("".as_string(), Value::from("".as_string())), - ])) -}; -let identify_user_response = apis::default_api::identify_user_by_alias(&configuration, - APP_ID, - "", - "", - user_identity_request_body).await; -``` - -### Deleting an alias -```rust -let delete_alias_response = apis::default_api::delete_alias(&configuration, - APP_ID, - "", - "", - "").await; -``` - -### Fetching eligible IAMs -```rust -let fetch_iams_response = apis::default_api::get_eligible_iams(&configuration, APP_ID, ""); -``` - -## Documentation for API Endpoints - -All URIs are relative to *https://api.onesignal.com* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DefaultApi* | [**cancel_notification**](docs/DefaultApi.md#cancel_notification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification -*DefaultApi* | [**copy_template_to_app**](docs/DefaultApi.md#copy_template_to_app) | **POST** /templates/{template_id}/copy_to_app | Copy template to another app -*DefaultApi* | [**create_alias**](docs/DefaultApi.md#create_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | -*DefaultApi* | [**create_alias_by_subscription**](docs/DefaultApi.md#create_alias_by_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | -*DefaultApi* | [**create_api_key**](docs/DefaultApi.md#create_api_key) | **POST** /apps/{app_id}/auth/tokens | Create API key -*DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /apps | Create an app -*DefaultApi* | [**create_custom_events**](docs/DefaultApi.md#create_custom_events) | **POST** /apps/{app_id}/integrations/custom_events | Create custom events -*DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification -*DefaultApi* | [**create_segment**](docs/DefaultApi.md#create_segment) | **POST** /apps/{app_id}/segments | Create Segment -*DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions | -*DefaultApi* | [**create_template**](docs/DefaultApi.md#create_template) | **POST** /templates | Create template -*DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /apps/{app_id}/users | -*DefaultApi* | [**delete_alias**](docs/DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} | -*DefaultApi* | [**delete_api_key**](docs/DefaultApi.md#delete_api_key) | **DELETE** /apps/{app_id}/auth/tokens/{token_id} | Delete API key -*DefaultApi* | [**delete_segment**](docs/DefaultApi.md#delete_segment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment -*DefaultApi* | [**delete_subscription**](docs/DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} | -*DefaultApi* | [**delete_template**](docs/DefaultApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete template -*DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**export_events**](docs/DefaultApi.md#export_events) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events -*DefaultApi* | [**export_subscriptions**](docs/DefaultApi.md#export_subscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions -*DefaultApi* | [**get_aliases**](docs/DefaultApi.md#get_aliases) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | -*DefaultApi* | [**get_aliases_by_subscription**](docs/DefaultApi.md#get_aliases_by_subscription) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | -*DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app -*DefaultApi* | [**get_apps**](docs/DefaultApi.md#get_apps) | **GET** /apps | View apps -*DefaultApi* | [**get_notification**](docs/DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification -*DefaultApi* | [**get_notification_history**](docs/DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History -*DefaultApi* | [**get_notifications**](docs/DefaultApi.md#get_notifications) | **GET** /notifications | View notifications -*DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes -*DefaultApi* | [**get_segments**](docs/DefaultApi.md#get_segments) | **GET** /apps/{app_id}/segments | Get Segments -*DefaultApi* | [**get_user**](docs/DefaultApi.md#get_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**rotate_api_key**](docs/DefaultApi.md#rotate_api_key) | **POST** /apps/{app_id}/auth/tokens/{token_id}/rotate | Rotate API key -*DefaultApi* | [**start_live_activity**](docs/DefaultApi.md#start_live_activity) | **POST** /apps/{app_id}/activities/activity/{activity_type} | Start Live Activity -*DefaultApi* | [**transfer_subscription**](docs/DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner | -*DefaultApi* | [**unsubscribe_email_with_token**](docs/DefaultApi.md#unsubscribe_email_with_token) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token -*DefaultApi* | [**update_api_key**](docs/DefaultApi.md#update_api_key) | **PATCH** /apps/{app_id}/auth/tokens/{token_id} | Update API key -*DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app -*DefaultApi* | [**update_live_activity**](docs/DefaultApi.md#update_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push -*DefaultApi* | [**update_subscription**](docs/DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} | -*DefaultApi* | [**update_subscription_by_token**](docs/DefaultApi.md#update_subscription_by_token) | **PATCH** /apps/{app_id}/subscriptions_by_token/{token_type}/{token} | Update subscription by token -*DefaultApi* | [**update_template**](docs/DefaultApi.md#update_template) | **PATCH** /templates/{template_id} | Update template -*DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**view_api_keys**](docs/DefaultApi.md#view_api_keys) | **GET** /apps/{app_id}/auth/tokens | View API keys -*DefaultApi* | [**view_template**](docs/DefaultApi.md#view_template) | **GET** /templates/{template_id} | View template -*DefaultApi* | [**view_templates**](docs/DefaultApi.md#view_templates) | **GET** /templates | View templates - - -## Documentation For Models - - - [ApiKeyToken](docs/ApiKeyToken.md) - - [ApiKeyTokensListResponse](docs/ApiKeyTokensListResponse.md) - - [App](docs/App.md) - - [BasicNotification](docs/BasicNotification.md) - - [BasicNotificationAllOf](docs/BasicNotificationAllOf.md) - - [BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md) - - [Button](docs/Button.md) - - [CopyTemplateRequest](docs/CopyTemplateRequest.md) - - [CreateApiKeyRequest](docs/CreateApiKeyRequest.md) - - [CreateApiKeyResponse](docs/CreateApiKeyResponse.md) - - [CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md) - - [CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md) - - [CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md) - - [CreateTemplateRequest](docs/CreateTemplateRequest.md) - - [CreateUserConflictResponse](docs/CreateUserConflictResponse.md) - - [CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md) - - [CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md) - - [CustomEvent](docs/CustomEvent.md) - - [CustomEventsRequest](docs/CustomEventsRequest.md) - - [DeliveryData](docs/DeliveryData.md) - - [ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md) - - [ExportSubscriptionsRequestBody](docs/ExportSubscriptionsRequestBody.md) - - [ExportSubscriptionsSuccessResponse](docs/ExportSubscriptionsSuccessResponse.md) - - [Filter](docs/Filter.md) - - [FilterExpression](docs/FilterExpression.md) - - [GenericError](docs/GenericError.md) - - [GenericSuccessBoolResponse](docs/GenericSuccessBoolResponse.md) - - [GetNotificationHistoryRequestBody](docs/GetNotificationHistoryRequestBody.md) - - [GetSegmentsSuccessResponse](docs/GetSegmentsSuccessResponse.md) - - [LanguageStringMap](docs/LanguageStringMap.md) - - [Notification](docs/Notification.md) - - [NotificationAllOf](docs/NotificationAllOf.md) - - [NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md) - - [NotificationSlice](docs/NotificationSlice.md) - - [NotificationTarget](docs/NotificationTarget.md) - - [NotificationWithMeta](docs/NotificationWithMeta.md) - - [NotificationWithMetaAllOf](docs/NotificationWithMetaAllOf.md) - - [Operator](docs/Operator.md) - - [OutcomeData](docs/OutcomeData.md) - - [OutcomesData](docs/OutcomesData.md) - - [PlatformDeliveryData](docs/PlatformDeliveryData.md) - - [PlatformDeliveryDataEmailAllOf](docs/PlatformDeliveryDataEmailAllOf.md) - - [PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.md) - - [PropertiesBody](docs/PropertiesBody.md) - - [PropertiesDeltas](docs/PropertiesDeltas.md) - - [PropertiesObject](docs/PropertiesObject.md) - - [Purchase](docs/Purchase.md) - - [RateLimitError](docs/RateLimitError.md) - - [Segment](docs/Segment.md) - - [SegmentData](docs/SegmentData.md) - - [SegmentNotificationTarget](docs/SegmentNotificationTarget.md) - - [StartLiveActivityRequest](docs/StartLiveActivityRequest.md) - - [StartLiveActivitySuccessResponse](docs/StartLiveActivitySuccessResponse.md) - - [Subscription](docs/Subscription.md) - - [SubscriptionBody](docs/SubscriptionBody.md) - - [SubscriptionNotificationTarget](docs/SubscriptionNotificationTarget.md) - - [TemplateResource](docs/TemplateResource.md) - - [TemplatesListResponse](docs/TemplatesListResponse.md) - - [TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md) - - [UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md) - - [UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md) - - [UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md) - - [UpdateTemplateRequest](docs/UpdateTemplateRequest.md) - - [UpdateUserRequest](docs/UpdateUserRequest.md) - - [User](docs/User.md) - - [UserIdentityBody](docs/UserIdentityBody.md) - - [WebButton](docs/WebButton.md) - - -To get access to the crate's generated documentation, use: - -``` -cargo doc --open +let response = default_api::create_notification(&config, notification).await; ``` -## Author +## Full API reference -devrel@onesignal.com +The complete list of API endpoints and their parameters is available in the [DefaultApi documentation](https://github.com/OneSignal/onesignal-rust-api/blob/main/docs/DefaultApi.md). +For the underlying REST API, see the [OneSignal API reference](https://documentation.onesignal.com/reference). diff --git a/docs/ApiKeyToken.md b/docs/ApiKeyToken.md index a698cf9..ae1efb6 100644 --- a/docs/ApiKeyToken.md +++ b/docs/ApiKeyToken.md @@ -11,6 +11,6 @@ Name | Type | Description | Notes **ip_allowlist_mode** | Option<**String**> | | [optional] **ip_allowlist** | Option<**Vec**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/ApiKeyTokensListResponse.md b/docs/ApiKeyTokensListResponse.md index 542e5fc..ff11972 100644 --- a/docs/ApiKeyTokensListResponse.md +++ b/docs/ApiKeyTokensListResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tokens** | Option<[**Vec**](ApiKeyToken.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/App.md b/docs/App.md index 878145d..116f887 100644 --- a/docs/App.md +++ b/docs/App.md @@ -39,6 +39,6 @@ Name | Type | Description | Notes **organization_id** | Option<**String**> | The Id of the Organization you would like to add this app to. | [optional] **additional_data_is_root_payload** | Option<**bool**> | iOS: Notification data (additional data) values will be added to the root of the apns payload when sent to the device. Ignore if you're not using any other plugins, or not using OneSignal SDK methods to read the payload. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/BasicNotification.md b/docs/BasicNotification.md index 0c32133..26fe986 100644 --- a/docs/BasicNotification.md +++ b/docs/BasicNotification.md @@ -119,6 +119,6 @@ Name | Type | Description | Notes **huawei_category** | Option<**String**> | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] **huawei_bi_tag** | Option<**String**> | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/BasicNotificationAllOf.md b/docs/BasicNotificationAllOf.md index 268c4dc..368faf5 100644 --- a/docs/BasicNotificationAllOf.md +++ b/docs/BasicNotificationAllOf.md @@ -106,6 +106,6 @@ Name | Type | Description | Notes **huawei_category** | Option<**String**> | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] **huawei_bi_tag** | Option<**String**> | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/BasicNotificationAllOfAndroidBackgroundLayout.md b/docs/BasicNotificationAllOfAndroidBackgroundLayout.md index 3e596c3..bc2e939 100644 --- a/docs/BasicNotificationAllOfAndroidBackgroundLayout.md +++ b/docs/BasicNotificationAllOfAndroidBackgroundLayout.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **headings_color** | Option<**String**> | Title text color ARGB Hex format. Example(Blue) \"FF0000FF\". | [optional] **contents_color** | Option<**String**> | Body text color ARGB Hex format. Example(Red) \"FFFF0000\". | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/Button.md b/docs/Button.md index 4212bbe..a89efde 100644 --- a/docs/Button.md +++ b/docs/Button.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **text** | Option<**String**> | | [optional] **icon** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CopyTemplateRequest.md b/docs/CopyTemplateRequest.md index 967bdcb..3af264f 100644 --- a/docs/CopyTemplateRequest.md +++ b/docs/CopyTemplateRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **target_app_id** | **String** | Destination OneSignal App ID in UUID v4 format. | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateApiKeyRequest.md b/docs/CreateApiKeyRequest.md index 0281997..4942a25 100644 --- a/docs/CreateApiKeyRequest.md +++ b/docs/CreateApiKeyRequest.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **ip_allowlist_mode** | Option<**String**> | | [optional] **ip_allowlist** | Option<**Vec**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateApiKeyResponse.md b/docs/CreateApiKeyResponse.md index f04a8bb..ef27370 100644 --- a/docs/CreateApiKeyResponse.md +++ b/docs/CreateApiKeyResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **token_id** | Option<**String**> | | [optional] **formatted_token** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateNotificationSuccessResponse.md b/docs/CreateNotificationSuccessResponse.md index 22ca432..21822ee 100644 --- a/docs/CreateNotificationSuccessResponse.md +++ b/docs/CreateNotificationSuccessResponse.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **external_id** | Option<**String**> | | [optional] **errors** | Option<[**serde_json::Value**](.md)> | Errors include the identifiers that are invalid, or that there are no subscribers. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateSegmentConflictResponse.md b/docs/CreateSegmentConflictResponse.md index c21f19f..a3c2f27 100644 --- a/docs/CreateSegmentConflictResponse.md +++ b/docs/CreateSegmentConflictResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **success** | Option<**bool**> | | [optional] **errors** | Option<**Vec**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateSegmentSuccessResponse.md b/docs/CreateSegmentSuccessResponse.md index 25eb980..64c14ce 100644 --- a/docs/CreateSegmentSuccessResponse.md +++ b/docs/CreateSegmentSuccessResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **success** | Option<**bool**> | | [optional] **id** | Option<**String**> | UUID of created segment | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateTemplateRequest.md b/docs/CreateTemplateRequest.md index 57d7d02..35c1422 100644 --- a/docs/CreateTemplateRequest.md +++ b/docs/CreateTemplateRequest.md @@ -13,6 +13,6 @@ Name | Type | Description | Notes **is_sms** | Option<**bool**> | Set true for an SMS template. | [optional] **dynamic_content** | Option<**String**> | JSON string for dynamic content personalization. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateUserConflictResponse.md b/docs/CreateUserConflictResponse.md index 2743125..556cb3b 100644 --- a/docs/CreateUserConflictResponse.md +++ b/docs/CreateUserConflictResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | Option<[**Vec**](CreateUserConflictResponse_errors_inner.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateUserConflictResponseErrorsInner.md b/docs/CreateUserConflictResponseErrorsInner.md index 51f7d86..b65fa16 100644 --- a/docs/CreateUserConflictResponseErrorsInner.md +++ b/docs/CreateUserConflictResponseErrorsInner.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **title** | Option<**String**> | | [optional] **meta** | Option<[**crate::models::CreateUserConflictResponseErrorsItemsMeta**](CreateUserConflictResponse_errorsItems_meta.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CreateUserConflictResponseErrorsItemsMeta.md b/docs/CreateUserConflictResponseErrorsItemsMeta.md index bef872e..8cbb828 100644 --- a/docs/CreateUserConflictResponseErrorsItemsMeta.md +++ b/docs/CreateUserConflictResponseErrorsItemsMeta.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **conflicting_aliases** | Option<[**serde_json::Value**](.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CustomEvent.md b/docs/CustomEvent.md index d687637..69c191c 100644 --- a/docs/CustomEvent.md +++ b/docs/CustomEvent.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **timestamp** | Option<**String**> | Time the event occurred as an ISO8601 formatted string. Defaults to now if not included or past date provided. | [optional] **payload** | Option<[**::std::collections::HashMap**](serde_json::Value.md)> | Properties or data related to the event, like {\"geography\": \"USA\"} | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/CustomEventsRequest.md b/docs/CustomEventsRequest.md index e73a835..17a9ba6 100644 --- a/docs/CustomEventsRequest.md +++ b/docs/CustomEventsRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **events** | [**Vec**](CustomEvent.md) | | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md index 3f6ea0b..f9e806e 100644 --- a/docs/DefaultApi.md +++ b/docs/DefaultApi.md @@ -72,14 +72,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## copy_template_to_app @@ -104,14 +104,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_alias @@ -137,14 +137,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_alias_by_subscription @@ -169,14 +169,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_api_key @@ -200,14 +200,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_app @@ -230,14 +230,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_custom_events @@ -261,14 +261,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_notification @@ -291,14 +291,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_segment @@ -322,14 +322,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_subscription @@ -355,14 +355,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_template @@ -385,14 +385,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## create_user @@ -416,14 +416,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## delete_alias @@ -449,14 +449,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## delete_api_key @@ -480,14 +480,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## delete_segment @@ -511,14 +511,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## delete_subscription @@ -542,14 +542,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## delete_template @@ -573,14 +573,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## delete_user @@ -605,14 +605,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## export_events @@ -636,14 +636,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## export_subscriptions @@ -667,14 +667,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_aliases @@ -699,14 +699,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_aliases_by_subscription @@ -730,14 +730,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_app @@ -760,14 +760,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_apps @@ -787,14 +787,14 @@ This endpoint does not need any parameter. ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_notification @@ -818,14 +818,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_notification_history @@ -849,14 +849,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_notifications @@ -882,14 +882,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_outcomes @@ -917,14 +917,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_segments @@ -949,14 +949,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## get_user @@ -981,14 +981,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## rotate_api_key @@ -1012,14 +1012,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## start_live_activity @@ -1044,14 +1044,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## transfer_subscription @@ -1076,14 +1076,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## unsubscribe_email_with_token @@ -1108,14 +1108,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## update_api_key @@ -1140,14 +1140,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## update_app @@ -1171,14 +1171,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## update_live_activity @@ -1203,14 +1203,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## update_subscription @@ -1235,14 +1235,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## update_subscription_by_token @@ -1268,14 +1268,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## update_template @@ -1300,14 +1300,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## update_user @@ -1333,14 +1333,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## view_api_keys @@ -1363,14 +1363,14 @@ Name | Type | Description | Required | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## view_template @@ -1394,14 +1394,14 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) ## view_templates @@ -1427,12 +1427,12 @@ Name | Type | Description | Required | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-rust-api#configuration) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/DeliveryData.md b/docs/DeliveryData.md index a3c0eda..703455a 100644 --- a/docs/DeliveryData.md +++ b/docs/DeliveryData.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **converted** | Option<**i32**> | Number of messages that were clicked. | [optional] **received** | Option<**i32**> | Number of devices that received the message. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/ExportEventsSuccessResponse.md b/docs/ExportEventsSuccessResponse.md index dc154be..d373b94 100644 --- a/docs/ExportEventsSuccessResponse.md +++ b/docs/ExportEventsSuccessResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **csv_file_url** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/ExportSubscriptionsRequestBody.md b/docs/ExportSubscriptionsRequestBody.md index 5a50219..bdee89e 100644 --- a/docs/ExportSubscriptionsRequestBody.md +++ b/docs/ExportSubscriptionsRequestBody.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **last_active_since** | Option<**String**> | Export all devices with a last_active timestamp greater than this time. Unixtime in seconds. | [optional] **segment_name** | Option<**String**> | Export all devices belonging to the segment. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/ExportSubscriptionsSuccessResponse.md b/docs/ExportSubscriptionsSuccessResponse.md index 3273638..0545a7f 100644 --- a/docs/ExportSubscriptionsSuccessResponse.md +++ b/docs/ExportSubscriptionsSuccessResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **csv_file_url** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/Filter.md b/docs/Filter.md index ab703f7..ea4d8e7 100644 --- a/docs/Filter.md +++ b/docs/Filter.md @@ -13,6 +13,6 @@ Name | Type | Description | Notes **long** | Option<**f32**> | If `field` is `location`, this is *required* to specify the user's longitude. | [optional] **relation** | Option<**String**> | Required. Operator of a filter expression. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/FilterExpression.md b/docs/FilterExpression.md index aca5e32..a142c1f 100644 --- a/docs/FilterExpression.md +++ b/docs/FilterExpression.md @@ -14,6 +14,6 @@ Name | Type | Description | Notes **relation** | Option<**String**> | Required. Operator of a filter expression. | [optional] **operator** | Option<**String**> | Strictly, this must be either `\"OR\"`, or `\"AND\"`. It can be used to compose Filters as part of a Filters object. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/GenericError.md b/docs/GenericError.md index 9d0a8f9..305d308 100644 --- a/docs/GenericError.md +++ b/docs/GenericError.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **success** | Option<**bool**> | | [optional] **reference** | Option<[**serde_json::Value**](.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/GenericSuccessBoolResponse.md b/docs/GenericSuccessBoolResponse.md index fae8618..e9ed2d7 100644 --- a/docs/GenericSuccessBoolResponse.md +++ b/docs/GenericSuccessBoolResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | Option<**bool**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/GetNotificationHistoryRequestBody.md b/docs/GetNotificationHistoryRequestBody.md index 718a25e..1e614c4 100644 --- a/docs/GetNotificationHistoryRequestBody.md +++ b/docs/GetNotificationHistoryRequestBody.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **email** | Option<**String**> | The email address you would like the report sent. | [optional] **app_id** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/GetSegmentsSuccessResponse.md b/docs/GetSegmentsSuccessResponse.md index d95debc..88680b8 100644 --- a/docs/GetSegmentsSuccessResponse.md +++ b/docs/GetSegmentsSuccessResponse.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **limit** | Option<**i32**> | Maximum number of Segments returned. Default 300. | [optional] **segments** | Option<[**Vec**](SegmentData.md)> | An array containing the Segment information. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/LanguageStringMap.md b/docs/LanguageStringMap.md index 264975d..bed3a24 100644 --- a/docs/LanguageStringMap.md +++ b/docs/LanguageStringMap.md @@ -48,6 +48,6 @@ Name | Type | Description | Notes **uk** | Option<**String**> | Text in Ukrainian. | [optional] **vi** | Option<**String**> | Text in Vietnamese. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/Notification.md b/docs/Notification.md index fdecd56..0dbad19 100644 --- a/docs/Notification.md +++ b/docs/Notification.md @@ -120,6 +120,6 @@ Name | Type | Description | Notes **huawei_bi_tag** | Option<**String**> | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] **send_after** | Option<**String**> | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/NotificationAllOf.md b/docs/NotificationAllOf.md index 57848bf..1d32e20 100644 --- a/docs/NotificationAllOf.md +++ b/docs/NotificationAllOf.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **send_after** | Option<**String**> | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/NotificationHistorySuccessResponse.md b/docs/NotificationHistorySuccessResponse.md index dd2e2e0..74f08d9 100644 --- a/docs/NotificationHistorySuccessResponse.md +++ b/docs/NotificationHistorySuccessResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **success** | Option<**bool**> | | [optional] **destination_url** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/NotificationSlice.md b/docs/NotificationSlice.md index a275f6d..81d0ce6 100644 --- a/docs/NotificationSlice.md +++ b/docs/NotificationSlice.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **limit** | Option<**i32**> | | [optional] **notifications** | Option<[**Vec**](NotificationWithMeta.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/NotificationTarget.md b/docs/NotificationTarget.md index 3abda30..8bdadfd 100644 --- a/docs/NotificationTarget.md +++ b/docs/NotificationTarget.md @@ -18,6 +18,6 @@ Name | Type | Description | Notes **include_aliases** | Option<[**::std::collections::HashMap>**](array.md)> | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] **target_channel** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/NotificationWithMeta.md b/docs/NotificationWithMeta.md index 2e4c931..a3156b9 100644 --- a/docs/NotificationWithMeta.md +++ b/docs/NotificationWithMeta.md @@ -131,6 +131,6 @@ Name | Type | Description | Notes **platform_delivery_stats** | Option<[**crate::models::PlatformDeliveryData**](PlatformDeliveryData.md)> | | [optional] **canceled** | Option<**bool**> | Indicates whether the notification was canceled before it could be sent. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/NotificationWithMetaAllOf.md b/docs/NotificationWithMetaAllOf.md index e44e094..91da1c5 100644 --- a/docs/NotificationWithMetaAllOf.md +++ b/docs/NotificationWithMetaAllOf.md @@ -17,6 +17,6 @@ Name | Type | Description | Notes **throttle_rate_per_minute** | Option<**i32**> | number of push notifications sent per minute. Paid Feature Only. If throttling is not enabled for the app or the notification, and for free accounts, null is returned. Refer to Throttling for more details. | [optional] **canceled** | Option<**bool**> | Indicates whether the notification was canceled before it could be sent. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/Operator.md b/docs/Operator.md index 75102c4..6075d65 100644 --- a/docs/Operator.md +++ b/docs/Operator.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operator** | Option<**String**> | Strictly, this must be either `\"OR\"`, or `\"AND\"`. It can be used to compose Filters as part of a Filters object. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/OutcomeData.md b/docs/OutcomeData.md index 2a76f85..b2cde9f 100644 --- a/docs/OutcomeData.md +++ b/docs/OutcomeData.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **value** | **i32** | | **aggregation** | **String** | | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/OutcomesData.md b/docs/OutcomesData.md index eaf72f1..0e06487 100644 --- a/docs/OutcomesData.md +++ b/docs/OutcomesData.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **outcomes** | Option<[**Vec**](OutcomeData.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/PlatformDeliveryData.md b/docs/PlatformDeliveryData.md index 762b618..02a9681 100644 --- a/docs/PlatformDeliveryData.md +++ b/docs/PlatformDeliveryData.md @@ -13,6 +13,6 @@ Name | Type | Description | Notes **sms** | Option<[**crate::models::DeliveryData**](DeliveryData.md)> | | [optional] **email** | Option<[**crate::models::DeliveryData**](DeliveryData.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/PlatformDeliveryDataEmailAllOf.md b/docs/PlatformDeliveryDataEmailAllOf.md index 57e674d..9028c2b 100644 --- a/docs/PlatformDeliveryDataEmailAllOf.md +++ b/docs/PlatformDeliveryDataEmailAllOf.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **reported_spam** | Option<**i32**> | Number of recipients who reported this email as spam. | [optional] **unsubscribed** | Option<**i32**> | Number of recipients who opted out of your emails using the unsubscribe link in this email. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/PlatformDeliveryDataSmsAllOf.md b/docs/PlatformDeliveryDataSmsAllOf.md index e7f7958..058c339 100644 --- a/docs/PlatformDeliveryDataSmsAllOf.md +++ b/docs/PlatformDeliveryDataSmsAllOf.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **provider_failed** | Option<**i32**> | Number of recipients who didn't receive your message as reported by the SMS service provider. | [optional] **provider_errored** | Option<**i32**> | Number of errors reported by the SMS service provider. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/PropertiesBody.md b/docs/PropertiesBody.md index 55cc034..500460b 100644 --- a/docs/PropertiesBody.md +++ b/docs/PropertiesBody.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **properties** | Option<[**crate::models::PropertiesObject**](PropertiesObject.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/PropertiesDeltas.md b/docs/PropertiesDeltas.md index 818c452..5d15b56 100644 --- a/docs/PropertiesDeltas.md +++ b/docs/PropertiesDeltas.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **session_count** | Option<**i32**> | | [optional] **purchases** | Option<[**Vec**](Purchase.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/PropertiesObject.md b/docs/PropertiesObject.md index 90958ad..74aacbf 100644 --- a/docs/PropertiesObject.md +++ b/docs/PropertiesObject.md @@ -16,6 +16,6 @@ Name | Type | Description | Notes **purchases** | Option<[**Vec**](Purchase.md)> | | [optional] **ip** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/Purchase.md b/docs/Purchase.md index aa2363b..b01fd4d 100644 --- a/docs/Purchase.md +++ b/docs/Purchase.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **iso** | **String** | The 3-letter ISO 4217 currency code. Required for correct storage and conversion of amount. | **count** | Option<**i32**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/RateLimitError.md b/docs/RateLimitError.md index 5d091b4..b14f4a3 100644 --- a/docs/RateLimitError.md +++ b/docs/RateLimitError.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **errors** | Option<**Vec**> | | [optional] **limit** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/Segment.md b/docs/Segment.md index 126cfa8..6c4582d 100644 --- a/docs/Segment.md +++ b/docs/Segment.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **name** | **String** | Name of the segment. You'll see this name on the Web UI. | **filters** | [**Vec**](FilterExpression.md) | Filter or operators the segment will have. For a list of available filters with details, please see Send to Users Based on Filters. | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/SegmentData.md b/docs/SegmentData.md index ad5ecd4..4aaf2ca 100644 --- a/docs/SegmentData.md +++ b/docs/SegmentData.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **read_only** | Option<**bool**> | Is the segment read only? | [optional] **is_active** | Option<**bool**> | Is the segment active? | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/SegmentNotificationTarget.md b/docs/SegmentNotificationTarget.md index 7d894b8..e5bc9e4 100644 --- a/docs/SegmentNotificationTarget.md +++ b/docs/SegmentNotificationTarget.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **included_segments** | Option<**Vec**> | The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [\"Active Users\", \"Inactive Users\"] | [optional] **excluded_segments** | Option<**Vec**> | Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\"Active Users\", \"Inactive Users\"] | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/StartLiveActivityRequest.md b/docs/StartLiveActivityRequest.md index 52f1f37..2bbbe92 100644 --- a/docs/StartLiveActivityRequest.md +++ b/docs/StartLiveActivityRequest.md @@ -21,6 +21,6 @@ Name | Type | Description | Notes **excluded_segments** | Option<**Vec**> | Segment names to exclude. Only compatible with included_segments. | [optional] **filters** | Option<[**Vec**](FilterExpression.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/StartLiveActivitySuccessResponse.md b/docs/StartLiveActivitySuccessResponse.md index 1afdecf..9af1b44 100644 --- a/docs/StartLiveActivitySuccessResponse.md +++ b/docs/StartLiveActivitySuccessResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **notification_id** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/Subscription.md b/docs/Subscription.md index add42aa..5953245 100644 --- a/docs/Subscription.md +++ b/docs/Subscription.md @@ -22,6 +22,6 @@ Name | Type | Description | Notes **web_auth** | Option<**String**> | | [optional] **web_p256** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/SubscriptionBody.md b/docs/SubscriptionBody.md index 7859393..4a59e73 100644 --- a/docs/SubscriptionBody.md +++ b/docs/SubscriptionBody.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **subscription** | Option<[**crate::models::Subscription**](Subscription.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/SubscriptionNotificationTarget.md b/docs/SubscriptionNotificationTarget.md index 6c17556..2476099 100644 --- a/docs/SubscriptionNotificationTarget.md +++ b/docs/SubscriptionNotificationTarget.md @@ -16,6 +16,6 @@ Name | Type | Description | Notes **include_aliases** | Option<[**::std::collections::HashMap>**](array.md)> | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] **target_channel** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/TemplateResource.md b/docs/TemplateResource.md index dd1ecac..efdcc06 100644 --- a/docs/TemplateResource.md +++ b/docs/TemplateResource.md @@ -11,6 +11,6 @@ Name | Type | Description | Notes **channel** | Option<**String**> | | [optional] **content** | Option<[**::std::collections::HashMap**](serde_json::Value.md)> | Rendered content and channel/platform flags for the template. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/TemplatesListResponse.md b/docs/TemplatesListResponse.md index 4cb7b98..a36f77b 100644 --- a/docs/TemplatesListResponse.md +++ b/docs/TemplatesListResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **templates** | Option<[**Vec**](TemplateResource.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/TransferSubscriptionRequestBody.md b/docs/TransferSubscriptionRequestBody.md index 1a70fdb..4946220 100644 --- a/docs/TransferSubscriptionRequestBody.md +++ b/docs/TransferSubscriptionRequestBody.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identity** | Option<**::std::collections::HashMap**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/UpdateApiKeyRequest.md b/docs/UpdateApiKeyRequest.md index acd3a4e..c44f001 100644 --- a/docs/UpdateApiKeyRequest.md +++ b/docs/UpdateApiKeyRequest.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **ip_allowlist_mode** | Option<**String**> | | [optional] **ip_allowlist** | Option<**Vec**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/UpdateLiveActivityRequest.md b/docs/UpdateLiveActivityRequest.md index 3b0173d..0437646 100644 --- a/docs/UpdateLiveActivityRequest.md +++ b/docs/UpdateLiveActivityRequest.md @@ -14,6 +14,6 @@ Name | Type | Description | Notes **dismissal_date** | Option<**i32**> | Accepts Unix timestamp in seconds; only allowed if event is \"end\" | [optional] **priority** | Option<**i32**> | Delivery priority through the the push provider (APNs). Pass 10 for higher priority notifications, or 5 for lower priority notifications. Lower priority notifications are sent based on the power considerations of the end user's device. If not set, defaults to 10. Some providers (APNs) allow for a limited budget of high priority notifications per hour, and if that budget is exceeded, the provider may throttle notification delivery. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/UpdateLiveActivitySuccessResponse.md b/docs/UpdateLiveActivitySuccessResponse.md index bc1f7ef..290644d 100644 --- a/docs/UpdateLiveActivitySuccessResponse.md +++ b/docs/UpdateLiveActivitySuccessResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/UpdateTemplateRequest.md b/docs/UpdateTemplateRequest.md index 38a938e..d070f26 100644 --- a/docs/UpdateTemplateRequest.md +++ b/docs/UpdateTemplateRequest.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **is_sms** | Option<**bool**> | Set true for an SMS template. | [optional] **dynamic_content** | Option<**String**> | JSON string for dynamic content personalization. | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/UpdateUserRequest.md b/docs/UpdateUserRequest.md index bc147b9..74d33c4 100644 --- a/docs/UpdateUserRequest.md +++ b/docs/UpdateUserRequest.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **refresh_device_metadata** | Option<**bool**> | | [optional][default to false] **deltas** | Option<[**crate::models::PropertiesDeltas**](PropertiesDeltas.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/User.md b/docs/User.md index 75f1b97..60daf35 100644 --- a/docs/User.md +++ b/docs/User.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **identity** | Option<**::std::collections::HashMap**> | | [optional] **subscriptions** | Option<[**Vec**](Subscription.md)> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/UserIdentityBody.md b/docs/UserIdentityBody.md index 6f08fea..342b0ab 100644 --- a/docs/UserIdentityBody.md +++ b/docs/UserIdentityBody.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identity** | Option<**::std::collections::HashMap**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api) diff --git a/docs/WebButton.md b/docs/WebButton.md index b3299ba..997da4a 100644 --- a/docs/WebButton.md +++ b/docs/WebButton.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **icon** | Option<**String**> | | [optional] **url** | Option<**String**> | | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-rust-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-rust-api)