@metronome/sdk 0.1.0-alpha.0

package/resources/credit-grants.d.ts

@@ -0,0 +1,469 @@
+import * as Core from '@metronome/sdk/core';
+import { APIResource } from '@metronome/sdk/resource';
+import * as CreditGrantsAPI from '@metronome/sdk/resources/credit-grants';
+import * as Shared from '@metronome/sdk/resources/shared';
+export declare class CreditGrants extends APIResource {
+    /**
+     * Create a new credit grant
+     */
+    create(body: CreditGrantCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantCreateResponse>;
+    /**
+     * List credit grants. This list does not included voided grants.
+     */
+    list(params?: CreditGrantListParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantListResponse>;
+    list(options?: Core.RequestOptions): Core.APIPromise<CreditGrantListResponse>;
+    /**
+     * Edit an existing credit grant
+     */
+    edit(body: CreditGrantEditParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantEditResponse>;
+    /**
+     * List all pricing units (known in the API by the legacy term "credit types").
+     */
+    listCreditTypes(query?: CreditGrantListCreditTypesParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantListCreditTypesResponse>;
+    listCreditTypes(options?: Core.RequestOptions): Core.APIPromise<CreditGrantListCreditTypesResponse>;
+    /**
+     * 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.
+     */
+    listEntries(params?: CreditGrantListEntriesParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantListEntriesResponse>;
+    listEntries(options?: Core.RequestOptions): Core.APIPromise<CreditGrantListEntriesResponse>;
+    /**
+     * Void a credit grant
+     */
+    void(body: CreditGrantVoidParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantVoidResponse>;
+}
+export interface CreditLedgerEntry {
+    /**
+     * an amount representing the change to the customer's credit balance
+     */
+    amount: number;
+    created_by: string;
+    /**
+     * the credit grant this entry is related to
+     */
+    credit_grant_id: string;
+    effective_at: string;
+    reason: string;
+    /**
+     * the running balance for this credit type at the time of the ledger entry,
+     * including all preceding charges
+     */
+    running_balance: number;
+    /**
+     * if this entry is a deduction, the Metronome ID of the invoice where the credit
+     * deduction was consumed; if this entry is a grant, the Metronome ID of the
+     * invoice where the grant's paid_amount was charged
+     */
+    invoice_id?: string | null;
+}
+export interface RolloverAmountMaxAmount {
+    /**
+     * Rollover up to a fixed amount of the original credit grant amount.
+     */
+    type: 'MAX_AMOUNT';
+    /**
+     * The maximum amount to rollover.
+     */
+    value: number;
+}
+export interface RolloverAmountMaxPercentage {
+    /**
+     * Rollover up to a percentage of the original credit grant amount.
+     */
+    type: 'MAX_PERCENTAGE';
+    /**
+     * The maximum percentage (0-1) of the original credit grant to rollover.
+     */
+    value: number;
+}
+export interface CreditGrantCreateResponse {
+    data: Shared.ID;
+}
+export interface CreditGrantListResponse {
+    data: Array<CreditGrantListResponse.Data>;
+    next_page: string | null;
+}
+export declare namespace CreditGrantListResponse {
+    interface Data {
+        /**
+         * the Metronome ID of the credit grant
+         */
+        id: string;
+        /**
+         * The effective balance of the grant as of the end of the customer's current
+         * billing period. Expiration deductions will be included only if the grant expires
+         * before the end of the current billing period.
+         */
+        balance: Data.Balance;
+        custom_fields: Record<string, string>;
+        /**
+         * the Metronome ID of the customer
+         */
+        customer_id: string;
+        deductions: Array<CreditGrantsAPI.CreditLedgerEntry>;
+        effective_at: string;
+        expires_at: string;
+        /**
+         * the amount of credits initially granted
+         */
+        grant_amount: Data.GrantAmount;
+        name: string;
+        /**
+         * the amount paid for this credit grant
+         */
+        paid_amount: Data.PaidAmount;
+        pending_deductions: Array<CreditGrantsAPI.CreditLedgerEntry>;
+        priority: number;
+        credit_grant_type?: string | null;
+        /**
+         * the Metronome ID of the invoice with the purchase charge for this credit grant,
+         * if applicable
+         */
+        invoice_id?: string | null;
+        /**
+         * The products which these credits will be applied to. (If unspecified, the
+         * credits will be applied to charges for all products.)
+         */
+        products?: Array<Data.Product>;
+        reason?: string | null;
+        /**
+         * Prevents the creation of duplicates. If a request to create a record is made
+         * with a previously used uniqueness key, a new record will not be created and the
+         * request will fail with a 409 error.
+         */
+        uniqueness_key?: string | null;
+    }
+    namespace Data {
+        /**
+         * The effective balance of the grant as of the end of the customer's current
+         * billing period. Expiration deductions will be included only if the grant expires
+         * before the end of the current billing period.
+         */
+        interface Balance {
+            /**
+             * The end_date of the customer's current billing period.
+             */
+            effective_at: string;
+            /**
+             * The grant's current balance including all posted deductions. If the grant has
+             * expired, this amount will be 0.
+             */
+            excluding_pending: number;
+            /**
+             * The grant's current balance including all posted and pending deductions. If the
+             * grant expires before the end of the customer's current billing period, this
+             * amount will be 0.
+             */
+            including_pending: number;
+        }
+        /**
+         * the amount of credits initially granted
+         */
+        interface GrantAmount {
+            amount: number;
+            /**
+             * the credit type for the amount granted
+             */
+            credit_type: Shared.CreditType;
+        }
+        /**
+         * the amount paid for this credit grant
+         */
+        interface PaidAmount {
+            amount: number;
+            /**
+             * the credit type for the amount paid
+             */
+            credit_type: Shared.CreditType;
+        }
+        interface Product {
+            id: string;
+            name: string;
+        }
+    }
+}
+export interface CreditGrantEditResponse {
+    data: Shared.ID;
+}
+export interface CreditGrantListCreditTypesResponse {
+    data: Array<CreditGrantListCreditTypesResponse.Data>;
+    next_page: string | null;
+}
+export declare namespace CreditGrantListCreditTypesResponse {
+    interface Data {
+        id?: string;
+        is_currency?: boolean;
+        name?: string;
+    }
+}
+export interface CreditGrantListEntriesResponse {
+    data: Array<CreditGrantListEntriesResponse.Data>;
+    next_page: string | null;
+}
+export declare namespace CreditGrantListEntriesResponse {
+    interface Data {
+        customer_id: string;
+        ledgers: Array<Data.Ledger>;
+    }
+    namespace Data {
+        interface Ledger {
+            credit_type: Shared.CreditType;
+            /**
+             * the effective balances at the end of the specified time window
+             */
+            ending_balance: Ledger.EndingBalance;
+            entries: Array<CreditGrantsAPI.CreditLedgerEntry>;
+            pending_entries: Array<CreditGrantsAPI.CreditLedgerEntry>;
+            starting_balance: Ledger.StartingBalance;
+        }
+        namespace Ledger {
+            /**
+             * the effective balances at the end of the specified time window
+             */
+            interface EndingBalance {
+                /**
+                 * the ending_before request parameter (if supplied) or the current billing
+                 * period's end date
+                 */
+                effective_at: string;
+                /**
+                 * the ending balance, including the balance of all grants that have not expired
+                 * before the effective_at date and deductions that happened before the
+                 * effective_at date
+                 */
+                excluding_pending: number;
+                /**
+                 * the excluding_pending balance plus any pending invoice deductions and
+                 * expirations that will happen by the effective_at date
+                 */
+                including_pending: number;
+            }
+            interface StartingBalance {
+                /**
+                 * the starting_on request parameter (if supplied) or the first credit grant's
+                 * effective_at date
+                 */
+                effective_at: string;
+                /**
+                 * the starting balance, including all posted grants, deductions, and expirations
+                 * that happened at or before the effective_at timestamp
+                 */
+                excluding_pending: number;
+                /**
+                 * the excluding_pending balance plus any pending activity that has not been posted
+                 * at the time of the query
+                 */
+                including_pending: number;
+            }
+        }
+    }
+}
+export interface CreditGrantVoidResponse {
+    data: Shared.ID;
+}
+export interface CreditGrantCreateParams {
+    /**
+     * the Metronome ID of the customer
+     */
+    customer_id: string;
+    /**
+     * The credit grant will only apply to billing periods that end before this
+     * timestamp.
+     */
+    expires_at: string;
+    /**
+     * the amount of credits granted
+     */
+    grant_amount: CreditGrantCreateParams.GrantAmount;
+    /**
+     * the name of the credit grant as it will appear on invoices
+     */
+    name: string;
+    /**
+     * the amount paid for this credit grant
+     */
+    paid_amount: CreditGrantCreateParams.PaidAmount;
+    priority: number;
+    credit_grant_type?: string;
+    /**
+     * Custom fields to attach to the credit grant.
+     */
+    custom_fields?: Record<string, string>;
+    /**
+     * The credit grant will only apply to billing periods that end at or after this
+     * timestamp.
+     */
+    effective_at?: string;
+    /**
+     * The date to issue an invoice for the paid_amount.
+     */
+    invoice_date?: string;
+    /**
+     * The product(s) which these credits will be applied to. (If unspecified, the
+     * credits will be applied to charges for all products.). The array ordering
+     * specified here will be used to determine the order in which credits will be
+     * applied to invoice line items
+     */
+    product_ids?: Array<string>;
+    reason?: string;
+    /**
+     * Configure a rollover for this credit grant so if it expires it rolls over a
+     * configured amount to a new credit grant. This feature is currently opt-in only.
+     * Contact Metronome to be added to the beta.
+     */
+    rollover_settings?: CreditGrantCreateParams.RolloverSettings;
+    /**
+     * Prevents the creation of duplicates. If a request to create a record is made
+     * with a previously used uniqueness key, a new record will not be created and the
+     * request will fail with a 409 error.
+     */
+    uniqueness_key?: string;
+}
+export declare namespace CreditGrantCreateParams {
+    /**
+     * the amount of credits granted
+     */
+    interface GrantAmount {
+        amount: number;
+        credit_type_id: string;
+    }
+    /**
+     * the amount paid for this credit grant
+     */
+    interface PaidAmount {
+        amount: number;
+        credit_type_id: string;
+    }
+    /**
+     * Configure a rollover for this credit grant so if it expires it rolls over a
+     * configured amount to a new credit grant. This feature is currently opt-in only.
+     * Contact Metronome to be added to the beta.
+     */
+    interface RolloverSettings {
+        /**
+         * The date to expire the rollover credits.
+         */
+        expires_at: string;
+        /**
+         * The priority to give the rollover credit grant that gets created when a rollover
+         * happens.
+         */
+        priority: number;
+        /**
+         * Specify how much to rollover to the rollover credit grant
+         */
+        rollover_amount: CreditGrantsAPI.RolloverAmountMaxPercentage | CreditGrantsAPI.RolloverAmountMaxAmount;
+    }
+}
+export interface CreditGrantListParams {
+    /**
+     * Query param: Max number of results that should be returned
+     */
+    limit?: number;
+    /**
+     * Query param: Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+    /**
+     * Body param: An array of credit grant IDs. If this is specified, neither
+     * credit_type_ids nor customer_ids may be specified.
+     */
+    credit_grant_ids?: Array<string>;
+    /**
+     * Body param: An array of credit type IDs. This must not be specified if
+     * credit_grant_ids is specified.
+     */
+    credit_type_ids?: Array<string>;
+    /**
+     * Body param: An array of Metronome customer IDs. This must not be specified if
+     * credit_grant_ids is specified.
+     */
+    customer_ids?: Array<string>;
+    /**
+     * Body param: Only return credit grants that are effective before this timestamp
+     * (exclusive).
+     */
+    effective_before?: string;
+    /**
+     * Body param: Only return credit grants that expire at or after this timestamp.
+     */
+    not_expiring_before?: string;
+}
+export interface CreditGrantEditParams {
+    /**
+     * the ID of the credit grant
+     */
+    id: string;
+    /**
+     * the updated expiration date for the credit grant
+     */
+    expires_at?: string;
+    /**
+     * the updated name for the credit grant
+     */
+    name?: string;
+}
+export interface CreditGrantListCreditTypesParams {
+    /**
+     * Max number of results that should be returned
+     */
+    limit?: number;
+    /**
+     * Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+}
+export interface CreditGrantListEntriesParams {
+    /**
+     * Query param: Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+    /**
+     * Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
+     * absent, ledger entries for all credit types will be returned.
+     */
+    credit_type_ids?: Array<string>;
+    /**
+     * Body param: A list of Metronome customer IDs to fetch ledger entries for. If
+     * absent, ledger entries for all customers will be returned.
+     */
+    customer_ids?: Array<string>;
+    /**
+     * Body param: If supplied, ledger entries will only be returned with an
+     * effective_at before this time. This timestamp must not be in the future. If no
+     * timestamp is supplied, all entries up to the start of the customer's next
+     * billing period will be returned.
+     */
+    ending_before?: string;
+    /**
+     * Body param: If supplied, only ledger entries effective at or after this time
+     * will be returned.
+     */
+    starting_on?: string;
+}
+export interface CreditGrantVoidParams {
+    id: string;
+    /**
+     * If true, void the purchase invoice associated with the grant
+     */
+    void_credit_purchase_invoice?: boolean;
+}
+export declare namespace CreditGrants {
+    export import CreditLedgerEntry = CreditGrantsAPI.CreditLedgerEntry;
+    export import RolloverAmountMaxAmount = CreditGrantsAPI.RolloverAmountMaxAmount;
+    export import RolloverAmountMaxPercentage = CreditGrantsAPI.RolloverAmountMaxPercentage;
+    export import CreditGrantCreateResponse = CreditGrantsAPI.CreditGrantCreateResponse;
+    export import CreditGrantListResponse = CreditGrantsAPI.CreditGrantListResponse;
+    export import CreditGrantEditResponse = CreditGrantsAPI.CreditGrantEditResponse;
+    export import CreditGrantListCreditTypesResponse = CreditGrantsAPI.CreditGrantListCreditTypesResponse;
+    export import CreditGrantListEntriesResponse = CreditGrantsAPI.CreditGrantListEntriesResponse;
+    export import CreditGrantVoidResponse = CreditGrantsAPI.CreditGrantVoidResponse;
+    export import CreditGrantCreateParams = CreditGrantsAPI.CreditGrantCreateParams;
+    export import CreditGrantListParams = CreditGrantsAPI.CreditGrantListParams;
+    export import CreditGrantEditParams = CreditGrantsAPI.CreditGrantEditParams;
+    export import CreditGrantListCreditTypesParams = CreditGrantsAPI.CreditGrantListCreditTypesParams;
+    export import CreditGrantListEntriesParams = CreditGrantsAPI.CreditGrantListEntriesParams;
+    export import CreditGrantVoidParams = CreditGrantsAPI.CreditGrantVoidParams;
+}
+//# sourceMappingURL=credit-grants.d.ts.map

package/resources/credit-grants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-grants.d.ts","sourceRoot":"","sources":["../src/resources/credit-grants.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,KAAK,eAAe,MAAM,wCAAwC,CAAC;AAC1E,OAAO,KAAK,MAAM,MAAM,iCAAiC,CAAC;AAE1D,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;OAEG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAC3C,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAY7E;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAI1G;;OAEG;IACH,eAAe,CACb,KAAK,CAAC,EAAE,gCAAgC,EACxC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC;IACtD,eAAe,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAWnG;;;;OAIG;IACH,WAAW,CACT,MAAM,CAAC,EAAE,4BAA4B,EACrC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;IAClD,WAAW,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;IAY3F;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG3G;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,YAAY,EAAE,MAAM,CAAC;IAErB,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE1C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;WAIG;QACH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEtC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;QAErD,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC;QAE/B,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;QAE7D,QAAQ,EAAE,MAAM,CAAC;QAEjB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE/B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;IAED,UAAiB,IAAI,CAAC;QACpB;;;;WAIG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;;;eAIG;YACH,iBAAiB,EAAE,MAAM,CAAC;SAC3B;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC;SAChC;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC;SAChC;QAED,UAAiB,OAAO;YACtB,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,KAAK,CAAC,kCAAkC,CAAC,IAAI,CAAC,CAAC;IAErD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,kCAAkC,CAAC;IAClD,UAAiB,IAAI;QACnB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAEjD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC;YAE/B;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC;YAErC,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;YAElD,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;YAE1D,gBAAgB,EAAE,MAAM,CAAC,eAAe,CAAC;SAC1C;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,aAAa;gBAC5B;;;mBAGG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;;;mBAIG;gBACH,iBAAiB,EAAE,MAAM,CAAC;gBAE1B;;;mBAGG;gBACH,iBAAiB,EAAE,MAAM,CAAC;aAC3B;YAED,UAAiB,eAAe;gBAC9B;;;mBAGG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;;mBAGG;gBACH,iBAAiB,EAAE,MAAM,CAAC;gBAE1B;;;mBAGG;gBACH,iBAAiB,EAAE,MAAM,CAAC;aAC3B;SACF;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC,WAAW,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAEhD,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,uBAAuB,CAAC,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,WAAW;QAC1B,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;;;OAIG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,eAAe,CAAC,2BAA2B,GAAG,eAAe,CAAC,uBAAuB,CAAC;KACxG;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;CACxC;AAED,yBAAiB,YAAY,CAAC;IAC5B,MAAM,QAAQ,iBAAiB,GAAG,eAAe,CAAC,iBAAiB,CAAC;IACpE,MAAM,QAAQ,uBAAuB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAChF,MAAM,QAAQ,2BAA2B,GAAG,eAAe,CAAC,2BAA2B,CAAC;IACxF,MAAM,QAAQ,yBAAyB,GAAG,eAAe,CAAC,yBAAyB,CAAC;IACpF,MAAM,QAAQ,uBAAuB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAChF,MAAM,QAAQ,uBAAuB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAChF,MAAM,QAAQ,kCAAkC,GAAG,eAAe,CAAC,kCAAkC,CAAC;IACtG,MAAM,QAAQ,8BAA8B,GAAG,eAAe,CAAC,8BAA8B,CAAC;IAC9F,MAAM,QAAQ,uBAAuB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAChF,MAAM,QAAQ,uBAAuB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAChF,MAAM,QAAQ,qBAAqB,GAAG,eAAe,CAAC,qBAAqB,CAAC;IAC5E,MAAM,QAAQ,qBAAqB,GAAG,eAAe,CAAC,qBAAqB,CAAC;IAC5E,MAAM,QAAQ,gCAAgC,GAAG,eAAe,CAAC,gCAAgC,CAAC;IAClG,MAAM,QAAQ,4BAA4B,GAAG,eAAe,CAAC,4BAA4B,CAAC;IAC1F,MAAM,QAAQ,qBAAqB,GAAG,eAAe,CAAC,qBAAqB,CAAC;CAC7E"}

package/resources/credit-grants.js

@@ -0,0 +1,50 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreditGrants = void 0;
+const resource_1 = require("@metronome/sdk/resource");
+const core_1 = require("@metronome/sdk/core");
+class CreditGrants extends resource_1.APIResource {
+    /**
+     * Create a new credit grant
+     */
+    create(body, options) {
+        return this._client.post('/credits/createGrant', { body, ...options });
+    }
+    list(params = {}, options) {
+        if ((0, core_1.isRequestOptions)(params)) {
+            return this.list({}, params);
+        }
+        const { limit, next_page, ...body } = params;
+        return this._client.post('/credits/listGrants', { query: { limit, next_page }, body, ...options });
+    }
+    /**
+     * Edit an existing credit grant
+     */
+    edit(body, options) {
+        return this._client.post('/credits/editGrant', { body, ...options });
+    }
+    listCreditTypes(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.listCreditTypes({}, query);
+        }
+        return this._client.get('/credit-types/list', { query, ...options });
+    }
+    listEntries(params = {}, options) {
+        if ((0, core_1.isRequestOptions)(params)) {
+            return this.listEntries({}, params);
+        }
+        const { next_page, ...body } = params;
+        return this._client.post('/credits/listEntries', { query: { next_page }, body, ...options });
+    }
+    /**
+     * Void a credit grant
+     */
+    void(body, options) {
+        return this._client.post('/credits/voidGrant', { body, ...options });
+    }
+}
+exports.CreditGrants = CreditGrants;
+(function (CreditGrants) {
+})(CreditGrants = exports.CreditGrants || (exports.CreditGrants = {}));
+//# sourceMappingURL=credit-grants.js.map

package/resources/credit-grants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-grants.js","sourceRoot":"","sources":["../src/resources/credit-grants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,sDAAsD;AACtD,8CAAuD;AAIvD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAUD,IAAI,CACF,SAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAUD,eAAe,CACb,QAAgE,EAAE,EAClE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAYD,WAAW,CACT,SAA6D,EAAE,EAC/D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SACrC;QACD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAlFD,oCAkFC;AAwgBD,WAAiB,YAAY;AAgB7B,CAAC,EAhBgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAgB5B"}

package/resources/credit-grants.mjs

@@ -0,0 +1,46 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from '@metronome/sdk/resource';
+import { isRequestOptions } from '@metronome/sdk/core';
+export class CreditGrants extends APIResource {
+    /**
+     * Create a new credit grant
+     */
+    create(body, options) {
+        return this._client.post('/credits/createGrant', { body, ...options });
+    }
+    list(params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.list({}, params);
+        }
+        const { limit, next_page, ...body } = params;
+        return this._client.post('/credits/listGrants', { query: { limit, next_page }, body, ...options });
+    }
+    /**
+     * Edit an existing credit grant
+     */
+    edit(body, options) {
+        return this._client.post('/credits/editGrant', { body, ...options });
+    }
+    listCreditTypes(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.listCreditTypes({}, query);
+        }
+        return this._client.get('/credit-types/list', { query, ...options });
+    }
+    listEntries(params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.listEntries({}, params);
+        }
+        const { next_page, ...body } = params;
+        return this._client.post('/credits/listEntries', { query: { next_page }, body, ...options });
+    }
+    /**
+     * Void a credit grant
+     */
+    void(body, options) {
+        return this._client.post('/credits/voidGrant', { body, ...options });
+    }
+}
+(function (CreditGrants) {
+})(CreditGrants || (CreditGrants = {}));
+//# sourceMappingURL=credit-grants.mjs.map

package/resources/credit-grants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-grants.mjs","sourceRoot":"","sources":["../src/resources/credit-grants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,yBAAyB;OAC9C,EAAE,gBAAgB,EAAE,MAAM,qBAAqB;AAItD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAUD,IAAI,CACF,SAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAUD,eAAe,CACb,QAAgE,EAAE,EAClE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAYD,WAAW,CACT,SAA6D,EAAE,EAC/D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SACrC;QACD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAwgBD,WAAiB,YAAY;AAgB7B,CAAC,EAhBgB,YAAY,KAAZ,YAAY,QAgB5B"}

package/resources/custom-fields.d.ts

@@ -0,0 +1,82 @@
+import * as Core from '@metronome/sdk/core';
+import { APIResource } from '@metronome/sdk/resource';
+import * as CustomFieldsAPI from '@metronome/sdk/resources/custom-fields';
+export declare class CustomFields extends APIResource {
+    /**
+     * Add a key to the allow list for a given entity. There is a 100 character limit
+     * on custom field keys.
+     */
+    addKey(body: CustomFieldAddKeyParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * Deletes one or more custom fields on an instance of a Metronome entity.
+     */
+    deleteValues(body: CustomFieldDeleteValuesParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * List all active custom field keys, optionally filtered by entity type.
+     */
+    listKeys(params?: CustomFieldListKeysParams, options?: Core.RequestOptions): Core.APIPromise<CustomFieldListKeysResponse>;
+    listKeys(options?: Core.RequestOptions): Core.APIPromise<CustomFieldListKeysResponse>;
+    /**
+     * Remove a key from the allow list for a given entity.
+     */
+    removeKey(body: CustomFieldRemoveKeyParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * 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.
+     */
+    setValues(body: CustomFieldSetValuesParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+}
+export interface CustomFieldListKeysResponse {
+    data: Array<CustomFieldListKeysResponse.Data>;
+    next_page: string | null;
+}
+export declare namespace CustomFieldListKeysResponse {
+    interface Data {
+        enforce_uniqueness: boolean;
+        entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+        key: string;
+    }
+}
+export interface CustomFieldAddKeyParams {
+    enforce_uniqueness: boolean;
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    key: string;
+}
+export interface CustomFieldDeleteValuesParams {
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    entity_id: string;
+    keys: Array<string>;
+}
+export interface CustomFieldListKeysParams {
+    /**
+     * Query param: Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+    /**
+     * Body param: Optional list of entity types to return keys for
+     */
+    entities?: Array<'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge'>;
+}
+export interface CustomFieldRemoveKeyParams {
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    key: string;
+}
+export interface CustomFieldSetValuesParams {
+    custom_fields: Record<string, string>;
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    entity_id: string;
+}
+export declare namespace CustomFields {
+    export import CustomFieldListKeysResponse = CustomFieldsAPI.CustomFieldListKeysResponse;
+    export import CustomFieldAddKeyParams = CustomFieldsAPI.CustomFieldAddKeyParams;
+    export import CustomFieldDeleteValuesParams = CustomFieldsAPI.CustomFieldDeleteValuesParams;
+    export import CustomFieldListKeysParams = CustomFieldsAPI.CustomFieldListKeysParams;
+    export import CustomFieldRemoveKeyParams = CustomFieldsAPI.CustomFieldRemoveKeyParams;
+    export import CustomFieldSetValuesParams = CustomFieldsAPI.CustomFieldSetValuesParams;
+}
+//# sourceMappingURL=custom-fields.d.ts.map