Class AsyncBillingLedgerPeriodsClient


  • public class AsyncBillingLedgerPeriodsClient
    extends java.lang.Object
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletableFuture<java.lang.String> closeV1​(java.lang.String billingLedgerPeriodId)
      Closes an OPEN billing ledger period.
      java.util.concurrent.CompletableFuture<java.lang.String> closeV1​(java.lang.String billingLedgerPeriodId, RequestOptions requestOptions)
      Closes an OPEN billing ledger period.
      java.util.concurrent.CompletableFuture<BillingLedgerPeriod1> getByIdV1​(java.lang.String id)
      Retrieves a billing ledger period the caller's org owns or is a payment counterparty on.
      java.util.concurrent.CompletableFuture<BillingLedgerPeriod1> getByIdV1​(java.lang.String id, RequestOptions requestOptions)
      Retrieves a billing ledger period the caller's org owns or is a payment counterparty on.
      java.util.concurrent.CompletableFuture<BillingLedgerPeriodListRes> listV1()
      Lists billing ledger periods the caller's org owns or is a payment counterparty on.
      java.util.concurrent.CompletableFuture<BillingLedgerPeriodListRes> listV1​(BillingLedgerPeriodsListV1Request request)
      Lists billing ledger periods the caller's org owns or is a payment counterparty on.
      java.util.concurrent.CompletableFuture<BillingLedgerPeriodListRes> listV1​(BillingLedgerPeriodsListV1Request request, RequestOptions requestOptions)
      Lists billing ledger periods the caller's org owns or is a payment counterparty on.
      java.util.concurrent.CompletableFuture<java.lang.String> openV1​(java.lang.String billingLedgerId, OpenPeriodReq request)
      Opens a new period on an ACTIVE billing ledger.
      java.util.concurrent.CompletableFuture<java.lang.String> openV1​(java.lang.String billingLedgerId, OpenPeriodReq request, RequestOptions requestOptions)
      Opens a new period on an ACTIVE billing ledger.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String billingLedgerPeriodId)
      Updates an OPEN billing ledger period's bounds, cycle, and/or rate_usd.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String billingLedgerPeriodId, BillingLedgerPeriodClientUpdate1 request)
      Updates an OPEN billing ledger period's bounds, cycle, and/or rate_usd.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String billingLedgerPeriodId, BillingLedgerPeriodClientUpdate1 request, RequestOptions requestOptions)
      Updates an OPEN billing ledger period's bounds, cycle, and/or rate_usd.
      AsyncRawBillingLedgerPeriodsClient withRawResponse()
      Get responses with HTTP metadata like headers
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AsyncBillingLedgerPeriodsClient

        public AsyncBillingLedgerPeriodsClient​(ClientOptions clientOptions)
    • Method Detail

      • getByIdV1

        public java.util.concurrent.CompletableFuture<BillingLedgerPeriod1> getByIdV1​(java.lang.String id)
        Retrieves a billing ledger period the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_period_org_operators] | () -> (BillingLedgerPeriod1)
      • getByIdV1

        public java.util.concurrent.CompletableFuture<BillingLedgerPeriod1> getByIdV1​(java.lang.String id,
                                                                                      RequestOptions requestOptions)
        Retrieves a billing ledger period the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_period_org_operators] | () -> (BillingLedgerPeriod1)
      • listV1

        public java.util.concurrent.CompletableFuture<BillingLedgerPeriodListRes> listV1()
        Lists billing ledger periods the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_period_org_operators] | () -> (BillingLedgerPeriodListRes)
      • listV1

        public java.util.concurrent.CompletableFuture<BillingLedgerPeriodListRes> listV1​(BillingLedgerPeriodsListV1Request request)
        Lists billing ledger periods the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_period_org_operators] | () -> (BillingLedgerPeriodListRes)
      • openV1

        public java.util.concurrent.CompletableFuture<java.lang.String> openV1​(java.lang.String billingLedgerId,
                                                                               OpenPeriodReq request)
        Opens a new period on an ACTIVE billing ledger. Operator supplies cycle, rate_usd, and at least one of (period_start_at_timestamp, period_end_at_timestamp) — the other is derived from cycle (calendar-aware). A period spans exactly one cycle. Multiple OPEN periods per ledger are allowed and may overlap. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (OpenPeriodReq) -> (PydanticObjectId)
      • openV1

        public java.util.concurrent.CompletableFuture<java.lang.String> openV1​(java.lang.String billingLedgerId,
                                                                               OpenPeriodReq request,
                                                                               RequestOptions requestOptions)
        Opens a new period on an ACTIVE billing ledger. Operator supplies cycle, rate_usd, and at least one of (period_start_at_timestamp, period_end_at_timestamp) — the other is derived from cycle (calendar-aware). A period spans exactly one cycle. Multiple OPEN periods per ledger are allowed and may overlap. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (OpenPeriodReq) -> (PydanticObjectId)
      • closeV1

        public java.util.concurrent.CompletableFuture<java.lang.String> closeV1​(java.lang.String billingLedgerPeriodId)
        Closes an OPEN billing ledger period. 400 if the period is already CLOSED. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_period_owner_operators] | () -> (PydanticObjectId)
      • closeV1

        public java.util.concurrent.CompletableFuture<java.lang.String> closeV1​(java.lang.String billingLedgerPeriodId,
                                                                                RequestOptions requestOptions)
        Closes an OPEN billing ledger period. 400 if the period is already CLOSED. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_period_owner_operators] | () -> (PydanticObjectId)
      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String billingLedgerPeriodId)
        Updates an OPEN billing ledger period's bounds, cycle, and/or rate_usd. Lenient: only end > start is enforced after the patch — span need not equal cycle. CLOSED periods are immutable. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_period_owner_operators] | (BillingLedgerPeriodClientUpdate1) -> (bool)
      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String billingLedgerPeriodId,
                                                                                  BillingLedgerPeriodClientUpdate1 request)
        Updates an OPEN billing ledger period's bounds, cycle, and/or rate_usd. Lenient: only end > start is enforced after the patch — span need not equal cycle. CLOSED periods are immutable. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_period_owner_operators] | (BillingLedgerPeriodClientUpdate1) -> (bool)
      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String billingLedgerPeriodId,
                                                                                  BillingLedgerPeriodClientUpdate1 request,
                                                                                  RequestOptions requestOptions)
        Updates an OPEN billing ledger period's bounds, cycle, and/or rate_usd. Lenient: only end > start is enforced after the patch — span need not equal cycle. CLOSED periods are immutable. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_period_owner_operators] | (BillingLedgerPeriodClientUpdate1) -> (bool)