metronome-sdk 0.1.0.pre.alpha.1

data/lib/metronome_sdk/resources/v1/credit_grants.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class CreditGrants
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CreditGrantCreateParams} for more details.
+        #
+        # Create a new credit grant
+        #
+        # @overload create(customer_id:, expires_at:, grant_amount:, name:, paid_amount:, priority:, credit_grant_type: nil, custom_fields: nil, effective_at: nil, invoice_date: nil, product_ids: nil, reason: nil, rollover_settings: nil, uniqueness_key: nil, request_options: {})
+        #
+        # @param customer_id [String] the Metronome ID of the customer
+        #
+        # @param expires_at [Time] The credit grant will only apply to usage or charges dated before this timestamp
+        # ...
+        #
+        # @param grant_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
+        #
+        # @param name [String] the name of the credit grant as it will appear on invoices
+        #
+        # @param paid_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
+        #
+        # @param priority [Float]
+        #
+        # @param credit_grant_type [String]
+        #
+        # @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the credit grant.
+        #
+        # @param effective_at [Time] The credit grant will only apply to usage or charges dated on or after this time
+        # ...
+        #
+        # @param invoice_date [Time] The date to issue an invoice for the paid_amount.
+        #
+        # @param product_ids [Array<String>] The product(s) which these credits will be applied to. (If unspecified, the cred
+        # ...
+        #
+        # @param reason [String]
+        #
+        # @param rollover_settings [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
+        # ...
+        #
+        # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CreditGrantCreateResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CreditGrantCreateParams
+        def create(params)
+          parsed, options = MetronomeSDK::Models::V1::CreditGrantCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/credits/createGrant",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::CreditGrantCreateResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CreditGrantListParams} for more details.
+        #
+        # List credit grants. This list does not included voided grants.
+        #
+        # @overload list(limit: nil, next_page: nil, credit_grant_ids: nil, credit_type_ids: nil, customer_ids: nil, effective_before: nil, not_expiring_before: nil, request_options: {})
+        #
+        # @param limit [Integer] Query param: Max number of results that should be returned
+        #
+        # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
+        #
+        # @param credit_grant_ids [Array<String>] Body param: An array of credit grant IDs. If this is specified, neither credit_t
+        # ...
+        #
+        # @param credit_type_ids [Array<String>] Body param: An array of credit type IDs. This must not be specified if credit_gr
+        # ...
+        #
+        # @param customer_ids [Array<String>] Body param: An array of Metronome customer IDs. This must not be specified if cr
+        # ...
+        #
+        # @param effective_before [Time] Body param: Only return credit grants that are effective before this timestamp (
+        # ...
+        #
+        # @param not_expiring_before [Time] Body param: Only return credit grants that expire at or after this timestamp.
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::CreditGrantListResponse>]
+        #
+        # @see MetronomeSDK::Models::V1::CreditGrantListParams
+        def list(params = {})
+          parsed, options = MetronomeSDK::Models::V1::CreditGrantListParams.dump_request(params)
+          query_params = [:limit, :next_page]
+          @client.request(
+            method: :post,
+            path: "v1/credits/listGrants",
+            query: parsed.slice(*query_params),
+            body: parsed.except(*query_params),
+            page: MetronomeSDK::Internal::CursorPage,
+            model: MetronomeSDK::Models::V1::CreditGrantListResponse,
+            options: options
+          )
+        end
+
+        # Edit an existing credit grant
+        #
+        # @overload edit(id:, credit_grant_type: nil, expires_at: nil, name: nil, request_options: {})
+        #
+        # @param id [String] the ID of the credit grant
+        #
+        # @param credit_grant_type [String] the updated credit grant type
+        #
+        # @param expires_at [Time] the updated expiration date for the credit grant
+        #
+        # @param name [String] the updated name for the credit grant
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CreditGrantEditResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CreditGrantEditParams
+        def edit(params)
+          parsed, options = MetronomeSDK::Models::V1::CreditGrantEditParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/credits/editGrant",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::CreditGrantEditResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CreditGrantListEntriesParams} for more details.
+        #
+        # Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
+        # Ledger entries are returned in chronological order. Ledger entries associated
+        # with voided credit grants are not included.
+        #
+        # @overload list_entries(next_page: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
+        #
+        # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
+        #
+        # @param credit_type_ids [Array<String>] Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
+        # ...
+        #
+        # @param customer_ids [Array<String>] Body param: A list of Metronome customer IDs to fetch ledger entries for. If abs
+        # ...
+        #
+        # @param ending_before [Time] Body param: If supplied, ledger entries will only be returned with an
+        # effective\_ ...
+        #
+        # @param starting_on [Time] Body param: If supplied, only ledger entries effective at or after this time wil
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CreditGrantListEntriesParams
+        def list_entries(params = {})
+          parsed, options = MetronomeSDK::Models::V1::CreditGrantListEntriesParams.dump_request(params)
+          query_params = [:next_page]
+          @client.request(
+            method: :post,
+            path: "v1/credits/listEntries",
+            query: parsed.slice(*query_params),
+            body: parsed.except(*query_params),
+            model: MetronomeSDK::Models::V1::CreditGrantListEntriesResponse,
+            options: options
+          )
+        end
+
+        # Void a credit grant
+        #
+        # @overload void(id:, release_uniqueness_key: nil, void_credit_purchase_invoice: nil, request_options: {})
+        #
+        # @param id [String]
+        #
+        # @param release_uniqueness_key [Boolean] If true, resets the uniqueness key on this grant so it can be re-used
+        #
+        # @param void_credit_purchase_invoice [Boolean] If true, void the purchase invoice associated with the grant
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CreditGrantVoidResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CreditGrantVoidParams
+        def void(params)
+          parsed, options = MetronomeSDK::Models::V1::CreditGrantVoidParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/credits/voidGrant",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::CreditGrantVoidResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MetronomeSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/resources/v1/custom_fields.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class CustomFields
+        # Add a key to the allow list for a given entity. There is a 100 character limit
+        # on custom field keys.
+        #
+        # @overload add_key(enforce_uniqueness:, entity:, key:, request_options: {})
+        #
+        # @param enforce_uniqueness [Boolean]
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldAddKeyParams::Entity]
+        # @param key [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see MetronomeSDK::Models::V1::CustomFieldAddKeyParams
+        def add_key(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomFieldAddKeyParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/customFields/addKey",
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Deletes one or more custom fields on an instance of a Metronome entity.
+        #
+        # @overload delete_values(entity:, entity_id:, keys:, request_options: {})
+        #
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::Entity]
+        # @param entity_id [String]
+        # @param keys [Array<String>]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams
+        def delete_values(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/customFields/deleteValues",
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # List all active custom field keys, optionally filtered by entity type.
+        #
+        # @overload list_keys(next_page: nil, entities: nil, request_options: {})
+        #
+        # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
+        #
+        # @param entities [Array<Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity>] Body param: Optional list of entity types to return keys for
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CustomFieldListKeysResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CustomFieldListKeysParams
+        def list_keys(params = {})
+          parsed, options = MetronomeSDK::Models::V1::CustomFieldListKeysParams.dump_request(params)
+          query_params = [:next_page]
+          @client.request(
+            method: :post,
+            path: "v1/customFields/listKeys",
+            query: parsed.slice(*query_params),
+            body: parsed.except(*query_params),
+            model: MetronomeSDK::Models::V1::CustomFieldListKeysResponse,
+            options: options
+          )
+        end
+
+        # Remove a key from the allow list for a given entity.
+        #
+        # @overload remove_key(entity:, key:, request_options: {})
+        #
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity]
+        # @param key [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams
+        def remove_key(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/customFields/removeKey",
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        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.
+        #
+        # @overload set_values(custom_fields:, entity:, entity_id:, request_options: {})
+        #
+        # @param custom_fields [Hash{Symbol=>String}]
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity]
+        # @param entity_id [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see MetronomeSDK::Models::V1::CustomFieldSetValuesParams
+        def set_values(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomFieldSetValuesParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/customFields/setValues",
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MetronomeSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/resources/v1/customers/alerts.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Alerts
+          # Get the customer alert status and alert information for the specified customer
+          # and alert
+          #
+          # @overload retrieve(alert_id:, customer_id:, request_options: {})
+          #
+          # @param alert_id [String] The Metronome ID of the alert
+          #
+          # @param customer_id [String] The Metronome ID of the customer
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::AlertRetrieveParams
+          def retrieve(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::AlertRetrieveParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/customer-alerts/get",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::AlertListParams} for more details.
+          #
+          # Fetch all customer alert statuses and alert information for a customer
+          #
+          # @overload list(customer_id:, next_page: nil, alert_statuses: nil, request_options: {})
+          #
+          # @param customer_id [String] Body param: The Metronome ID of the customer
+          #
+          # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
+          #
+          # @param alert_statuses [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>] Body param: Optionally filter by alert status. If absent, only enabled alerts wi
+          # ...
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::AlertListResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::AlertListParams
+          def list(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::AlertListParams.dump_request(params)
+            query_params = [:next_page]
+            @client.request(
+              method: :post,
+              path: "v1/customer-alerts/list",
+              query: parsed.slice(*query_params),
+              body: parsed.except(*query_params),
+              model: MetronomeSDK::Models::V1::Customers::AlertListResponse,
+              options: options
+            )
+          end
+
+          # Reset state for an alert by customer id and force re-evaluation
+          #
+          # @overload reset(alert_id:, customer_id:, request_options: {})
+          #
+          # @param alert_id [String] The Metronome ID of the alert
+          #
+          # @param customer_id [String] The Metronome ID of the customer
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::AlertResetParams
+          def reset(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::AlertResetParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/customer-alerts/reset",
+              body: parsed,
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [MetronomeSDK::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/resources/v1/customers/billing_config.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class BillingConfig
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams} for more
+          # details.
+          #
+          # Set the billing configuration for a given customer.
+          #
+          # @overload create(customer_id:, billing_provider_type:, billing_provider_customer_id:, aws_product_code: nil, aws_region: nil, stripe_collection_method: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::BillingProviderType] Path param: The billing provider (e.g. stripe)
+          #
+          # @param billing_provider_customer_id [String] Body param: The customer ID in the billing provider's system. For Azure, this is
+          # ...
+          #
+          # @param aws_product_code [String] Body param:
+          #
+          # @param aws_region [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion] Body param:
+          #
+          # @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param:
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams
+          def create(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            billing_provider_type =
+              parsed.delete(:billing_provider_type) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :post,
+              path: ["v1/customers/%1$s/billing-config/%2$s", customer_id, billing_provider_type],
+              body: parsed,
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # Fetch the billing configuration for the given customer.
+          #
+          # @overload retrieve(customer_id:, billing_provider_type:, request_options: {})
+          #
+          # @param customer_id [String]
+          #
+          # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams::BillingProviderType] The billing provider (e.g. stripe)
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams
+          def retrieve(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            billing_provider_type =
+              parsed.delete(:billing_provider_type) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["v1/customers/%1$s/billing-config/%2$s", customer_id, billing_provider_type],
+              model: MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse,
+              options: options
+            )
+          end
+
+          # Delete the billing configuration for a given customer. Note: this is unsupported
+          # for Azure and AWS Marketplace customers.
+          #
+          # @overload delete(customer_id:, billing_provider_type:, request_options: {})
+          #
+          # @param customer_id [String]
+          #
+          # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams::BillingProviderType] The billing provider (e.g. stripe)
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams
+          def delete(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            billing_provider_type =
+              parsed.delete(:billing_provider_type) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["v1/customers/%1$s/billing-config/%2$s", customer_id, billing_provider_type],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [MetronomeSDK::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end