Class: LicenseKit::ManagementClient

Inherits:
BaseClient show all
Defined in:
lib/licensekit/generated/clients.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url:, token: nil, headers: nil, timeout: nil, user_agent: nil, retry_options: nil, transport: nil) ⇒ ManagementClient

Returns a new instance of ManagementClient.



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/licensekit/generated/clients.rb', line 380

def initialize(base_url:, token: nil, headers: nil, timeout: nil, user_agent: nil, retry_options: nil, transport: nil)
  super(
    base_url: base_url,
    auth_type: "bearer",
    auth_value: token,
    headers: headers,
    timeout: timeout,
    user_agent: user_agent,
    retry_options: retry_options,
    transport: transport
  )
  @raw = ManagementRawClient.new(self)
end

Instance Attribute Details

#raw ⇒ Object (readonly)

Returns the value of attribute raw.



378
379
380
 
# File 'lib/licensekit/generated/clients.rb', line 378

def raw
  @raw
end

Instance Method Details

#assign_license_feature(request = nil, options: nil, **kwargs) ⇒ Object

Assign or update a feature on a license



395
396
397
 
# File 'lib/licensekit/generated/clients.rb', line 395

def assign_license_feature(request = nil, options: nil, **kwargs)
  perform_request("assignLicenseFeature", request, options: options, **kwargs)
end

#blacklist_license_device(request = nil, options: nil, **kwargs) ⇒ Object

Blacklist a managed device and block future reuse



400
401
402
 
# File 'lib/licensekit/generated/clients.rb', line 400

def blacklist_license_device(request = nil, options: nil, **kwargs)
  perform_request("blacklistLicenseDevice", request, options: options, **kwargs)
end

#create_api_key(request = nil, options: nil, **kwargs) ⇒ Object

Create a management API key



405
406
407
 
# File 'lib/licensekit/generated/clients.rb', line 405

def create_api_key(request = nil, options: nil, **kwargs)
  perform_request("createAPIKey", request, options: options, **kwargs)
end

#create_customer(request = nil, options: nil, **kwargs) ⇒ Object

Create a customer



410
411
412
 
# File 'lib/licensekit/generated/clients.rb', line 410

def create_customer(request = nil, options: nil, **kwargs)
  perform_request("createCustomer", request, options: options, **kwargs)
end

#create_feature(request = nil, options: nil, **kwargs) ⇒ Object

Create a feature for a product



415
416
417
 
# File 'lib/licensekit/generated/clients.rb', line 415

def create_feature(request = nil, options: nil, **kwargs)
  perform_request("createFeature", request, options: options, **kwargs)
end

#create_license(request = nil, options: nil, **kwargs) ⇒ Object

Create a license



420
421
422
 
# File 'lib/licensekit/generated/clients.rb', line 420

def create_license(request = nil, options: nil, **kwargs)
  perform_request("createLicense", request, options: options, **kwargs)
end

#create_order(request = nil, options: nil, **kwargs) ⇒ Object

Create an order record for a product



425
426
427
 
# File 'lib/licensekit/generated/clients.rb', line 425

def create_order(request = nil, options: nil, **kwargs)
  perform_request("createOrder", request, options: options, **kwargs)
end

#create_policy(request = nil, options: nil, **kwargs) ⇒ Object

Create a policy for a product



430
431
432
 
# File 'lib/licensekit/generated/clients.rb', line 430

def create_policy(request = nil, options: nil, **kwargs)
  perform_request("createPolicy", request, options: options, **kwargs)
end

#create_product(request = nil, options: nil, **kwargs) ⇒ Object

Create a product



435
436
437
 
# File 'lib/licensekit/generated/clients.rb', line 435

def create_product(request = nil, options: nil, **kwargs)
  perform_request("createProduct", request, options: options, **kwargs)
end

#create_product_custom_field_definition(request = nil, options: nil, **kwargs) ⇒ Object

Create a product custom field definition



440
441
442
 
# File 'lib/licensekit/generated/clients.rb', line 440

def create_product_custom_field_definition(request = nil, options: nil, **kwargs)
  perform_request("createProductCustomFieldDefinition", request, options: options, **kwargs)
end

#create_product_version(request = nil, options: nil, **kwargs) ⇒ Object

Create a product version



445
446
447
 
# File 'lib/licensekit/generated/clients.rb', line 445

def create_product_version(request = nil, options: nil, **kwargs)
  perform_request("createProductVersion", request, options: options, **kwargs)
end

#create_report_export(request = nil, options: nil, **kwargs) ⇒ Object

Create a frozen report export



450
451
452
 
# File 'lib/licensekit/generated/clients.rb', line 450

def create_report_export(request = nil, options: nil, **kwargs)
  perform_request("createReportExport", request, options: options, **kwargs)
end

#create_subscription(request = nil, options: nil, **kwargs) ⇒ Object

Create a subscription record for a product



455
456
457
 
# File 'lib/licensekit/generated/clients.rb', line 455

def create_subscription(request = nil, options: nil, **kwargs)
  perform_request("createSubscription", request, options: options, **kwargs)
end

#create_webhook_endpoint(request = nil, options: nil, **kwargs) ⇒ Object

Create a webhook endpoint



460
461
462
 
# File 'lib/licensekit/generated/clients.rb', line 460

def create_webhook_endpoint(request = nil, options: nil, **kwargs)
  perform_request("createWebhookEndpoint", request, options: options, **kwargs)
end

#delete_customer(request = nil, options: nil, **kwargs) ⇒ Object

Delete a customer



465
466
467
 
# File 'lib/licensekit/generated/clients.rb', line 465

def delete_customer(request = nil, options: nil, **kwargs)
  perform_request("deleteCustomer", request, options: options, **kwargs)
end

#delete_policy(request = nil, options: nil, **kwargs) ⇒ Object

Delete a policy



470
471
472
 
# File 'lib/licensekit/generated/clients.rb', line 470

def delete_policy(request = nil, options: nil, **kwargs)
  perform_request("deletePolicy", request, options: options, **kwargs)
end

#delete_product(request = nil, options: nil, **kwargs) ⇒ Object

Delete a product



475
476
477
 
# File 'lib/licensekit/generated/clients.rb', line 475

def delete_product(request = nil, options: nil, **kwargs)
  perform_request("deleteProduct", request, options: options, **kwargs)
end

#delete_product_custom_field_definition(request = nil, options: nil, **kwargs) ⇒ Object

Delete a product custom field definition



480
481
482
 
# File 'lib/licensekit/generated/clients.rb', line 480

def delete_product_custom_field_definition(request = nil, options: nil, **kwargs)
  perform_request("deleteProductCustomFieldDefinition", request, options: options, **kwargs)
end

#delete_webhook_endpoint(request = nil, options: nil, **kwargs) ⇒ Object

Delete a webhook endpoint



485
486
487
 
# File 'lib/licensekit/generated/clients.rb', line 485

def delete_webhook_endpoint(request = nil, options: nil, **kwargs)
  perform_request("deleteWebhookEndpoint", request, options: options, **kwargs)
end

#download_report_export(request = nil, options: nil, **kwargs) ⇒ Object

Download a frozen report export snapshot



490
491
492
 
# File 'lib/licensekit/generated/clients.rb', line 490

def download_report_export(request = nil, options: nil, **kwargs)
  perform_request("downloadReportExport", request, options: options, **kwargs)
end

#get_customer(request = nil, options: nil, **kwargs) ⇒ Object

Get a customer



495
496
497
 
# File 'lib/licensekit/generated/clients.rb', line 495

def get_customer(request = nil, options: nil, **kwargs)
  perform_request("getCustomer", request, options: options, **kwargs)
end

#get_customer_summary(request = nil, options: nil, **kwargs) ⇒ Object

Get customer-level reporting summary



500
501
502
 
# File 'lib/licensekit/generated/clients.rb', line 500

def get_customer_summary(request = nil, options: nil, **kwargs)
  perform_request("getCustomerSummary", request, options: options, **kwargs)
end

#get_feature(request = nil, options: nil, **kwargs) ⇒ Object

Get a feature



505
506
507
 
# File 'lib/licensekit/generated/clients.rb', line 505

def get_feature(request = nil, options: nil, **kwargs)
  perform_request("getFeature", request, options: options, **kwargs)
end

#get_license(request = nil, options: nil, **kwargs) ⇒ Object

Get a license



510
511
512
 
# File 'lib/licensekit/generated/clients.rb', line 510

def get_license(request = nil, options: nil, **kwargs)
  perform_request("getLicense", request, options: options, **kwargs)
end

#get_license_audit_report(request = nil, options: nil, **kwargs) ⇒ Object

Get a license audit report



515
516
517
 
# File 'lib/licensekit/generated/clients.rb', line 515

def get_license_audit_report(request = nil, options: nil, **kwargs)
  perform_request("getLicenseAuditReport", request, options: options, **kwargs)
end

#get_license_device(request = nil, options: nil, **kwargs) ⇒ Object

Get a device for a license



520
521
522
 
# File 'lib/licensekit/generated/clients.rb', line 520

def get_license_device(request = nil, options: nil, **kwargs)
  perform_request("getLicenseDevice", request, options: options, **kwargs)
end

#get_ops_summary(request = nil, options: nil, **kwargs) ⇒ Object

Get operational summary cards



525
526
527
 
# File 'lib/licensekit/generated/clients.rb', line 525

def get_ops_summary(request = nil, options: nil, **kwargs)
  perform_request("getOpsSummary", request, options: options, **kwargs)
end

#get_order(request = nil, options: nil, **kwargs) ⇒ Object

Get an order record



530
531
532
 
# File 'lib/licensekit/generated/clients.rb', line 530

def get_order(request = nil, options: nil, **kwargs)
  perform_request("getOrder", request, options: options, **kwargs)
end

#get_policy(request = nil, options: nil, **kwargs) ⇒ Object

Get a policy



535
536
537
 
# File 'lib/licensekit/generated/clients.rb', line 535

def get_policy(request = nil, options: nil, **kwargs)
  perform_request("getPolicy", request, options: options, **kwargs)
end

#get_product(request = nil, options: nil, **kwargs) ⇒ Object

Get a product



540
541
542
 
# File 'lib/licensekit/generated/clients.rb', line 540

def get_product(request = nil, options: nil, **kwargs)
  perform_request("getProduct", request, options: options, **kwargs)
end

#get_product_custom_field_definition(request = nil, options: nil, **kwargs) ⇒ Object

Get a product custom field definition



545
546
547
 
# File 'lib/licensekit/generated/clients.rb', line 545

def get_product_custom_field_definition(request = nil, options: nil, **kwargs)
  perform_request("getProductCustomFieldDefinition", request, options: options, **kwargs)
end

#get_report_export(request = nil, options: nil, **kwargs) ⇒ Object

Get report export metadata



550
551
552
 
# File 'lib/licensekit/generated/clients.rb', line 550

def get_report_export(request = nil, options: nil, **kwargs)
  perform_request("getReportExport", request, options: options, **kwargs)
end

#get_subscription(request = nil, options: nil, **kwargs) ⇒ Object

Get a subscription record



555
556
557
 
# File 'lib/licensekit/generated/clients.rb', line 555

def get_subscription(request = nil, options: nil, **kwargs)
  perform_request("getSubscription", request, options: options, **kwargs)
end

#get_subscription_settlement(request = nil, options: nil, **kwargs) ⇒ Object

Get subscription or order settlement summary



560
561
562
 
# File 'lib/licensekit/generated/clients.rb', line 560

def get_subscription_settlement(request = nil, options: nil, **kwargs)
  perform_request("getSubscriptionSettlement", request, options: options, **kwargs)
end

#get_usage_summary(request = nil, options: nil, **kwargs) ⇒ Object

Get grouped usage totals



565
566
567
 
# File 'lib/licensekit/generated/clients.rb', line 565

def get_usage_summary(request = nil, options: nil, **kwargs)
  perform_request("getUsageSummary", request, options: options, **kwargs)
end

#get_webhook_endpoint(request = nil, options: nil, **kwargs) ⇒ Object

Get a webhook endpoint



570
571
572
 
# File 'lib/licensekit/generated/clients.rb', line 570

def get_webhook_endpoint(request = nil, options: nil, **kwargs)
  perform_request("getWebhookEndpoint", request, options: options, **kwargs)
end

#get_webhook_health(request = nil, options: nil, **kwargs) ⇒ Object

Get webhook queue and failure health



575
576
577
 
# File 'lib/licensekit/generated/clients.rb', line 575

def get_webhook_health(request = nil, options: nil, **kwargs)
  perform_request("getWebhookHealth", request, options: options, **kwargs)
end

#list_activities(request = nil, options: nil, **kwargs) ⇒ Object

List normalized reporting activities



585
586
587
 
# File 'lib/licensekit/generated/clients.rb', line 585

def list_activities(request = nil, options: nil, **kwargs)
  perform_request("listActivities", request, options: options, **kwargs)
end

#list_api_keys(request = nil, options: nil, **kwargs) ⇒ Object

List management API keys



580
581
582
 
# File 'lib/licensekit/generated/clients.rb', line 580

def list_api_keys(request = nil, options: nil, **kwargs)
  perform_request("listAPIKeys", request, options: options, **kwargs)
end

#list_customer_custom_field_values(request = nil, options: nil, **kwargs) ⇒ Object

List customer custom field values



590
591
592
 
# File 'lib/licensekit/generated/clients.rb', line 590

def list_customer_custom_field_values(request = nil, options: nil, **kwargs)
  perform_request("listCustomerCustomFieldValues", request, options: options, **kwargs)
end

#list_customers(request = nil, options: nil, **kwargs) ⇒ Object

List customers



595
596
597
 
# File 'lib/licensekit/generated/clients.rb', line 595

def list_customers(request = nil, options: nil, **kwargs)
  perform_request("listCustomers", request, options: options, **kwargs)
end

#list_events(request = nil, options: nil, **kwargs) ⇒ Object

List audit-backed event records



600
601
602
 
# File 'lib/licensekit/generated/clients.rb', line 600

def list_events(request = nil, options: nil, **kwargs)
  perform_request("listEvents", request, options: options, **kwargs)
end

#list_features_by_product(request = nil, options: nil, **kwargs) ⇒ Object

List features for a product



605
606
607
 
# File 'lib/licensekit/generated/clients.rb', line 605

def list_features_by_product(request = nil, options: nil, **kwargs)
  perform_request("listFeaturesByProduct", request, options: options, **kwargs)
end

#list_license_custom_field_values(request = nil, options: nil, **kwargs) ⇒ Object

List license custom field values



610
611
612
 
# File 'lib/licensekit/generated/clients.rb', line 610

def list_license_custom_field_values(request = nil, options: nil, **kwargs)
  perform_request("listLicenseCustomFieldValues", request, options: options, **kwargs)
end

#list_license_devices(request = nil, options: nil, **kwargs) ⇒ Object

List devices for a license



615
616
617
 
# File 'lib/licensekit/generated/clients.rb', line 615

def list_license_devices(request = nil, options: nil, **kwargs)
  perform_request("listLicenseDevices", request, options: options, **kwargs)
end

#list_license_features(request = nil, options: nil, **kwargs) ⇒ Object

List assigned features for a license



620
621
622
 
# File 'lib/licensekit/generated/clients.rb', line 620

def list_license_features(request = nil, options: nil, **kwargs)
  perform_request("listLicenseFeatures", request, options: options, **kwargs)
end

#list_licenses(request = nil, options: nil, **kwargs) ⇒ Object

List licenses



625
626
627
 
# File 'lib/licensekit/generated/clients.rb', line 625

def list_licenses(request = nil, options: nil, **kwargs)
  perform_request("listLicenses", request, options: options, **kwargs)
end

#list_policies_by_product(request = nil, options: nil, **kwargs) ⇒ Object

List policies for a product



630
631
632
 
# File 'lib/licensekit/generated/clients.rb', line 630

def list_policies_by_product(request = nil, options: nil, **kwargs)
  perform_request("listPoliciesByProduct", request, options: options, **kwargs)
end

#list_product_custom_field_definitions(request = nil, options: nil, **kwargs) ⇒ Object

List product custom field definitions



635
636
637
 
# File 'lib/licensekit/generated/clients.rb', line 635

def list_product_custom_field_definitions(request = nil, options: nil, **kwargs)
  perform_request("listProductCustomFieldDefinitions", request, options: options, **kwargs)
end

#list_product_orders(request = nil, options: nil, **kwargs) ⇒ Object

List orders for a product



640
641
642
 
# File 'lib/licensekit/generated/clients.rb', line 640

def list_product_orders(request = nil, options: nil, **kwargs)
  perform_request("listProductOrders", request, options: options, **kwargs)
end

#list_product_subscriptions(request = nil, options: nil, **kwargs) ⇒ Object

List subscriptions for a product



645
646
647
 
# File 'lib/licensekit/generated/clients.rb', line 645

def list_product_subscriptions(request = nil, options: nil, **kwargs)
  perform_request("listProductSubscriptions", request, options: options, **kwargs)
end

#list_product_versions(request = nil, options: nil, **kwargs) ⇒ Object

List product versions



650
651
652
 
# File 'lib/licensekit/generated/clients.rb', line 650

def list_product_versions(request = nil, options: nil, **kwargs)
  perform_request("listProductVersions", request, options: options, **kwargs)
end

#list_products(request = nil, options: nil, **kwargs) ⇒ Object

List products



655
656
657
 
# File 'lib/licensekit/generated/clients.rb', line 655

def list_products(request = nil, options: nil, **kwargs)
  perform_request("listProducts", request, options: options, **kwargs)
end

#list_runtime_error_groups(request = nil, options: nil, **kwargs) ⇒ Object

List grouped runtime error counts



660
661
662
 
# File 'lib/licensekit/generated/clients.rb', line 660

def list_runtime_error_groups(request = nil, options: nil, **kwargs)
  perform_request("listRuntimeErrorGroups", request, options: options, **kwargs)
end

#list_usage_ledger(request = nil, options: nil, **kwargs) ⇒ Object

List row-level usage ledger entries



665
666
667
 
# File 'lib/licensekit/generated/clients.rb', line 665

def list_usage_ledger(request = nil, options: nil, **kwargs)
  perform_request("listUsageLedger", request, options: options, **kwargs)
end

#list_webhook_endpoints(request = nil, options: nil, **kwargs) ⇒ Object

List webhook endpoints



670
671
672
 
# File 'lib/licensekit/generated/clients.rb', line 670

def list_webhook_endpoints(request = nil, options: nil, **kwargs)
  perform_request("listWebhookEndpoints", request, options: options, **kwargs)
end

#reinstate_license(request = nil, options: nil, **kwargs) ⇒ Object

Reinstate a suspended license



675
676
677
 
# File 'lib/licensekit/generated/clients.rb', line 675

def reinstate_license(request = nil, options: nil, **kwargs)
  perform_request("reinstateLicense", request, options: options, **kwargs)
end

#remove_license_feature(request = nil, options: nil, **kwargs) ⇒ Object

Remove a feature assignment from a license



680
681
682
 
# File 'lib/licensekit/generated/clients.rb', line 680

def remove_license_feature(request = nil, options: nil, **kwargs)
  perform_request("removeLicenseFeature", request, options: options, **kwargs)
end

#renew_license(request = nil, options: nil, **kwargs) ⇒ Object

Renew or extend a renewable license



685
686
687
 
# File 'lib/licensekit/generated/clients.rb', line 685

def renew_license(request = nil, options: nil, **kwargs)
  perform_request("renewLicense", request, options: options, **kwargs)
end

#reset_license_device(request = nil, options: nil, **kwargs) ⇒ Object

Reset a managed device and clear its active state



690
691
692
 
# File 'lib/licensekit/generated/clients.rb', line 690

def reset_license_device(request = nil, options: nil, **kwargs)
  perform_request("resetLicenseDevice", request, options: options, **kwargs)
end

#reset_license_usage(request = nil, options: nil, **kwargs) ⇒ Object

Reset or top up metered feature usage



695
696
697
 
# File 'lib/licensekit/generated/clients.rb', line 695

def reset_license_usage(request = nil, options: nil, **kwargs)
  perform_request("resetLicenseUsage", request, options: options, **kwargs)
end

#revoke_license(request = nil, options: nil, **kwargs) ⇒ Object

Revoke a license and clear active seats



700
701
702
 
# File 'lib/licensekit/generated/clients.rb', line 700

def revoke_license(request = nil, options: nil, **kwargs)
  perform_request("revokeLicense", request, options: options, **kwargs)
end

#suspend_license(request = nil, options: nil, **kwargs) ⇒ Object

Suspend a license



705
706
707
 
# File 'lib/licensekit/generated/clients.rb', line 705

def suspend_license(request = nil, options: nil, **kwargs)
  perform_request("suspendLicense", request, options: options, **kwargs)
end

#transfer_license(request = nil, options: nil, **kwargs) ⇒ Object

Transfer a license to another assignee



710
711
712
 
# File 'lib/licensekit/generated/clients.rb', line 710

def transfer_license(request = nil, options: nil, **kwargs)
  perform_request("transferLicense", request, options: options, **kwargs)
end

#update_customer(request = nil, options: nil, **kwargs) ⇒ Object

Update a customer



715
716
717
 
# File 'lib/licensekit/generated/clients.rb', line 715

def update_customer(request = nil, options: nil, **kwargs)
  perform_request("updateCustomer", request, options: options, **kwargs)
end

#update_order(request = nil, options: nil, **kwargs) ⇒ Object

Update an order record



720
721
722
 
# File 'lib/licensekit/generated/clients.rb', line 720

def update_order(request = nil, options: nil, **kwargs)
  perform_request("updateOrder", request, options: options, **kwargs)
end

#update_policy(request = nil, options: nil, **kwargs) ⇒ Object

Update a policy



725
726
727
 
# File 'lib/licensekit/generated/clients.rb', line 725

def update_policy(request = nil, options: nil, **kwargs)
  perform_request("updatePolicy", request, options: options, **kwargs)
end

#update_product(request = nil, options: nil, **kwargs) ⇒ Object

Update a product



730
731
732
 
# File 'lib/licensekit/generated/clients.rb', line 730

def update_product(request = nil, options: nil, **kwargs)
  perform_request("updateProduct", request, options: options, **kwargs)
end

#update_product_custom_field_definition(request = nil, options: nil, **kwargs) ⇒ Object

Update a product custom field definition



735
736
737
 
# File 'lib/licensekit/generated/clients.rb', line 735

def update_product_custom_field_definition(request = nil, options: nil, **kwargs)
  perform_request("updateProductCustomFieldDefinition", request, options: options, **kwargs)
end

#update_subscription(request = nil, options: nil, **kwargs) ⇒ Object

Update a subscription record



740
741
742
 
# File 'lib/licensekit/generated/clients.rb', line 740

def update_subscription(request = nil, options: nil, **kwargs)
  perform_request("updateSubscription", request, options: options, **kwargs)
end

#update_webhook_endpoint(request = nil, options: nil, **kwargs) ⇒ Object

Update a webhook endpoint



745
746
747
 
# File 'lib/licensekit/generated/clients.rb', line 745

def update_webhook_endpoint(request = nil, options: nil, **kwargs)
  perform_request("updateWebhookEndpoint", request, options: options, **kwargs)
end

#upsert_customer_custom_field_value(request = nil, options: nil, **kwargs) ⇒ Object

Upsert a customer custom field value



750
751
752
 
# File 'lib/licensekit/generated/clients.rb', line 750

def upsert_customer_custom_field_value(request = nil, options: nil, **kwargs)
  perform_request("upsertCustomerCustomFieldValue", request, options: options, **kwargs)
end

#upsert_license_custom_field_value(request = nil, options: nil, **kwargs) ⇒ Object

Upsert a license custom field value



755
756
757
 
# File 'lib/licensekit/generated/clients.rb', line 755

def upsert_license_custom_field_value(request = nil, options: nil, **kwargs)
  perform_request("upsertLicenseCustomFieldValue", request, options: options, **kwargs)
end