Class: Verizon::CampaignsV2Controller

Inherits:
BaseController show all
Defined in:
lib/verizon/controllers/campaigns_v2_controller.rb

Overview

CampaignsV2Controller

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from Verizon::BaseController

Instance Method Details

#cancel_campaign(account, campaign_id) ⇒ FotaV2SuccessResult

This endpoint allows user to cancel software upgrade. A software upgrade already started can not be cancelled. campaign.

Parameters:

  • account (String) —

    Required parameter: Account identifier.

  • campaign_id (String) —

    Required parameter: Unique identifier of

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/verizon/controllers/campaigns_v2_controller.rb', line 104

def cancel_campaign(,
                    campaign_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/campaigns/{account}/{campaignId}',
                                 Server::SOFTWARE_MANAGEMENT_V2)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .template_param(new_parameter(campaign_id, key: 'campaignId')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(FotaV2SuccessResult.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV2ResultException))
    .execute
end

#get_campaign_information(account, campaign_id) ⇒ CampaignSoftware

This endpoint allows user to get information of a software upgrade. identifier.

Parameters:

  • account (String) —

    Required parameter: Account identifier.

  • campaign_id (String) —

    Required parameter: Software upgrade

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/verizon/controllers/campaigns_v2_controller.rb', line 42

def get_campaign_information(,
                             campaign_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/campaigns/{account}/{campaignId}',
                                 Server::SOFTWARE_MANAGEMENT_V2)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .template_param(new_parameter(campaign_id, key: 'campaignId')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(CampaignSoftware.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV2ResultException))
    .execute
end

#schedule_campaign_firmware_upgrade(account, body) ⇒ CampaignSoftware

This endpoint allows user to schedule a software upgrade. information.

Parameters:

  • account (String) —

    Required parameter: Account identifier.

  • body (CampaignSoftwareUpgrade) —

    Required parameter: Software upgrade

Returns:



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/verizon/controllers/campaigns_v2_controller.rb', line 14

def schedule_campaign_firmware_upgrade(,
                                       body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/campaigns/{account}',
                                 Server::SOFTWARE_MANAGEMENT_V2)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .header_param(new_parameter('*/*', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(CampaignSoftware.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV2ResultException))
    .execute
end

#schedule_file_upgrade(acc, body) ⇒ UploadAndScheduleFileResponse

You can upload configuration files and schedule them in a campaign to devices. logging information.

Parameters:

Returns:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/verizon/controllers/campaigns_v2_controller.rb', line 166

def schedule_file_upgrade(acc,
                          body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/campaigns/files/{acc}',
                                 Server::SOFTWARE_MANAGEMENT_V2)
               .template_param(new_parameter(acc, key: 'acc')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(UploadAndScheduleFileResponse.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV2ResultException))
    .execute
end

#schedule_sw_upgrade_http_devices(acc, body) ⇒ UploadAndScheduleFileResponse

Campaign time windows for downloading and installing software are available as long as the device OEM supports this. logging information.

Parameters:

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/verizon/controllers/campaigns_v2_controller.rb', line 195

def schedule_sw_upgrade_http_devices(acc,
                                     body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/campaigns/software/{acc}',
                                 Server::SOFTWARE_MANAGEMENT_V2)
               .template_param(new_parameter(acc, key: 'acc')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(UploadAndScheduleFileResponse.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV2ResultException))
    .execute
end

#update_campaign_dates(account, campaign_id, body) ⇒ CampaignSoftware

This endpoint allows user to change campaign dates and time windows. Fields which need to remain unchanged should be also provided. information. and time windows.

Parameters:

  • account (String) —

    Required parameter: Account identifier.

  • campaign_id (String) —

    Required parameter: Software upgrade

  • body (V2ChangeCampaignDatesRequest) —

    Required parameter: New dates

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/verizon/controllers/campaigns_v2_controller.rb', line 134

def update_campaign_dates(,
                          campaign_id,
                          body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/campaigns/{account}/{campaignId}/dates',
                                 Server::SOFTWARE_MANAGEMENT_V2)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .template_param(new_parameter(campaign_id, key: 'campaignId')
                                .should_encode(true))
               .header_param(new_parameter('*/*', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(CampaignSoftware.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV2ResultException))
    .execute
end

#update_campaign_firmware_devices(account, campaign_id, body) ⇒ V2AddOrRemoveDeviceResult

This endpoint allows user to Add or Remove devices to an existing software upgrade. information. add or remove device to existing software upgrade information.

Parameters:

  • account (String) —

    Required parameter: Account identifier.

  • campaign_id (String) —

    Required parameter: Software upgrade

  • body (V2AddOrRemoveDeviceRequest) —

    Required parameter: Request to

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/verizon/controllers/campaigns_v2_controller.rb', line 72

def update_campaign_firmware_devices(,
                                     campaign_id,
                                     body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/campaigns/{account}/{campaignId}',
                                 Server::SOFTWARE_MANAGEMENT_V2)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .template_param(new_parameter(campaign_id, key: 'campaignId')
                                .should_encode(true))
               .header_param(new_parameter('*/*', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(V2AddOrRemoveDeviceResult.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV2ResultException))
    .execute
end