notifo-io 1.0.1 → 1.0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d062b4c430988329a313e8aa0c77ab40c55e9309b571e996c2e1871aeb51173
-  data.tar.gz: 35fc9503fb989aab8d97bcf3e621c711f3d2115fade957367655d26660a09343
+  metadata.gz: d1b2be9e3dc4d74499c621ebfb4cbc073aaa28a3044195bb8aa828f7ab4dfab9
+  data.tar.gz: 1f214ae9cca32fb3a33d9d25913dc76d825a9fbb0b62a357a76b07520f91398c
 SHA512:
-  metadata.gz: 2b7663aef8fb5f0adf76040913ac9f4f10c999d3fbd6c57d56e26b5e6f5c3332b6377c4523e40c7612babbee06a3ddb260c22922e0184f7359ecd06aff2ece92
-  data.tar.gz: cdadaedfe34a5a6214e96029857160fb9ad457d0d327093aaae94b4242fa9ffa247d6fc9666dcfa68b16e96f7161a02073304432e91d9c5abf6333cd5356a55d
+  metadata.gz: e5f9d6fbc13c6519661d7467fac4f05039d6712a1dfc3f3096cabb31b890ef60bb486b2e97522f668275d61a24d014c9c7f3afa6a1efb8abf126832ef91292e6
+  data.tar.gz: 272bd439c40a480cd1bbed86bcbba7607f33fab365aaca786338ca3befd0c08a907339cbb9288356af8ee8c52bd984078d01c0850ee7904d0d5c9016234fec40

data/README.md

@@ -2,13 +2,13 @@
 
 Notifo - the Ruby gem for the Notifo API
 
-No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.0
 - Package version: 1.0.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
 
 ## Installation
 
@@ -25,7 +25,6 @@ Then either install the gem locally:
 ```shell
 gem install ./notifo-1.0.0.gem
 ```
-
 (for development, run `gem install --dev ./notifo-1.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
@@ -51,7 +50,6 @@ ruby -Ilib script.rb
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
-
 ```ruby
 # Load the gem
 require 'notifo'
@@ -60,6 +58,7 @@ api_instance = Notifo::AppsApi.new
 app_id = 'app_id_example' # String | The id of the app.
 contributor_id = 'contributor_id_example' # String | The contributor to remove.
 
+
 begin
   #Delete an app contributor.
   result = api_instance.apps_delete_contributor(app_id, contributor_id)
@@ -68,11 +67,511 @@ rescue Notifo::ApiError => e
   puts "Exception when calling AppsApi->apps_delete_contributor: #{e}"
 end
 
+api_instance = Notifo::AppsApi.new
+app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Delete an app email template.
+  api_instance.apps_delete_email_template(app_id, language)
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_delete_email_template: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+app_id = 'app_id_example' # String | The id of the app.
+
+
+begin
+  #Get app by id.
+  result = api_instance.apps_get_app(app_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_get_app: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+
+begin
+  #Get the user apps.
+  result = api_instance.apps_get_apps
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_get_apps: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
+
+
+begin
+  #Get the app email templates.
+  result = api_instance.apps_get_email_templates(app_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_get_email_templates: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
+
+
+begin
+  #Create an app.
+  result = api_instance.apps_post_app(body)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_post_app: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+body = Notifo::AddContributorDto.new # AddContributorDto | The request object.
+app_id = 'app_id_example' # String | The id of the app.
+
+
+begin
+  #Add an app contributor.
+  result = api_instance.apps_post_contributor(body, app_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_post_contributor: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+body = Notifo::CreateEmailTemplateDto.new # CreateEmailTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
+
+
+begin
+  #Create an app email template.
+  result = api_instance.apps_post_email_template(body, app_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_post_email_template: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
+app_id = 'app_id_example' # String | The app id to update.
+
+
+begin
+  #Update an app.
+  result = api_instance.apps_put_app(body, app_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_put_app: #{e}"
+end
+
+api_instance = Notifo::AppsApi.new
+body = Notifo::EmailTemplateDto.new # EmailTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Update an app email template.
+  api_instance.apps_put_email_template(body, app_id, language)
+rescue Notifo::ApiError => e
+  puts "Exception when calling AppsApi->apps_put_email_template: #{e}"
+end
+
+api_instance = Notifo::ConfigsApi.new
+
+begin
+  #Get all supported languages.
+  result = api_instance.configs_get_languages
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling ConfigsApi->configs_get_languages: #{e}"
+end
+
+api_instance = Notifo::ConfigsApi.new
+
+begin
+  #Get all supported timezones.
+  result = api_instance.configs_get_timezones
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling ConfigsApi->configs_get_timezones: #{e}"
+end
+
+api_instance = Notifo::EventsApi.new
+app_id = 'app_id_example' # String | The app where the events belongs to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Query events.
+  result = api_instance.events_get_events(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling EventsApi->events_get_events: #{e}"
+end
+
+api_instance = Notifo::EventsApi.new
+body = Notifo::PublishManyDto.new # PublishManyDto | The publish request.
+app_id = 'app_id_example' # String | The app where the events belongs to.
+
+
+begin
+  #Publish events.
+  api_instance.events_post_events(body, app_id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling EventsApi->events_post_events: #{e}"
+end
+
+api_instance = Notifo::LogsApi.new
+app_id = 'app_id_example' # String | The app where the log entries belongs to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Query log entries.
+  result = api_instance.logs_get_logs(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling LogsApi->logs_get_logs: #{e}"
+end
+
+api_instance = Notifo::MediaApi.new
+app_id = 'app_id_example' # String | The app id where the media belongs to.
+file_name = 'file_name_example' # String | The file name of the media.
+
+
+begin
+  #Delete a media.
+  api_instance.media_delete(app_id, file_name)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MediaApi->media_delete: #{e}"
+end
+
+api_instance = Notifo::MediaApi.new
+app_id = 'app_id_example' # String | The app id where the media belongs to.
+file_name = 'file_name_example' # String | The name of the media to download.
+opts = { 
+  cache: 789, # Integer | The cache duration.
+  download: 56, # Integer | Set it to 1 to create a download response.
+  width: 56, # Integer | The target width when an image.
+  height: 56, # Integer | The target height when an image.
+  quality: 56, # Integer | The target quality when an image.
+  preset: 'preset_example', # String | A preset dimension.
+  mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
+  focus_x: 3.4, # Float | The x position of the focues point.
+  focus_y: 3.4, # Float | The y position of the focues point.
+  force: true # BOOLEAN | True to resize it and clear the cache.
+}
+
+begin
+  #Download a media object.
+  result = api_instance.media_download(app_id, file_name, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MediaApi->media_download: #{e}"
+end
+
+api_instance = Notifo::MediaApi.new
+app_id = 'app_id_example' # String | The app id where the media belongs to.
+file_name = 'file_name_example' # String | The name of the media to download.
+opts = { 
+  cache: 789, # Integer | The cache duration.
+  download: 56, # Integer | Set it to 1 to create a download response.
+  width: 56, # Integer | The target width when an image.
+  height: 56, # Integer | The target height when an image.
+  quality: 56, # Integer | The target quality when an image.
+  preset: 'preset_example', # String | A preset dimension.
+  mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
+  focus_x: 3.4, # Float | The x position of the focues point.
+  focus_y: 3.4, # Float | The y position of the focues point.
+  force: true # BOOLEAN | True to resize it and clear the cache.
+}
+
+begin
+  #Download a media object.
+  result = api_instance.media_download2(app_id, file_name, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MediaApi->media_download2: #{e}"
+end
+
+api_instance = Notifo::MediaApi.new
+app_id = 'app_id_example' # String | The app where the media belongs to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Query media items.
+  result = api_instance.media_get_medias(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MediaApi->media_get_medias: #{e}"
+end
+
+api_instance = Notifo::MediaApi.new
+app_id = 'app_id_example' # String | The app id where the media belongs to.
+opts = { 
+  file: 'file_example' # String | 
+}
+
+begin
+  #Upload a media object.
+  api_instance.media_upload(app_id, opts)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MediaApi->media_upload: #{e}"
+end
+
+api_instance = Notifo::TemplatesApi.new
+app_id = 'app_id_example' # String | The app where the templates belong to.
+code = 'code_example' # String | The template code to delete.
+
+
+begin
+  #Delete a template.
+  result = api_instance.templates_delete_template(app_id, code)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling TemplatesApi->templates_delete_template: #{e}"
+end
+
+api_instance = Notifo::TemplatesApi.new
+app_id = 'app_id_example' # String | The app where the templates belongs to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Query templates.
+  result = api_instance.templates_get_templates(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling TemplatesApi->templates_get_templates: #{e}"
+end
+
+api_instance = Notifo::TemplatesApi.new
+body = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
+app_id = 'app_id_example' # String | The app where the templates belong to.
+
+
+begin
+  #Upsert templates.
+  result = api_instance.templates_post_templates(body, app_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling TemplatesApi->templates_post_templates: #{e}"
+end
+
+api_instance = Notifo::TopicsApi.new
+app_id = 'app_id_example' # String | The app where the topics belongs to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Query topics.
+  result = api_instance.topics_get_topics(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling TopicsApi->topics_get_topics: #{e}"
+end
+
+api_instance = Notifo::UserApi.new
+topic = 'topic_example' # String | The topic path.
+
+
+begin
+  #Deletes a user subscription.
+  api_instance.user_delete_subscription(topic)
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_delete_subscription: #{e}"
+end
+
+api_instance = Notifo::UserApi.new
+topic = 'topic_example' # String | The topic path.
+
+
+begin
+  #Gets a user subscription.
+  result = api_instance.user_get_subscription(topic)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_get_subscription: #{e}"
+end
+
+api_instance = Notifo::UserApi.new
+
+begin
+  #Get the current user.
+  result = api_instance.user_get_user
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_get_user: #{e}"
+end
+
+api_instance = Notifo::UserApi.new
+body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription settings.
+
+
+begin
+  #Creates a user subscription.
+  api_instance.user_post_subscription(body)
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_post_subscription: #{e}"
+end
+
+api_instance = Notifo::UserApi.new
+body = Notifo::UpdateProfileDto.new # UpdateProfileDto | The upsert request.
+
+
+begin
+  #Update the user.
+  result = api_instance.user_post_user(body)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_post_user: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users belong to.
+id = 'id_example' # String | The user id.
+prefix = 'prefix_example' # String | The topic prefix.
+
+
+begin
+  #Remove an allowed topic.
+  api_instance.users_delete_allowed_topic(app_id, id, prefix)
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_delete_allowed_topic: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+prefix = 'prefix_example' # String | The topic prefix.
+
+
+begin
+  #Remove a user subscriptions.
+  api_instance.users_delete_subscription(app_id, id, prefix)
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_delete_subscription: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users belongs to.
+id = 'id_example' # String | The user id to delete.
+
+
+begin
+  #Delete a user.
+  result = api_instance.users_delete_user(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_delete_user: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Query user subscriptions.
+  result = api_instance.users_get_subscriptions(app_id, id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_get_subscriptions: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+
+
+begin
+  #Get a user.
+  result = api_instance.users_get_user(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_get_user: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users belongs to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Query users.
+  result = api_instance.users_get_users(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_get_users: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+body = Notifo::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
+app_id = 'app_id_example' # String | The app where the users belong to.
+id = 'id_example' # String | The user id.
+
+
+begin
+  #Add an allowed topic.
+  api_instance.users_post_allowed_topic(body, app_id, id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_post_allowed_topic: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription object.
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+
+
+begin
+  #Upsert a user subscriptions.
+  api_instance.users_post_subscription(body, app_id, id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_post_subscription: #{e}"
+end
+
+api_instance = Notifo::UsersApi.new
+body = Notifo::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
+app_id = 'app_id_example' # String | The app where the users belong to.
+
+
+begin
+  #Upsert users.
+  result = api_instance.users_post_users(body, app_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UsersApi->users_post_users: #{e}"
+end
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://app.notifo.io*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -115,7 +614,6 @@ Class | Method | HTTP request | Description
 *Notifo::UsersApi* | [**users_post_subscription**](docs/UsersApi.md#users_post_subscription) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upsert a user subscriptions.
 *Notifo::UsersApi* | [**users_post_users**](docs/UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users.
 
-
 ## Documentation for Models
 
  - [Notifo::AddAllowedTopicDto](docs/AddAllowedTopicDto.md)
@@ -123,12 +621,15 @@ Class | Method | HTTP request | Description
  - [Notifo::AppContributorDto](docs/AppContributorDto.md)
  - [Notifo::AppDetailsDto](docs/AppDetailsDto.md)
  - [Notifo::AppDto](docs/AppDto.md)
+ - [Notifo::Body](docs/Body.md)
  - [Notifo::ConfirmMode](docs/ConfirmMode.md)
  - [Notifo::CreateEmailTemplateDto](docs/CreateEmailTemplateDto.md)
  - [Notifo::EmailTemplateDto](docs/EmailTemplateDto.md)
+ - [Notifo::EmailTemplatesDto](docs/EmailTemplatesDto.md)
  - [Notifo::EmailVerificationStatus](docs/EmailVerificationStatus.md)
  - [Notifo::ErrorDto](docs/ErrorDto.md)
  - [Notifo::EventDto](docs/EventDto.md)
+ - [Notifo::EventProperties](docs/EventProperties.md)
  - [Notifo::IsoDayOfWeek](docs/IsoDayOfWeek.md)
  - [Notifo::ListResponseDtoOfEventDto](docs/ListResponseDtoOfEventDto.md)
  - [Notifo::ListResponseDtoOfLogEntryDto](docs/ListResponseDtoOfLogEntryDto.md)
@@ -137,8 +638,10 @@ Class | Method | HTTP request | Description
  - [Notifo::ListResponseDtoOfTemplateDto](docs/ListResponseDtoOfTemplateDto.md)
  - [Notifo::ListResponseDtoOfTopicDto](docs/ListResponseDtoOfTopicDto.md)
  - [Notifo::ListResponseDtoOfUserDto](docs/ListResponseDtoOfUserDto.md)
+ - [Notifo::LocalizedText](docs/LocalizedText.md)
  - [Notifo::LogEntryDto](docs/LogEntryDto.md)
  - [Notifo::MediaDto](docs/MediaDto.md)
+ - [Notifo::MediaMetadata](docs/MediaMetadata.md)
  - [Notifo::MediaType](docs/MediaType.md)
  - [Notifo::NotificationFormattingDto](docs/NotificationFormattingDto.md)
  - [Notifo::NotificationSend](docs/NotificationSend.md)
@@ -160,7 +663,6 @@ Class | Method | HTTP request | Description
  - [Notifo::UpsertUsersDto](docs/UpsertUsersDto.md)
  - [Notifo::UserDto](docs/UserDto.md)
 
-
 ## Documentation for Authorization
 
  All endpoints do not require authorization.