-
Notifications
You must be signed in to change notification settings - Fork 0
/
matrixx-monetization-connector-mule4-documentation.adoc
16379 lines (13244 loc) · 778 KB
/
matrixx-monetization-connector-mule4-documentation.adoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
= Matrixx Monetization Connector Mule4 Module Connector Reference
== Configurations
---
[[Config]]
=== Config
==== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
|Name | String | The name for this configuration. Connectors reference the configuration with this name. | | *x*{nbsp}
| Connection a| <<Config_BasicAuth, Basic Auth Connection Provider>>
| The connection types that can be provided to this configuration. | | *x*{nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | 60 | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | SECONDS | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | AUTO | {nbsp}
| Name a| String | The identifier of this element used to reference it in other components | | *x*{nbsp}
| Expiration Policy a| <<ExpirationPolicy>> | Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit. | | {nbsp}
|===
==== Connection Types
[[Config_BasicAuth]]
===== Basic Auth Connection Provider
This is the last layer of the connection provider generation gap pattern. It is what finally gets exposed as the connection provider, including all customizations made in the refinement layer.
====== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Default headers a| Object | | | {nbsp}
| Default query parameters a| Object | | | {nbsp}
| Connection Timeout a| Number | The timeout for establishing connections to the remote service | 30 | {nbsp}
| Connection Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Connection Timeout | SECONDS | {nbsp}
| Use Persistent Connections a| Boolean | If false, each connection will be closed after the first request is completed. | true | {nbsp}
| Max Connections a| Number | The maximum number of outbound connections that will be kept open at the same time | -1 | {nbsp}
| Connection Idle Timeout a| Number | A timeout for how long a connection can remain idle before it is closed | 30 | {nbsp}
| Connection Idle Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the connection Idle Timeout | SECONDS | {nbsp}
| Stream Response a| Boolean | Whether or not received responses should be streamed | false | {nbsp}
| Response Buffer Size a| Number | The space in bytes for the buffer where the HTTP response will be stored. | -1 | {nbsp}
| Base Uri a| String | Parameter base URI, each instance/tenant gets its own | https://localhost:8080/rsgateway/data | {nbsp}
| Username a| String | The username used to authenticate the requests. | | *x*{nbsp}
| Password a| String | The password used to authenticate the requests. | | {nbsp}
| Proxy Config a| <<Proxy>> | Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password. | | {nbsp}
| Protocol a| Enumeration, one of:
** HTTP
** HTTPS | Protocol to use for communication. Valid values are HTTP and HTTPS | HTTP | {nbsp}
| TLS Configuration a| <<Tls>> | | | {nbsp}
| Reconnection a| <<Reconnection>> | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy | | {nbsp}
|===
==== Associated Operations
* <<DeviceActivateOffer>> {nbsp}
* <<DeviceAggregation>> {nbsp}
* <<DeviceCancelOffer>> {nbsp}
* <<DeviceCancelOfferExtended>> {nbsp}
* <<DeviceCheckPurchasedItemCycleAlignment>> {nbsp}
* <<DeviceCreateBasic>> {nbsp}
* <<DeviceDelete>> {nbsp}
* <<DeviceDeleteSession>> {nbsp}
* <<DeviceDetail>> {nbsp}
* <<DeviceDeviceRehome>> {nbsp}
* <<DeviceEvents>> {nbsp}
* <<DeviceGetCatalog>> {nbsp}
* <<DeviceGetCatalogItemsByEligibility>> {nbsp}
* <<DeviceMakeContractDebtPayment>> {nbsp}
* <<DeviceModifyInfo>> {nbsp}
* <<DeviceModifyOffer>> {nbsp}
* <<DevicePolicyCounter>> {nbsp}
* <<DevicePurchaseOffer>> {nbsp}
* <<DeviceQueryAccess>> {nbsp}
* <<DeviceQueryAccessId>> {nbsp}
* <<DeviceQueryExternalId>> {nbsp}
* <<DeviceQueryImsi>> {nbsp}
* <<DeviceQueryLoginId>> {nbsp}
* <<DeviceQueryPhone>> {nbsp}
* <<DeviceQuerySession>> {nbsp}
* <<DeviceValidateSession>> {nbsp}
* <<EventQuery>> {nbsp}
* <<EventstoreGroupEvent>> {nbsp}
* <<EventstoreGroupNotification>> {nbsp}
* <<EventstoreNotificationEventId>> {nbsp}
* <<EventstoreQueryEvent>> {nbsp}
* <<EventstoreQueryEventId>> {nbsp}
* <<EventstoreSubscriberEvent>> {nbsp}
* <<EventstoreSubscriberNotification>> {nbsp}
* <<EventstoreUserEvent>> {nbsp}
* <<EventstoreUserNotification>> {nbsp}
* <<GatewayAddNotificationToken>> {nbsp}
* <<GatewayDeleteNotificationToken>> {nbsp}
* <<GatewayGetAggregatedCatalog>> {nbsp}
* <<GatewayGetSubscriberDevices>> {nbsp}
* <<GroupActivateOffer>> {nbsp}
* <<GroupAddBalanceExpiryRechargeDefn>> {nbsp}
* <<GroupAddMembership>> {nbsp}
* <<GroupAddPaymentMethod>> {nbsp}
* <<GroupAddRechargeSchedule>> {nbsp}
* <<GroupAddThreshold>> {nbsp}
* <<GroupAddUser>> {nbsp}
* <<GroupAdjustBalance>> {nbsp}
* <<GroupAdjustRolloverBalance>> {nbsp}
* <<GroupAdministrators>> {nbsp}
* <<GroupCancelOffer>> {nbsp}
* <<GroupCancelOfferExtended>> {nbsp}
* <<GroupCheckPurchasedItemCycleAlignment>> {nbsp}
* <<GroupCreateBasic>> {nbsp}
* <<GroupCreateOneTimeToken>> {nbsp}
* <<GroupDelete>> {nbsp}
* <<GroupDetail>> {nbsp}
* <<GroupEstimateRecurring>> {nbsp}
* <<GroupEvents>> {nbsp}
* <<GroupGetBalanceExpiryRechargeDefn>> {nbsp}
* <<GroupGetCatalog>> {nbsp}
* <<GroupGetCatalogItemsByEligibility>> {nbsp}
* <<GroupGetExternalPayment>> {nbsp}
* <<GroupGetPaymentHistory>> {nbsp}
* <<GroupGroupRehome>> {nbsp}
* <<GroupGroups>> {nbsp}
* <<GroupMakeContractDebtPayment>> {nbsp}
* <<GroupMakeFinanceContractPayment>> {nbsp}
* <<GroupMakePayment>> {nbsp}
* <<GroupMakeRecharge>> {nbsp}
* <<GroupMakeRefund>> {nbsp}
* <<GroupModifyExternalPayment>> {nbsp}
* <<GroupModifyInfo>> {nbsp}
* <<GroupModifyOffer>> {nbsp}
* <<GroupModifyPaymentMethod>> {nbsp}
* <<GroupModifyRechargeSchedule>> {nbsp}
* <<GroupModifyUser>> {nbsp}
* <<GroupPurchaseOffer>> {nbsp}
* <<GroupQueryExternalId>> {nbsp}
* <<GroupQueryPaymentMethod>> {nbsp}
* <<GroupQueryRechargeSchedule>> {nbsp}
* <<GroupQueryRecurringRecharge>> {nbsp}
* <<GroupQueryThresholdRechargeDefn>> {nbsp}
* <<GroupRemoveBalanceExpiryRechargeDefn>> {nbsp}
* <<GroupRemoveMembership>> {nbsp}
* <<GroupRemovePaymentMethod>> {nbsp}
* <<GroupRemoveRechargeSchedule>> {nbsp}
* <<GroupRemoveThreshold>> {nbsp}
* <<GroupRemoveUser>> {nbsp}
* <<GroupSettlePayment>> {nbsp}
* <<GroupSubscribers>> {nbsp}
* <<GroupTopupBalance>> {nbsp}
* <<GroupTransferBalance>> {nbsp}
* <<GroupUpdateBalanceExpiryRechargeDefn>> {nbsp}
* <<GroupUsers>> {nbsp}
* <<GroupValidatePaymentMethod>> {nbsp}
* <<GroupWallet>> {nbsp}
* <<PricingDevice>> {nbsp}
* <<PricingGetBalance>> {nbsp}
* <<PricingGetBalanceClass>> {nbsp}
* <<PricingGetBalanceClassList>> {nbsp}
* <<PricingGetBalanceList>> {nbsp}
* <<PricingGetBalanceThresholds>> {nbsp}
* <<PricingGetBillingCycle>> {nbsp}
* <<PricingGetBillingCycles>> {nbsp}
* <<PricingGetCatalog>> {nbsp}
* <<PricingGetCatalogItem>> {nbsp}
* <<PricingGetCatalogItemList>> {nbsp}
* <<PricingGetCatalogList>> {nbsp}
* <<PricingGetContract>> {nbsp}
* <<PricingGetContractEtcSchedule>> {nbsp}
* <<PricingGetContractEtcScheduleList>> {nbsp}
* <<PricingGetContractList>> {nbsp}
* <<PricingGetContractPaymentSchedule>> {nbsp}
* <<PricingGetContractPaymentScheduleList>> {nbsp}
* <<PricingGetEventType>> {nbsp}
* <<PricingGetEventTypes>> {nbsp}
* <<PricingGetNotificationProfile>> {nbsp}
* <<PricingGetOffer>> {nbsp}
* <<PricingGetOfferList>> {nbsp}
* <<PricingGetOfferVersion>> {nbsp}
* <<PricingGetRateTag>> {nbsp}
* <<PricingGetRateTagList>> {nbsp}
* <<PricingGetServiceContext>> {nbsp}
* <<PricingGetServiceType>> {nbsp}
* <<PricingGetServiceTypes>> {nbsp}
* <<PricingGetTaxClass>> {nbsp}
* <<PricingGetTaxClassList>> {nbsp}
* <<PricingGetUserRole>> {nbsp}
* <<PricingGetUserRoleList>> {nbsp}
* <<PricingGroup>> {nbsp}
* <<PricingOffer>> {nbsp}
* <<PricingOfferLifecycleProfile>> {nbsp}
* <<PricingOfferLifecycleProfileList>> {nbsp}
* <<PricingOfferdefault>> {nbsp}
* <<PricingPricingStatus>> {nbsp}
* <<PricingQueryOffer>> {nbsp}
* <<PricingQueryRateTag>> {nbsp}
* <<PricingQueryTaxClass>> {nbsp}
* <<PricingSubscriber>> {nbsp}
* <<PricingUser>> {nbsp}
* <<ServiceSubdomainsQuery>> {nbsp}
* <<StreamCreateSession>> {nbsp}
* <<StreamDeleteSession>> {nbsp}
* <<StreamModifySession>> {nbsp}
* <<StreamQuerySession>> {nbsp}
* <<StreamQuerySessionList>> {nbsp}
* <<SubscriberAddDevice>> {nbsp}
* <<SubscriberAddPaymentMethod>> {nbsp}
* <<SubscriberAddRechargeSchedule>> {nbsp}
* <<SubscriberAddThreshold>> {nbsp}
* <<SubscriberAdjustBalance>> {nbsp}
* <<SubscriberAdjustRolloverBalance>> {nbsp}
* <<SubscriberCancelOffer>> {nbsp}
* <<SubscriberCancelOfferExtended>> {nbsp}
* <<SubscriberCheckPurchasedItemCycleAlignment>> {nbsp}
* <<SubscriberCreateOneTimeToken>> {nbsp}
* <<SubscriberEstimateRecurring>> {nbsp}
* <<SubscriberGetAuthData>> {nbsp}
* <<SubscriberGetCatalog>> {nbsp}
* <<SubscriberGetCatalogItemsByEligibility>> {nbsp}
* <<SubscriberGetPaymentHistory>> {nbsp}
* <<SubscriberGroups>> {nbsp}
* <<SubscriberMakeContractDebtPayment>> {nbsp}
* <<SubscriberMakeFinanceContractPayment>> {nbsp}
* <<SubscriberMakePayment>> {nbsp}
* <<SubscriberMakeRecharge>> {nbsp}
* <<SubscriberMakeRefund>> {nbsp}
* <<SubscriberModifyAuthData>> {nbsp}
* <<SubscriberModifyOffer>> {nbsp}
* <<SubscriberModifyPaymentMethod>> {nbsp}
* <<SubscriberModifyRechargeSchedule>> {nbsp}
* <<SubscriberPurchaseOffer>> {nbsp}
* <<SubscriberQueryAggregation>> {nbsp}
* <<SubscriberQueryEvents>> {nbsp}
* <<SubscriberQueryPaymentMethod>> {nbsp}
* <<SubscriberQueryRechargeSchedule>> {nbsp}
* <<SubscriberQueryRecurringRecharge>> {nbsp}
* <<SubscriberQueryThresholdRechargeDefn>> {nbsp}
* <<SubscriberQueryWithDevice>> {nbsp}
* <<SubscriberRemoveDevice>> {nbsp}
* <<SubscriberRemovePaymentMethod>> {nbsp}
* <<SubscriberRemoveRechargeSchedule>> {nbsp}
* <<SubscriberRemoveThreshold>> {nbsp}
* <<SubscriberSettlePayment>> {nbsp}
* <<SubscriberSubscriberRehome>> {nbsp}
* <<SubscriberTopupBalance>> {nbsp}
* <<SubscriberTransferBalance>> {nbsp}
* <<SubscriberUsers>> {nbsp}
* <<SubscriberWallet>> {nbsp}
* <<SubscriptionActivateOffer>> {nbsp}
* <<SubscriptionAddBalanceExpiryRechargeDefn>> {nbsp}
* <<SubscriptionCreateBasic>> {nbsp}
* <<SubscriptionDelete>> {nbsp}
* <<SubscriptionDetail>> {nbsp}
* <<SubscriptionGetBalanceExpiryRechargeDefn>> {nbsp}
* <<SubscriptionGetExternalPayment>> {nbsp}
* <<SubscriptionModifyExternalPayment>> {nbsp}
* <<SubscriptionModifyInfo>> {nbsp}
* <<SubscriptionRemoveBalanceExpiryRechargeDefn>> {nbsp}
* <<SubscriptionUpdateBalanceExpiryRechargeDefn>> {nbsp}
* <<SubscriptionValidatePaymentMethod>> {nbsp}
* <<SystemCreateClientToken>> {nbsp}
* <<SystemCreateClientTokenNoUser>> {nbsp}
* <<UserAddGroup>> {nbsp}
* <<UserAddSubscription>> {nbsp}
* <<UserCreateBasic>> {nbsp}
* <<UserDelete>> {nbsp}
* <<UserDetail>> {nbsp}
* <<UserEvents>> {nbsp}
* <<UserGetAuthData>> {nbsp}
* <<UserGroups>> {nbsp}
* <<UserModifyAuthData>> {nbsp}
* <<UserModifyGroup>> {nbsp}
* <<UserModifyInfo>> {nbsp}
* <<UserModifySubscription>> {nbsp}
* <<UserRemoveGroup>> {nbsp}
* <<UserRemoveSubscription>> {nbsp}
* <<UserSubscriptions>> {nbsp}
* <<UserUserRehome>> {nbsp}
== Operations
[[DeviceActivateOffer]]
== Device Activate Offer
`<matrixx-monetization-connector-mule-4:device-activate-offer>`
This method is used to activate a catalog item the device has purchased. This operation makes an HTTP PUT request to the /openapi/device/{SearchTerm}/offers/{ResourceId}/activate endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Resource Id a| Number | This parameter is the resource id of the catalog item. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Execute Mode a| Number | Specifies the execution mode. Valid values are: 0 = normal (default), 1 = dryrun, 2 = advice | | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Body a| Any | the content to use | #[payload] | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceAggregation]]
== Device Aggregation
`<matrixx-monetization-connector-mule-4:device-aggregation>`
This method is used to retrieve device aggregation info. This operation makes an HTTP GET request to the /openapi/device/{SearchTerm}/aggregation endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceCancelOffer]]
== Device Cancel Offer
`<matrixx-monetization-connector-mule-4:device-cancel-offer>`
This method is used to cancel one or more catalog items the device has purchased. This operation makes an HTTP DELETE request to the /openapi/device/{SearchTerm}/offers/{ResourceId} endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Resource Id Array a| String | This parameter is a comma-separated list of numeric purchased catalog item resource ID's. No spaces or extra characters are allowed. For example, to cancel catalog items with resource IDs 3, 7, and 9, the url would be /device/###/offers/3,7,9 where ### is the device id. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Execute Mode a| Number | Specifies the execution mode. Valid values are: 0 = normal (default), 1 = dryrun, 2 = advice | | {nbsp}
| Eligibility Check a| Boolean | If true (default), eligibility rule evaluation will be performed. If false, eligibility rule evaluation will be skipped. | false | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceCancelOfferExtended]]
== Device Cancel Offer Extended
`<matrixx-monetization-connector-mule-4:device-cancel-offer-extended>`
This method is used to cancel one or more offers the device has purchased. Additional arguments are specified for each offer being cancelled. This operation makes an HTTP POST request to the /openapi/device/{SearchTerm}/offers endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Execute Mode a| Number | Specifies the execution mode. Valid values are: 0 = normal (default), 1 = dryrun, 2 = advice | | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Body a| Any | the content to use | #[payload] | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceCheckPurchasedItemCycleAlignment]]
== Device Check Purchased Item Cycle Alignment
`<matrixx-monetization-connector-mule-4:device-check-purchased-item-cycle-alignment>`
This method is used to check a catalog item for cycles that can be aligned to on purchase or modification. One and only one of OfferRequest and OfferResourceId must be provided. This operation makes an HTTP PUT request to the /openapi/device/{SearchTerm}/cycle_alignment endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Body a| Any | the content to use | #[payload] | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceCreateBasic]]
== Device Create Basic
`<matrixx-monetization-connector-mule-4:device-create-basic>`
Create a device. Will read an MtxRequestDeviceCeateBasic message from post data and submit it to the engine. This operation makes an HTTP POST request to the /openapi/device endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Body a| Any | the content to use | #[payload] | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceDelete]]
== Device Delete
`<matrixx-monetization-connector-mule-4:device-delete>`
This method is used to delete a device in the database. This operation makes an HTTP DELETE request to the /openapi/device/{SearchTerm} endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Delete Session a| Boolean | Specifies whether active sessions of the device should be deleted too. Default is false. | false | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceDeleteSession]]
== Device Delete Session
`<matrixx-monetization-connector-mule-4:device-delete-session>`
This method is used to delete a session or sessions currently associated with a device. This operation makes an HTTP DELETE request to the /openapi/device/{SearchTerm}/session endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Session Id a| String | A session id. Multiple sessionId parameters can be passed | | {nbsp}
| Session Type a| Number | A session type to delete | | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceDetail]]
== Device Detail
`<matrixx-monetization-connector-mule-4:device-detail>`
This method is used to retrieve a device using the object id. This operation makes an HTTP GET request to the /openapi/device/{SearchTerm} endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| Search Term a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Traffic Route Data a| String | Optional routing data used by the TRA to route this subman call to the correct engine | | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}
| Target Variable a| String | The name of a variable on which the operation's output will be placed | | {nbsp}
| Target Value a| String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | {nbsp}
| Reconnection Strategy a| * <<Reconnect>>
* <<ReconnectForever>> | A retry strategy in case of connectivity errors | | {nbsp}
|===
=== Output
[%autowidth.spread]
|===
| *Type* a| Any
| *Attributes Type* a| <<HttpResponseAttributes>>
|===
=== For Configurations
* <<Config>> {nbsp}
=== Throws
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:BAD_REQUEST {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CLIENT_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:CONNECTIVITY {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_ACCEPTABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:NOT_FOUND {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:RETRY_EXHAUSTED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVER_ERROR {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TIMEOUT {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:TOO_MANY_REQUESTS {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNAUTHORIZED {nbsp}
* MATRIXX-MONETIZATION-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE {nbsp}
[[DeviceDeviceRehome]]
== Device Device Rehome
`<matrixx-monetization-connector-mule-4:device-device-rehome>`
rehome a device. This operation makes an HTTP PUT request to the /openapi/device/{query}/rehome/{destination} endpoint
=== Parameters
[%header%autowidth.spread]
|===
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use. | | *x*{nbsp}
| query a| String | Default is the object id of the device. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified. | | *x*{nbsp}
| destination a| String | Search term to determine the destination domain for the device. This could be a term to find a group or some other subscriber, or it could be a RouteId (RouteId+4) which would identify a server within the domain | | *x*{nbsp}
| Filter Name a| String | call the named filter | | {nbsp}
| filter a| String | a json filter specification | | {nbsp}
| Apply Default Filter a| Boolean | true causes default filter to be applied | false | {nbsp}
| Body a| Any | the content to use | #[payload] | {nbsp}
| Config Ref a| ConfigurationProvider | The name of the configuration to be used to execute this component | | *x*{nbsp}
| Streaming Strategy a| * <<RepeatableInMemoryStream>>
* <<RepeatableFileStoreStream>>
* non-repeatable-stream | Configure if repeatable streams should be used and their behaviour | | {nbsp}
| Custom Query Parameters a| Object | | #[null] | {nbsp}
| Custom Headers a| Object | | #[null] | {nbsp}
| Response Timeout a| Number | The timeout for request to the remote service. | | {nbsp}
| Response Timeout Unit a| Enumeration, one of:
** NANOSECONDS
** MICROSECONDS
** MILLISECONDS
** SECONDS
** MINUTES
** HOURS
** DAYS | A time unit which qualifies the Response Timeout} | | {nbsp}
| Streaming Type a| String | Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | | {nbsp}