feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 126
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-90b631890d57a96df99cc973fedfb48e6278b025dcb6262519eb064044d47efe.yml
-openapi_spec_hash: b17b00ef11d479516d6f1e5a323aef28
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-c92fb451e13f157b3735f188acc8d57aa3adfbaac1683645e1ba4f432dd7a4f8.yml
+openapi_spec_hash: dbcd87ecfbd3976eb3b99ec6f9fbc606
 config_hash: bcf82bddb691f6be773ac6cae8c03b9a

src/resources/credit-blocks.ts

@@ -52,6 +52,14 @@ export interface CreditBlockRetrieveResponse {
 
   maximum_initial_balance: number | null;
 
+  /**
+   * User specified key-value pairs for the resource. If not present, this defaults
+   * to an empty dictionary. Individual keys can be removed by setting the value to
+   * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+   * `null`.
+   */
+  metadata: { [key: string]: string };
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';

src/resources/customers/credits/credits.ts

@@ -54,6 +54,11 @@ export class Credits extends APIResource {
    *
    * Note that `currency` defaults to credits if not specified. To use a real world
    * currency, set `currency` to an ISO 4217 string.
+   *
+   * Results can be filtered by the block's `effective_date` using the
+   * `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
+   * `effective_date[lte]` query parameters. This filters on when the credit block
+   * becomes effective, which may differ from creation time for backdated credits.
    */
   list(
     customerId: string,
@@ -86,6 +91,11 @@ export class Credits extends APIResource {
    *
    * Note that `currency` defaults to credits if not specified. To use a real world
    * currency, set `currency` to an ISO 4217 string.
+   *
+   * Results can be filtered by the block's `effective_date` using the
+   * `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
+   * `effective_date[lte]` query parameters. This filters on when the credit block
+   * becomes effective, which may differ from creation time for backdated credits.
    */
   listByExternalId(
     externalCustomerId: string,
@@ -129,6 +139,14 @@ export interface CreditListResponse {
 
   maximum_initial_balance: number | null;
 
+  /**
+   * User specified key-value pairs for the resource. If not present, this defaults
+   * to an empty dictionary. Individual keys can be removed by setting the value to
+   * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+   * `null`.
+   */
+  metadata: { [key: string]: string };
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';
@@ -169,6 +187,14 @@ export interface CreditListByExternalIDResponse {
 
   maximum_initial_balance: number | null;
 
+  /**
+   * User specified key-value pairs for the resource. If not present, this defaults
+   * to an empty dictionary. Individual keys can be removed by setting the value to
+   * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+   * `null`.
+   */
+  metadata: { [key: string]: string };
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';
@@ -202,6 +228,14 @@ export interface CreditListParams extends PageParams {
    */
   currency?: string | null;
 
+  'effective_date[gt]'?: string | null;
+
+  'effective_date[gte]'?: string | null;
+
+  'effective_date[lt]'?: string | null;
+
+  'effective_date[lte]'?: string | null;
+
   /**
    * If set to True, all expired and depleted blocks, as well as active block will be
    * returned.
@@ -215,6 +249,14 @@ export interface CreditListByExternalIDParams extends PageParams {
    */
   currency?: string | null;
 
+  'effective_date[gt]'?: string | null;
+
+  'effective_date[gte]'?: string | null;
+
+  'effective_date[lt]'?: string | null;
+
+  'effective_date[lte]'?: string | null;
+
   /**
    * If set to True, all expired and depleted blocks, as well as active block will be
    * returned.

tests/api-resources/customers/credits/credits.test.ts

@@ -35,6 +35,10 @@ describe('resource credits', () => {
         {
           currency: 'currency',
           cursor: 'cursor',
+          'effective_date[gt]': '2019-12-27T18:11:19.117Z',
+          'effective_date[gte]': '2019-12-27T18:11:19.117Z',
+          'effective_date[lt]': '2019-12-27T18:11:19.117Z',
+          'effective_date[lte]': '2019-12-27T18:11:19.117Z',
           include_all_blocks: true,
           limit: 1,
         },
@@ -69,6 +73,10 @@ describe('resource credits', () => {
         {
           currency: 'currency',
           cursor: 'cursor',
+          'effective_date[gt]': '2019-12-27T18:11:19.117Z',
+          'effective_date[gte]': '2019-12-27T18:11:19.117Z',
+          'effective_date[lt]': '2019-12-27T18:11:19.117Z',
+          'effective_date[lte]': '2019-12-27T18:11:19.117Z',
           include_all_blocks: true,
           limit: 1,
         },