Module: Alula

Defined in:
lib/alula/resource_attributes.rb,
lib/alula.rb,
lib/alula/meta.rb,
lib/alula/util.rb,
lib/alula/oauth.rb,
lib/alula/client.rb,
lib/alula/errors.rb,
lib/alula/version.rb,
lib/alula/pagination.rb,
lib/alula/rate_limit.rb,
lib/alula/list_object.rb,
lib/alula/api_resource.rb,
lib/alula/rpc_resource.rb,
lib/alula/rpc_response.rb,
lib/alula/rest_resource.rb,
lib/alula/alula_response.rb,
lib/alula/filter_builder.rb,
lib/alula/resources/self.rb,
lib/alula/resources/user.rb,
lib/alula/query_interface.rb,
lib/alula/resources/dealer.rb,
lib/alula/resources/device.rb,
lib/alula/resources/station.rb,
lib/alula/helpers/jwt_helper.rb,
lib/alula/resources/revision.rb,
lib/alula/api_operations/list.rb,
lib/alula/api_operations/save.rb,
lib/alula/client_configuration.rb,
lib/alula/resources/helix_user.rb,
lib/alula/resources/user_phone.rb,
lib/alula/api_operations/delete.rb,
lib/alula/resources/device_user.rb,
lib/alula/api_operations/request.rb,
lib/alula/resources/dealer_phone.rb,
lib/alula/resources/device_alias.rb,
lib/alula/resources/feature_plan.rb,
lib/alula/resources/oauth_client.rb,
lib/alula/resources/user_address.rb,
lib/alula/resources/video/device.rb,
lib/alula/relationship_attributes.rb,
lib/alula/resources/device_charge.rb,
lib/alula/resources/device_credit.rb,
lib/alula/resources/event_trigger.rb,
lib/alula/resources/event_webhook.rb,
lib/alula/resources/feature_price.rb,
lib/alula/singleton_rest_resource.rb,
lib/alula/resources/dealer_address.rb,
lib/alula/resources/dealer_program.rb,
lib/alula/resources/device_program.rb,
lib/alula/resources/receiver_group.rb,
lib/alula/resources/token_exchange.rb,
lib/alula/resources/user_pushtoken.rb,
lib/alula/resources/billing_program.rb,
lib/alula/resources/dealer_branding.rb,
lib/alula/resources/device_event_log.rb,
lib/alula/resources/user_preferences.rb,
lib/alula/procedures/user_unlock_proc.rb,
lib/alula/resources/feature_bysubject.rb,
lib/alula/resources/feature_planvideo.rb,
lib/alula/resources/receiver_disabled.rb,
lib/alula/resources/user_videoprofile.rb,
lib/alula/procedures/device_assign_proc.rb,
lib/alula/procedures/user_transfer_deny.rb,
lib/alula/resources/device_notification.rb,
lib/alula/resources/receiver_connection.rb,
lib/alula/resources/video/base_resource.rb,
lib/alula/procedures/dealer_restore_proc.rb,
lib/alula/procedures/dealer_suspend_proc.rb,
lib/alula/procedures/camera_get_info_proc.rb,
lib/alula/procedures/camera_get_wifi_proc.rb,
lib/alula/procedures/device_register_proc.rb,
lib/alula/procedures/device_unassign_proc.rb,
lib/alula/procedures/user_get_locked_proc.rb,
lib/alula/procedures/user_transfer_accept.rb,
lib/alula/procedures/user_transfer_cancel.rb,
lib/alula/procedures/user_transfer_reject.rb,
lib/alula/resources/dealer_suspension_log.rb,
lib/alula/procedures/camera_get_stats_proc.rb,
lib/alula/procedures/user_transfer_request.rb,
lib/alula/procedures/video_unregister_proc.rb,
lib/alula/resources/device_cellular_status.rb,
lib/alula/procedures/device_signal_add_proc.rb,
lib/alula/procedures/device_unregister_proc.rb,
lib/alula/resources/dealer_account_transfer.rb,
lib/alula/procedures/feature_plan_clone_proc.rb,
lib/alula/procedures/user_transfer_authorize.rb,
lib/alula/resources/video_verification_event.rb,
lib/alula/procedures/dealer_device_stats_proc.rb,
lib/alula/procedures/device_rateplan_get_proc.rb,
lib/alula/procedures/user_password_reset_proc.rb,
lib/alula/resources/video_verification_camera.rb,
lib/alula/procedures/camera_get_sd_status_proc.rb,
lib/alula/procedures/device_signal_update_proc.rb,
lib/alula/procedures/user_plansvideo_price_get.rb,
lib/alula/procedures/camera_get_chime_info_proc.rb,
lib/alula/procedures/camera_get_rec_config_proc.rb,
lib/alula/procedures/camera_get_svr_config_proc.rb,
lib/alula/procedures/camera_set_rec_config_proc.rb,
lib/alula/procedures/camera_set_svr_config_proc.rb,
lib/alula/procedures/device_programs_renew_proc.rb,
lib/alula/procedures/device_cellular_history_proc.rb,
lib/alula/procedures/device_signal_delivered_proc.rb,
lib/alula/helpers/device_helpers/program_id_helper.rb,
lib/alula/procedures/upload_touchpad_branding_proc.rb,
lib/alula/procedures/camera_get_firmware_version_proc.rb,
lib/alula/helpers/device_helpers/attribute_translations_helper.rb

Overview

Method: devices.register

Defined Under Namespace

Modules: ApiOperations, DeviceHelpers, JwtHelper, RelationshipAttributes, ResourceAttributes, Video Classes: AlulaError, AlulaResponse, ApiGatewayError, ApiResource, BadRequestError, BillingProgram, CameraGetChimeInfoProc, CameraGetFirmwareVersionProc, CameraGetInfoProc, CameraGetRecordingConfigProc, CameraGetSdStatusProc, CameraGetServerConfigProc, CameraGetStatsProc, CameraGetWifiProc, CameraSetRecordingConfigProc, CameraSetServerConfigProc, Client, ClientConfiguration, Dealer, DealerAccountTransfer, DealerAddress, DealerBranding, DealerDeviceStatsProc, DealerPhone, DealerProgram, DealerRestoreProc, DealerSuspendProc, DealerSuspensionLog, Device, DeviceAlias, DeviceAssignProc, DeviceCellularHistoryProc, DeviceCellularStatus, DeviceCharge, DeviceCredit, DeviceEventLog, DeviceNotification, DeviceProgram, DeviceProgramsRenewProc, DeviceRatePlanGetProc, DeviceRegisterProc, DeviceSignalAddProc, DeviceSignalDeliveredProc, DeviceSignalUpdateProc, DeviceUnassignProc, DeviceUnregisterProc, DeviceUser, EventTrigger, EventWebhook, FeatureBySubject, FeaturePlan, FeaturePlanCloneProc, FeaturePlanVideo, FeaturePrice, FilterBuilder, ForbiddenError, HelixUser, InsufficientScopeError, InvalidFilterFieldError, InvalidRelationshipError, InvalidRequestError, InvalidRoleError, InvalidSortFieldError, InvalidTokenError, ListObject, Meta, NotConfiguredError, NotFoundError, OAuthClient, Oauth, ObjectField, Pagination, ProcedureError, QueryInterface, RateLimit, RateLimitError, ReceiverConnection, ReceiverDisabled, ReceiverGroup, RestResource, Revision, RpcResource, RpcResponse, Self, ServerError, SingletonRestResource, Station, TokenExchange, UnknownApiError, UnknownError, UploadTouchpadBrandingProc, User, UserAddress, UserGetLockedProc, UserPasswordResetProc, UserPhone, UserPlansVideoPriceGetProc, UserPreferences, UserPushtoken, UserTransferAccept, UserTransferAuthorize, UserTransferCancel, UserTransferDeny, UserTransferReject, UserTransferRequest, UserUnlockProc, UserVideoProfile, Util, ValidationError, VideoUnregisterProc, VideoVerificationCamera, VideoVerificationEvent

Constant Summary collapse

VERSION = 
'2.1.2'
@@resource_map =

A map of API REST resource names to Alula Ruby classes 

'feature-plansvideo' => Alula::FeaturePlanVideo

This is used to determine which class to initialize when working with API query responses, and included models.

[
  Alula::BillingProgram,
  Alula::Dealer,
  Alula::DealerAccountTransfer,
  Alula::DealerBranding,
  Alula::DealerPhone,
  Alula::DealerProgram,
  Alula::Device,
  Alula::DeviceAlias,
  Alula::DeviceCharge,
  Alula::DeviceCredit,
  Alula::DeviceEventLog,
  Alula::DeviceNotification,
  Alula::DeviceUser,
  Alula::VideoVerificationCamera,
  Alula::DeviceProgram,
  Alula::DealerAddress,
  Alula::DeviceCellularStatus,
  Alula::FeatureBySubject,
  Alula::FeaturePlan,
  Alula::FeaturePlanVideo,
  Alula::FeaturePrice,
  Alula::HelixUser,
  Alula::OAuthClient,
  Alula::ReceiverGroup,
  Alula::ReceiverDisabled,
  Alula::Revision,
  Alula::Self,
  Alula::Station,
  Alula::User,
  Alula::UserAddress,
  Alula::UserPhone,
  Alula::UserPreferences,
  Alula::UserPushtoken,
  Alula::UserVideoProfile,
  Alula::VideoVerificationEvent
].each_with_object({}) do |klass, resource_map|
  resource_map[klass.get_type] = klass
end

Class Method Summary collapse

Class Method Details

.class_from_resource_type(type) ⇒ Object 



156
157
158
159
 
# File 'lib/alula.rb', line 156

def self.class_from_resource_type(type)
  @@resource_map[type] || (raise "Unknown resource name #{type}, you need to map this "\
                                 'name to a class in the Alula module.')
end

.logger ⇒ Object 



161
162
163
 
# File 'lib/alula.rb', line 161

def self.logger
  @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
end

.logger=(logger) ⇒ Object 



165
166
167
 
# File 'lib/alula.rb', line 165

def self.logger=(logger)
  @@logger = logger
end