fix: update outdated examples (#5)

stainless-app[bot] · stainless-app[bot] · commit 311b749020de · 2025-02-06T06:11:00.000Z
diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ non-success status code (i.e., 4xx or 5xx response), a subclass of
 begin
   customer = orb.customers.create(email: "example-customer@withorb.com", name: "My Customer")
 rescue Orb::Error => e
-  puts(e.code) # 400
+  puts(e.status) # 400
 end
 ```
 
@@ -92,7 +92,11 @@ orb = Orb::Client.new(
 )
 
 # Or, configure per-request:
-orb.customers.create(email: "example-customer@withorb.com", name: "My Customer", max_retries: 5)
+orb.customers.create(
+  email: "example-customer@withorb.com",
+  name: "My Customer",
+  request_options: {max_retries: 5}
+)
 ```
 
 ### Timeouts
@@ -110,7 +114,11 @@ orb = Orb::Client.new(
 )
 
 # Or, configure per-request:
-orb.customers.create(email: "example-customer@withorb.com", name: "My Customer", timeout: 5)
+orb.customers.create(
+  email: "example-customer@withorb.com",
+  name: "My Customer",
+  request_options: {timeout: 5}
+)
 ```
 
 ## Versioning
diff --git a/test/orb/resources/alerts_test.rb b/test/orb/resources/alerts_test.rb
@@ -19,7 +19,7 @@ def test_retrieve
   end
 
   def test_update_required_params
-    response = @orb.alerts.update("alert_configuration_id", thresholds: [{"value" => 0}])
+    response = @orb.alerts.update("alert_configuration_id", thresholds: [{value: 0}])
 
     assert_pattern do
       response => Orb::Models::Alert
@@ -42,7 +42,7 @@ def test_list
   end
 
   def test_create_for_customer_required_params
-    response = @orb.alerts.create_for_customer("customer_id", currency: "currency", type: "usage_exceeded")
+    response = @orb.alerts.create_for_customer("customer_id", currency: "currency", type: :usage_exceeded)
 
     assert_pattern do
       response => Orb::Models::Alert
@@ -53,7 +53,7 @@ def test_create_for_external_customer_required_params
     response = @orb.alerts.create_for_external_customer(
       "external_customer_id",
       currency: "currency",
-      type: "usage_exceeded"
+      type: :usage_exceeded
     )
 
     assert_pattern do
@@ -64,8 +64,8 @@ def test_create_for_external_customer_required_params
   def test_create_for_subscription_required_params
     response = @orb.alerts.create_for_subscription(
       "subscription_id",
-      thresholds: [{"value" => 0}],
-      type: "usage_exceeded"
+      thresholds: [{value: 0}],
+      type: :usage_exceeded
     )
 
     assert_pattern do
diff --git a/test/orb/resources/coupons_test.rb b/test/orb/resources/coupons_test.rb
@@ -12,7 +12,7 @@ def before_all
 
   def test_create_required_params
     response = @orb.coupons.create(
-      discount: {"discount_type" => "percentage", "percentage_discount" => 0},
+      discount: {discount_type: :percentage, percentage_discount: 0},
       redemption_code: "HALFOFF"
     )
 
diff --git a/test/orb/resources/credit_notes_test.rb b/test/orb/resources/credit_notes_test.rb
@@ -14,8 +14,8 @@ def test_create_required_params
     response = @orb.credit_notes.create(
       line_items: [
         {
-          "amount" => "amount",
-          "invoice_line_item_id" => "4khy3nwzktxv7"
+          amount: "amount",
+          invoice_line_item_id: "4khy3nwzktxv7"
         }
       ]
     )
diff --git a/test/orb/resources/customers/balance_transactions_test.rb b/test/orb/resources/customers/balance_transactions_test.rb
@@ -11,7 +11,7 @@ def before_all
   end
 
   def test_create_required_params
-    response = @orb.customers.balance_transactions.create("customer_id", amount: "amount", type: "increment")
+    response = @orb.customers.balance_transactions.create("customer_id", amount: "amount", type: :increment)
 
     assert_pattern do
       response => Orb::Models::Customers::BalanceTransactionCreateResponse
diff --git a/test/orb/resources/customers/credits/ledger_test.rb b/test/orb/resources/customers/credits/ledger_test.rb
@@ -26,7 +26,7 @@ def test_list
   def test_create_entry_required_params
     response = @orb.customers.credits.ledger.create_entry(
       "customer_id",
-      entry_type: "expiration_change",
+      entry_type: :expiration_change,
       expiry_date: "2019-12-27T18:11:19.117Z",
       target_expiry_date: "2019-12-27"
     )
@@ -39,7 +39,7 @@ def test_create_entry_required_params
   def test_create_entry_by_external_id_required_params
     response = @orb.customers.credits.ledger.create_entry_by_external_id(
       "external_customer_id",
-      entry_type: "expiration_change",
+      entry_type: :expiration_change,
       expiry_date: "2019-12-27T18:11:19.117Z",
       target_expiry_date: "2019-12-27"
     )
diff --git a/test/orb/resources/customers/credits/top_ups_test.rb b/test/orb/resources/customers/credits/top_ups_test.rb
@@ -15,7 +15,7 @@ def test_create_required_params
       "customer_id",
       amount: "amount",
       currency: "currency",
-      invoice_settings: {"auto_collection" => true, "net_terms" => 0},
+      invoice_settings: {auto_collection: true, net_terms: 0},
       per_unit_cost_basis: "per_unit_cost_basis",
       threshold: "threshold"
     )
@@ -51,7 +51,7 @@ def test_create_by_external_id_required_params
       "external_customer_id",
       amount: "amount",
       currency: "currency",
-      invoice_settings: {"auto_collection" => true, "net_terms" => 0},
+      invoice_settings: {auto_collection: true, net_terms: 0},
       per_unit_cost_basis: "per_unit_cost_basis",
       threshold: "threshold"
     )
diff --git a/test/orb/resources/events_test.rb b/test/orb/resources/events_test.rb
@@ -35,10 +35,10 @@ def test_ingest_required_params
     response = @orb.events.ingest(
       events: [
         {
-          "event_name" => "event_name",
-          "idempotency_key" => "idempotency_key",
-          "properties" => {},
-          "timestamp" => "2020-12-09T16:09:53Z"
+          event_name: "event_name",
+          idempotency_key: "idempotency_key",
+          properties: {},
+          timestamp: "2020-12-09T16:09:53Z"
         }
       ]
     )
diff --git a/test/orb/resources/invoices_test.rb b/test/orb/resources/invoices_test.rb
@@ -16,13 +16,13 @@ def test_create_required_params
       invoice_date: "2019-12-27T18:11:19.117Z",
       line_items: [
         {
-          "end_date" => "2023-09-22",
-          "item_id" => "4khy3nwzktxv7",
-          "model_type" => "unit",
-          "name" => "Line Item Name",
-          "quantity" => 1,
-          "start_date" => "2023-09-22",
-          "unit_config" => {"unit_amount" => "unit_amount"}
+          end_date: "2023-09-22",
+          item_id: "4khy3nwzktxv7",
+          model_type: :unit,
+          name: "Line Item Name",
+          quantity: 1,
+          start_date: "2023-09-22",
+          unit_config: {unit_amount: "unit_amount"}
         }
       ],
       net_terms: 0
diff --git a/test/orb/resources/plans_test.rb b/test/orb/resources/plans_test.rb
@@ -16,11 +16,11 @@ def test_create_required_params
       name: "name",
       prices: [
         {
-          "cadence" => "annual",
-          "item_id" => "item_id",
-          "model_type" => "unit",
-          "name" => "Annual fee",
-          "unit_config" => {"unit_amount" => "unit_amount"}
+          cadence: :annual,
+          item_id: "item_id",
+          model_type: :unit,
+          name: "Annual fee",
+          unit_config: {unit_amount: "unit_amount"}
         }
       ]
     )
diff --git a/test/orb/resources/prices_test.rb b/test/orb/resources/prices_test.rb
@@ -12,12 +12,12 @@ def before_all
 
   def test_create_required_params
     response = @orb.prices.create(
-      cadence: "annual",
+      cadence: :annual,
       currency: "currency",
       item_id: "item_id",
-      model_type: "unit",
+      model_type: :unit,
       name: "Annual fee",
-      unit_config: {"unit_amount" => "unit_amount"}
+      unit_config: {unit_amount: "unit_amount"}
     )
 
     assert_pattern do
diff --git a/test/orb/resources/subscriptions_test.rb b/test/orb/resources/subscriptions_test.rb
@@ -40,7 +40,7 @@ def test_list
   end
 
   def test_cancel_required_params
-    response = @orb.subscriptions.cancel("subscription_id", cancel_option: "end_of_subscription_term")
+    response = @orb.subscriptions.cancel("subscription_id", cancel_option: :end_of_subscription_term)
 
     assert_pattern do
       response => Orb::Models::SubscriptionCancelResponse
@@ -97,7 +97,7 @@ def test_price_intervals
   end
 
   def test_schedule_plan_change_required_params
-    response = @orb.subscriptions.schedule_plan_change("subscription_id", change_option: "requested_date")
+    response = @orb.subscriptions.schedule_plan_change("subscription_id", change_option: :requested_date)
 
     assert_pattern do
       response => Orb::Models::SubscriptionSchedulePlanChangeResponse

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ def before_all`
`12`	`12`
`13`	`13`	`def test_create_required_params`
`14`	`14`	`response = @orb.coupons.create(`
`15`		`- discount: {"discount_type" => "percentage", "percentage_discount" => 0},`
	`15`	`+ discount: {discount_type: :percentage, percentage_discount: 0},`
`16`	`16`	`redemption_code: "HALFOFF"`
`17`	`17`	`)`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,8 @@ def test_create_required_params`
`14`	`14`	`response = @orb.credit_notes.create(`
`15`	`15`	`line_items: [`
`16`	`16`	`{`
`17`		`- "amount" => "amount",`
`18`		`- "invoice_line_item_id" => "4khy3nwzktxv7"`
	`17`	`+ amount: "amount",`
	`18`	`+ invoice_line_item_id: "4khy3nwzktxv7"`
`19`	`19`	`}`
`20`	`20`	`]`
`21`	`21`	`)`
Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,10 @@ def test_ingest_required_params`
`35`	`35`	`response = @orb.events.ingest(`
`36`	`36`	`events: [`
`37`	`37`	`{`
`38`		`- "event_name" => "event_name",`
`39`		`- "idempotency_key" => "idempotency_key",`
`40`		`- "properties" => {},`
`41`		`- "timestamp" => "2020-12-09T16:09:53Z"`
	`38`	`+ event_name: "event_name",`
	`39`	`+ idempotency_key: "idempotency_key",`
	`40`	`+ properties: {},`
	`41`	`+ timestamp: "2020-12-09T16:09:53Z"`
`42`	`42`	`}`
`43`	`43`	`]`
`44`	`44`	`)`
Original file line number	Diff line number	Diff line change
`@@ -16,11 +16,11 @@ def test_create_required_params`
`16`	`16`	`name: "name",`
`17`	`17`	`prices: [`
`18`	`18`	`{`
`19`		`- "cadence" => "annual",`
`20`		`- "item_id" => "item_id",`
`21`		`- "model_type" => "unit",`
`22`		`- "name" => "Annual fee",`
`23`		`- "unit_config" => {"unit_amount" => "unit_amount"}`
	`19`	`+ cadence: :annual,`
	`20`	`+ item_id: "item_id",`
	`21`	`+ model_type: :unit,`
	`22`	`+ name: "Annual fee",`
	`23`	`+ unit_config: {unit_amount: "unit_amount"}`
`24`	`24`	`}`
`25`	`25`	`]`
`26`	`26`	`)`