metronome_api 1.0.0

data/lib/metronome_api.rb

@@ -0,0 +1,1545 @@
+# Generated by Sideko (sideko.dev)
+# frozen_string_literal: true
+require 'json'
+require 'http'
+
+class RequestError < StandardError
+  attr_reader :status_code, :method, :url, :data, :response
+
+  def initialize(method, url, response)
+    @status_code = response.status
+    @method = method
+    @url = url
+    begin
+      @data = response.parse
+    rescue
+      @data = nil
+    end
+    @response = response
+
+    super("received #{status_code} from #{method} #{url} with #{message}")
+  end
+end
+
+module AuthProvider
+  def add_auth(http_client, req_kwargs)
+    raise NotImplementedError, "You must implement the 'add_auth' method"
+  end
+end
+
+class AuthBasic
+  include AuthProvider
+
+  attr_accessor :username, :password
+
+  def initialize(username: nil, password: nil)
+    @username = username
+    @password = password
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@username.nil? && !@password.nil?
+      http_client = http_client.basic_auth(user: @username, pass: @password)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthBearer
+  include AuthProvider
+
+  attr_accessor :val
+
+  def initialize(val: nil)
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers["Authorization"] = "Bearer " + @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyQuery
+  include AuthProvider
+
+  attr_accessor :query_name, :val
+
+  def initialize(query_name: nil, val: nil)
+    @query_name = query_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !val.nil?
+      params = req_kwargs.fetch(:params, {})
+      params[query_name] = val
+      req_kwargs[:params] = params
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyHeader
+  include AuthProvider
+
+  attr_accessor :header_name, :val
+
+  def initialize(header_name: nil, val: nil)
+    @header_name = header_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers[@header_name] = @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyCookie
+  include AuthProvider
+
+  attr_accessor :cookie_name, :val
+
+  def initialize(cookie_name: nil, val: nil)
+    @cookie_name = cookie_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      http_client = http_client.cookies(@cookie_name => @val)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class Client
+  def initialize(bearer_auth: nil, base_url: 'https://api.metronome.com/v1')
+    @_base_url = base_url
+    # register auth providers
+    @_auth = {}
+    @_auth[:"bearerAuth"] = AuthBearer.new(val: bearer_auth)
+  end
+
+  def _client_with_auth(auth_names, **req_kwargs)
+    http_client = HTTP
+    auth_names.each do |auth_name|
+      provider = @_auth[auth_name]
+      http_client, req_kwargs = provider.add_auth(http_client, req_kwargs) if provider
+    end
+    
+    return http_client, req_kwargs
+  end
+
+
+  # Delete the billing configuration for a given customer. Note: this is unsupported for Azure and AWS Marketplace customers.
+  # 
+  def delete_billing_config_for_customer(customer_id, billing_provider_type)
+    _url = @_base_url + "/customers/#{customer_id}/billing-config/#{billing_provider_type}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.delete(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="delete",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieves a range of audit logs. If no further audit logs are currently available, the data array will be empty. As new audit logs are created, subsequent requests using the same next_page value will be in the returned data array, ensuring a continuous and uninterrupted reading of audit logs.
+  # 
+  def get_audit_logs(limit: nil, next_page: nil, starting_on: nil)
+    _url = @_base_url + "/auditLogs"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    if starting_on != nil
+      _kwargs[:params][:"starting_on"] = starting_on
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List all pricing units (known in the API by the legacy term "credit types").
+  def list_credit_types(limit: nil, next_page: nil)
+    _url = @_base_url + "/credit-types/list"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List all customers.
+  def list_customers(customer_ids: nil, ingest_alias: nil, limit: nil, next_page: nil, only_archived: nil, salesforce_account_ids: nil)
+    _url = @_base_url + "/customers"
+    _kwargs = {
+      params: {}
+    }
+    if customer_ids != nil
+      _kwargs[:params][:"customer_ids"] = customer_ids.join(",")
+    end
+    if ingest_alias != nil
+      _kwargs[:params][:"ingest_alias"] = ingest_alias
+    end
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    if only_archived != nil
+      _kwargs[:params][:"only_archived"] = only_archived
+    end
+    if salesforce_account_ids != nil
+      _kwargs[:params][:"salesforce_account_ids"] = salesforce_account_ids.join(",")
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Get a customer by Metronome ID.
+  def get_customer(customer_id)
+    _url = @_base_url + "/customers/#{customer_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List all billable metrics.
+  def list_billable_metrics(customer_id, limit: nil, next_page: nil, on_current_plan: nil)
+    _url = @_base_url + "/customers/#{customer_id}/billable-metrics"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    if on_current_plan != nil
+      _kwargs[:params][:"on_current_plan"] = on_current_plan
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetch the billing configuration for the given customer.
+  def get_billing_config(customer_id, billing_provider_type)
+    _url = @_base_url + "/customers/#{customer_id}/billing-config/#{billing_provider_type}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetch daily pending costs for the specified customer, broken down by credit type and line items. Note: this is not supported for customers whose plan includes a UNIQUE-type billable metric.
+  def get_costs(customer_id, ending_before, starting_on, limit: nil, next_page: nil)
+    _url = @_base_url + "/customers/#{customer_id}/costs"
+    _kwargs = {
+      params: {}
+    }
+    _kwargs[:params][:"ending_before"] = ending_before
+    _kwargs[:params][:"starting_on"] = starting_on
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List all invoices for a given customer, optionally filtered by status, date range, and/or credit type.
+  def list_invoices(customer_id, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, sort: nil, starting_on: nil, status: nil)
+    _url = @_base_url + "/customers/#{customer_id}/invoices"
+    _kwargs = {
+      params: {}
+    }
+    if credit_type_id != nil
+      _kwargs[:params][:"credit_type_id"] = credit_type_id
+    end
+    if ending_before != nil
+      _kwargs[:params][:"ending_before"] = ending_before
+    end
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    if sort != nil
+      _kwargs[:params][:"sort"] = sort
+    end
+    if starting_on != nil
+      _kwargs[:params][:"starting_on"] = starting_on
+    end
+    if status != nil
+      _kwargs[:params][:"status"] = status
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetch a specific invoice for a given customer.
+  def get_invoice(customer_id, invoice_id)
+    _url = @_base_url + "/customers/#{customer_id}/invoices/#{invoice_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List the given customer's plans in reverse-chronological order.
+  def list_customer_plans(customer_id, limit: nil, next_page: nil)
+    _url = @_base_url + "/customers/#{customer_id}/plans"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Lists a customer plans adjustments. See the [price adjustments documentation](https://docs.metronome.com/pricing/managing-plans/#price-adjustments) for details.
+  def get_plan_price_adjustments(customer_id, customer_plan_id, limit: nil, next_page: nil)
+    _url = @_base_url + "/customers/#{customer_id}/plans/#{customer_plan_id}/priceAdjustments"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetch high level details of a specific plan.
+  def get_plan_details(plan_id)
+    _url = @_base_url + "/planDetails/#{plan_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetches a list of charges of a specific plan.
+  def get_plan_charges(plan_id, limit: nil, next_page: nil)
+    _url = @_base_url + "/planDetails/#{plan_id}/charges"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetches a list of customers on a specific plan (by default, only currently active plans are included)
+  def get_plan_customers(plan_id, limit: nil, next_page: nil, status: nil)
+    _url = @_base_url + "/planDetails/#{plan_id}/customers"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    if status != nil
+      _kwargs[:params][:"status"] = status
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List all available plans.
+  def list_plans(limit: nil, next_page: nil)
+    _url = @_base_url + "/plans"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Archive an existing alert
+  def archive_alert(data: nil)
+    _url = @_base_url + "/alerts/archive"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Create a new alert
+  def create_alert(data: nil)
+    _url = @_base_url + "/alerts/create"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Create a new credit grant
+  def create_grant(data: nil)
+    _url = @_base_url + "/credits/createGrant"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Edit an existing credit grant
+  def edit_grant(data: nil)
+    _url = @_base_url + "/credits/editGrant"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetches a list of credit ledger entries. Returns lists of ledgers per customer. Ledger entries are returned in reverse chronological order. Ledger entries associated with voided credit grants are not included.
+  def list_credit_ledger_entries(data: nil, next_page: nil)
+    _url = @_base_url + "/credits/listEntries"
+    _kwargs = {
+      params: {}
+    }
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List credit grants. This list does not included voided grants.
+  def list_grants(data: nil, next_page: nil)
+    _url = @_base_url + "/credits/listGrants"
+    _kwargs = {
+      params: {}
+    }
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Void a credit grant
+  def void_grant(data: nil)
+    _url = @_base_url + "/credits/voidGrant"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Add a key to the allow list for a given entity. There is a 100 character limit on custom field keys.
+  # 
+  def add_custom_field_key(data: nil)
+    _url = @_base_url + "/customFields/addKey"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Deletes one or more custom fields on an instance of a Metronome entity.
+  # 
+  def delete_custom_fields(data: nil)
+    _url = @_base_url + "/customFields/deleteValues"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List all active custom field keys, optionally filtered by entity type.
+  # 
+  def list_custom_field_keys(data: nil, next_page: nil)
+    _url = @_base_url + "/customFields/listKeys"
+    _kwargs = {
+      params: {}
+    }
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Remove a key from the allow list for a given entity.
+  # 
+  def disable_custom_field_key(data: nil)
+    _url = @_base_url + "/customFields/removeKey"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Sets one or more custom fields on an instance of a Metronome entity. If a key/value pair passed in this request matches one already set on the entity, its value will be overwritten. Any key/value pairs that exist on the entity that do not match those passed in this request will remain untouched. This endpoint is transactional and will update all key/value pairs or no key/value pairs. Partial updates are not supported. There is a 200 character limit on custom field values.
+  # 
+  def set_custom_fields(data: nil)
+    _url = @_base_url + "/customFields/setValues"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Get the customer alert status and alert information for the specified customer and alert
+  def get_customer_alert(data: nil)
+    _url = @_base_url + "/customer-alerts/get"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetch all customer alert statuses and alert information for a customer
+  def list_customer_alerts(data: nil, next_page: nil)
+    _url = @_base_url + "/customer-alerts/list"
+    _kwargs = {
+      params: {}
+    }
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Create a new customer
+  def create_customer(data: nil)
+    _url = @_base_url + "/customers"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Archive a customer
+  def archive_customer(data: nil)
+    _url = @_base_url + "/customers/archive"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Set the billing configuration for a given customer.
+  def set_billing_config_for_customer(data: nil, customer_id, billing_provider_type)
+    _url = @_base_url + "/customers/#{customer_id}/billing-config/#{billing_provider_type}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Associate an existing customer with a plan for a specified date range.  See the [price adjustments documentation](https://docs.metronome.com/pricing/managing-plans/#price-adjustments) for details on the price adjustments.
+  def add_plan_to_customer(data: nil, customer_id)
+    _url = @_base_url + "/customers/#{customer_id}/plans/add"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Change the end date of a customer's plan.
+  def end_customer_plan(data: nil, customer_id, customer_plan_id)
+    _url = @_base_url + "/customers/#{customer_id}/plans/#{customer_plan_id}/end"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Sets the ingest aliases for a customer. Ingest aliases can be used in the `customer_id` field when sending usage events to Metronome. This call is idempotent. It fully replaces the set of ingest aliases for the given customer.
+  # 
+  def set_ingest_aliases(data: nil, customer_id)
+    _url = @_base_url + "/customers/#{customer_id}/setIngestAliases"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Updates the specified customer's name.
+  # 
+  def set_customer_name(data: nil, customer_id)
+    _url = @_base_url + "/customers/#{customer_id}/setName"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Updates the specified customer's config.
+  # 
+  def update_customer_config(data: nil, customer_id)
+    _url = @_base_url + "/customers/#{customer_id}/updateConfig"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve an embeddable dashboard url for a customer.  The dashboard can be embedded using an iframe in a website.  This will show information such as usage data and customer invoices.
+  def embeddable_dashboard(data: nil)
+    _url = @_base_url + "/dashboards/getEmbeddableUrl"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Send usage events to Metronome. The body of this request is expected to be a JSON array of between 1 and 100 usage events. Compressed request bodies are supported with a `Content-Encoding: gzip` header. See [Getting usage into Metronome](https://docs.metronome.com/getting-usage-data-into-metronome/overview) to learn more about usage events.
+  # 
+  def ingest(data: nil)
+    _url = @_base_url + "/ingest"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetch aggregated usage data for multiple customers and billable-metrics, broken into intervals of the specified length.
+  def get_usage_batch(data: nil, next_page: nil)
+    _url = @_base_url + "/usage"
+    _kwargs = {
+      params: {}
+    }
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Fetch aggregated usage data for the specified customer, billable-metric, and optional group, broken into intervals of the specified length.
+  def get_paged_usage(data: nil, limit: nil, next_page: nil)
+    _url = @_base_url + "/usage/groups"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if next_page != nil
+      _kwargs[:params][:"next_page"] = next_page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+end