Module: ArtikCloud

Defined in:
lib/artikcloud/version.rb,
lib/artikcloud.rb,
lib/artikcloud/api_error.rb,
lib/artikcloud/api_client.rb,
lib/artikcloud/models/tag.rb,
lib/artikcloud/models/task.rb,
lib/artikcloud/models/tier.rb,
lib/artikcloud/models/user.rb,
lib/artikcloud/api/tags_api.rb,
lib/artikcloud/models/token.rb,
lib/artikcloud/api/rules_api.rb,
lib/artikcloud/api/users_api.rb,
lib/artikcloud/configuration.rb,
lib/artikcloud/models/action.rb,
lib/artikcloud/models/device.rb,
lib/artikcloud/api/export_api.rb,
lib/artikcloud/api/tokens_api.rb,
lib/artikcloud/models/actions.rb,
lib/artikcloud/models/message.rb,
lib/artikcloud/api/devices_api.rb,
lib/artikcloud/api/messages_api.rb,
lib/artikcloud/models/action_in.rb,
lib/artikcloud/models/tag_array.rb,
lib/artikcloud/models/task_list.rb,
lib/artikcloud/models/whitelist.rb,
lib/artikcloud/models/action_out.rb,
lib/artikcloud/models/field_path.rb,
lib/artikcloud/models/message_id.rb,
lib/artikcloud/models/message_in.rb,
lib/artikcloud/models/rule_array.rb,
lib/artikcloud/models/rule_error.rb,
lib/artikcloud/models/token_info.rb,
lib/artikcloud/models/device_task.rb,
lib/artikcloud/models/device_type.rb,
lib/artikcloud/models/export_data.rb,
lib/artikcloud/models/message_out.rb,
lib/artikcloud/models/output_rule.rb,
lib/artikcloud/models/task_by_did.rb,
lib/artikcloud/models/task_status.rb,
lib/artikcloud/models/ack_envelope.rb,
lib/artikcloud/models/action_array.rb,
lib/artikcloud/models/contact_info.rb,
lib/artikcloud/models/device_array.rb,
lib/artikcloud/models/device_token.rb,
lib/artikcloud/models/subscription.rb,
lib/artikcloud/models/task_history.rb,
lib/artikcloud/models/task_request.rb,
lib/artikcloud/models/upgrade_path.rb,
lib/artikcloud/api/device_types_api.rb,
lib/artikcloud/api/monetization_api.rb,
lib/artikcloud/api/whitelisting_api.rb,
lib/artikcloud/models/device_status.rb,
lib/artikcloud/models/notif_message.rb,
lib/artikcloud/models/rule_envelope.rb,
lib/artikcloud/models/tags_envelope.rb,
lib/artikcloud/models/task_envelope.rb,
lib/artikcloud/models/task_statuses.rb,
lib/artikcloud/models/token_request.rb,
lib/artikcloud/models/user_envelope.rb,
lib/artikcloud/api/registrations_api.rb,
lib/artikcloud/api/subscriptions_api.rb,
lib/artikcloud/models/action_details.rb,
lib/artikcloud/models/aggregate_data.rb,
lib/artikcloud/models/app_properties.rb,
lib/artikcloud/models/certificate_id.rb,
lib/artikcloud/models/device_sharing.rb,
lib/artikcloud/models/error_envelope.rb,
lib/artikcloud/models/export_request.rb,
lib/artikcloud/models/field_presence.rb,
lib/artikcloud/models/fields_actions.rb,
lib/artikcloud/models/message_action.rb,
lib/artikcloud/models/presence_model.rb,
lib/artikcloud/models/rules_envelope.rb,
lib/artikcloud/models/token_response.rb,
lib/artikcloud/api/devices_shares_api.rb,
lib/artikcloud/api/devices_status_api.rb,
lib/artikcloud/models/acknowledgement.rb,
lib/artikcloud/models/device_envelope.rb,
lib/artikcloud/models/event_feed_data.rb,
lib/artikcloud/models/export_response.rb,
lib/artikcloud/models/task_parameters.rb,
lib/artikcloud/models/validity_period.rb,
lib/artikcloud/models/certificate_data.rb,
lib/artikcloud/models/device_type_info.rb,
lib/artikcloud/models/devices_envelope.rb,
lib/artikcloud/models/non_empty_string.rb,
lib/artikcloud/models/register_message.rb,
lib/artikcloud/models/rejected_csv_row.rb,
lib/artikcloud/models/rule_update_info.rb,
lib/artikcloud/models/task_by_did_list.rb,
lib/artikcloud/models/web_socket_error.rb,
lib/artikcloud/models/device_share_info.rb,
lib/artikcloud/models/device_sharing_id.rb,
lib/artikcloud/models/device_status_put.rb,
lib/artikcloud/models/device_type_array.rb,
lib/artikcloud/models/device_types_info.rb,
lib/artikcloud/models/export_data_array.rb,
lib/artikcloud/models/manifest_versions.rb,
lib/artikcloud/models/metadata_envelope.rb,
lib/artikcloud/models/normalized_action.rb,
lib/artikcloud/models/presence_envelope.rb,
lib/artikcloud/models/snapshot_response.rb,
lib/artikcloud/models/subscription_info.rb,
lib/artikcloud/models/task_history_list.rb,
lib/artikcloud/models/update_parameters.rb,
lib/artikcloud/models/certificate_fields.rb,
lib/artikcloud/models/device_status_data.rb,
lib/artikcloud/models/normalized_message.rb,
lib/artikcloud/models/rule_creation_info.rb,
lib/artikcloud/models/snapshot_responses.rb,
lib/artikcloud/models/subscription_array.rb,
lib/artikcloud/models/task_list_envelope.rb,
lib/artikcloud/models/task_status_counts.rb,
lib/artikcloud/models/upload_id_envelope.rb,
lib/artikcloud/models/whitelist_envelope.rb,
lib/artikcloud/api/devices_management_api.rb,
lib/artikcloud/models/aggregates_response.rb,
lib/artikcloud/models/check_token_message.rb,
lib/artikcloud/models/device_pricing_tier.rb,
lib/artikcloud/models/device_status_batch.rb,
lib/artikcloud/models/export_request_data.rb,
lib/artikcloud/models/export_request_info.rb,
lib/artikcloud/models/manifest_properties.rb,
lib/artikcloud/models/message_id_envelope.rb,
lib/artikcloud/models/notif_message_array.rb,
lib/artikcloud/models/properties_envelope.rb,
lib/artikcloud/models/rule_warning_output.rb,
lib/artikcloud/models/task_update_request.rb,
lib/artikcloud/models/tasks_status_counts.rb,
lib/artikcloud/models/action_details_array.rb,
lib/artikcloud/models/certificate_envelope.rb,
lib/artikcloud/models/check_token_response.rb,
lib/artikcloud/models/device_pricing_tiers.rb,
lib/artikcloud/models/device_sharing_array.rb,
lib/artikcloud/models/device_type_envelope.rb,
lib/artikcloud/models/task_update_response.rb,
lib/artikcloud/models/device_token_envelope.rb,
lib/artikcloud/models/device_types_envelope.rb,
lib/artikcloud/models/subscription_envelope.rb,
lib/artikcloud/models/upgrade_path_envelope.rb,
lib/artikcloud/models/device_status_put_data.rb,
lib/artikcloud/models/export_status_response.rb,
lib/artikcloud/models/refresh_token_response.rb,
lib/artikcloud/models/subscriptions_envelope.rb,
lib/artikcloud/models/task_statuses_envelope.rb,
lib/artikcloud/models/upload_status_envelope.rb,
lib/artikcloud/models/device_sharing_envelope.rb,
lib/artikcloud/models/export_history_response.rb,
lib/artikcloud/models/export_request_response.rb,
lib/artikcloud/models/field_presence_envelope.rb,
lib/artikcloud/models/metadata_query_envelope.rb,
lib/artikcloud/models/notif_messages_response.rb,
lib/artikcloud/models/upgrade_path_user_token.rb,
lib/artikcloud/models/device_type_pricing_list.rb,
lib/artikcloud/models/device_type_pricing_tier.rb,
lib/artikcloud/models/device_type_update_input.rb,
lib/artikcloud/models/validation_callback_info.rb,
lib/artikcloud/models/aggregates_histogram_data.rb,
lib/artikcloud/models/device_type_info_envelope.rb,
lib/artikcloud/models/task_by_did_list_envelope.rb,
lib/artikcloud/models/whitelist_result_envelope.rb,
lib/artikcloud/models/device_reg_status_response.rb,
lib/artikcloud/models/device_task_update_request.rb,
lib/artikcloud/models/device_types_info_envelope.rb,
lib/artikcloud/models/manifest_versions_envelope.rb,
lib/artikcloud/models/rejected_csv_rows_envelope.rb,
lib/artikcloud/models/unregister_device_response.rb,
lib/artikcloud/models/device_pricing_tier_request.rb,
lib/artikcloud/models/device_reg_complete_request.rb,
lib/artikcloud/models/device_task_update_response.rb,
lib/artikcloud/models/normalized_actions_envelope.rb,
lib/artikcloud/models/snapshots_response_envelope.rb,
lib/artikcloud/models/token_info_success_response.rb,
lib/artikcloud/models/device_pricing_tier_envelope.rb,
lib/artikcloud/models/manifest_properties_envelope.rb,
lib/artikcloud/models/metadata_properties_envelope.rb,
lib/artikcloud/models/normalized_messages_envelope.rb,
lib/artikcloud/models/aggregates_histogram_response.rb,
lib/artikcloud/models/device_pricing_tiers_envelope.rb,
lib/artikcloud/models/task_statuses_history_envelope.rb,
lib/artikcloud/models/device_reg_confirm_user_request.rb,
lib/artikcloud/models/device_reg_confirm_user_response.rb,
lib/artikcloud/models/upgrade_path_user_token_envelope.rb,
lib/artikcloud/models/device_type_pricing_tiers_envelope.rb,
lib/artikcloud/models/device_reg_status_response_envelope.rb,
lib/artikcloud/models/export_normalized_messages_response.rb,
lib/artikcloud/models/unregister_device_response_envelope.rb,
lib/artikcloud/models/device_reg_confirm_user_response_envelope.rb

Overview

#ARTIK Cloud API

#No description provided (generated by Swagger Codegen github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.0.0

Generated by: github.com/swagger-api/swagger-codegen.git

Defined Under Namespace

Classes: AckEnvelope, Acknowledgement, Action, ActionArray, ActionDetails, ActionDetailsArray, ActionIn, ActionOut, Actions, AggregateData, AggregatesHistogramData, AggregatesHistogramResponse, AggregatesResponse, ApiClient, ApiError, AppProperties, CertificateData, CertificateEnvelope, CertificateFields, CertificateId, CheckTokenMessage, CheckTokenResponse, Configuration, ContactInfo, Device, DeviceArray, DeviceEnvelope, DevicePricingTier, DevicePricingTierEnvelope, DevicePricingTierRequest, DevicePricingTiers, DevicePricingTiersEnvelope, DeviceRegCompleteRequest, DeviceRegConfirmUserRequest, DeviceRegConfirmUserResponse, DeviceRegConfirmUserResponseEnvelope, DeviceRegStatusResponse, DeviceRegStatusResponseEnvelope, DeviceShareInfo, DeviceSharing, DeviceSharingArray, DeviceSharingEnvelope, DeviceSharingId, DeviceStatus, DeviceStatusBatch, DeviceStatusData, DeviceStatusPut, DeviceStatusPutData, DeviceTask, DeviceTaskUpdateRequest, DeviceTaskUpdateResponse, DeviceToken, DeviceTokenEnvelope, DeviceType, DeviceTypeArray, DeviceTypeEnvelope, DeviceTypeInfo, DeviceTypeInfoEnvelope, DeviceTypePricingList, DeviceTypePricingTier, DeviceTypePricingTiersEnvelope, DeviceTypeUpdateInput, DeviceTypesApi, DeviceTypesEnvelope, DeviceTypesInfo, DeviceTypesInfoEnvelope, DevicesApi, DevicesEnvelope, DevicesManagementApi, DevicesSharesApi, DevicesStatusApi, ErrorEnvelope, EventFeedData, ExportApi, ExportData, ExportDataArray, ExportHistoryResponse, ExportNormalizedMessagesResponse, ExportRequest, ExportRequestData, ExportRequestInfo, ExportRequestResponse, ExportResponse, ExportStatusResponse, FieldPath, FieldPresence, FieldPresenceEnvelope, FieldsActions, ManifestProperties, ManifestPropertiesEnvelope, ManifestVersions, ManifestVersionsEnvelope, Message, MessageAction, MessageID, MessageIDEnvelope, MessageIn, MessageOut, MessagesApi, MetadataEnvelope, MetadataPropertiesEnvelope, MetadataQueryEnvelope, MonetizationApi, NonEmptyString, NormalizedAction, NormalizedActionsEnvelope, NormalizedMessage, NormalizedMessagesEnvelope, NotifMessage, NotifMessageArray, NotifMessagesResponse, OutputRule, PresenceEnvelope, PresenceModel, PropertiesEnvelope, RefreshTokenResponse, RegisterMessage, RegistrationsApi, RejectedCSVRow, RejectedCSVRowsEnvelope, RuleArray, RuleCreationInfo, RuleEnvelope, RuleError, RuleUpdateInfo, RuleWarningOutput, RulesApi, RulesEnvelope, SnapshotResponse, SnapshotResponses, SnapshotsResponseEnvelope, Subscription, SubscriptionArray, SubscriptionEnvelope, SubscriptionInfo, SubscriptionsApi, SubscriptionsEnvelope, Tag, TagArray, TagsApi, TagsEnvelope, Task, TaskByDid, TaskByDidList, TaskByDidListEnvelope, TaskEnvelope, TaskHistory, TaskHistoryList, TaskList, TaskListEnvelope, TaskParameters, TaskRequest, TaskStatus, TaskStatusCounts, TaskStatuses, TaskStatusesEnvelope, TaskStatusesHistoryEnvelope, TaskUpdateRequest, TaskUpdateResponse, TasksStatusCounts, Tier, Token, TokenInfo, TokenInfoSuccessResponse, TokenRequest, TokenResponse, TokensApi, UnregisterDeviceResponse, UnregisterDeviceResponseEnvelope, UpdateParameters, UpgradePath, UpgradePathEnvelope, UpgradePathUserToken, UpgradePathUserTokenEnvelope, UploadIdEnvelope, UploadStatusEnvelope, User, UserEnvelope, UsersApi, ValidationCallbackInfo, ValidityPeriod, WebSocketError, Whitelist, WhitelistEnvelope, WhitelistResultEnvelope, WhitelistingApi

Constant Summary collapse

VERSION = 
"2.2.3"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

ArtikCloud.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



214
215
216
217
218
219
220
 
# File 'lib/artikcloud.rb', line 214

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end