diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 6538ca91..6d78745c 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.8.0" + ".": "0.9.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 605226f0..8d440bd0 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 114 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-6d2a5b5d2cfb485e1a548aa15e1e36844e1f14f42553033822e1c570c8aa0825.yml -openapi_spec_hash: 0266a5aaced5e768bcf6a70924d69799 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-faced218bf2dee89c8449bdb209e7090452d26c0646f0b998f84fe5bd3c4b7cb.yml +openapi_spec_hash: b3a957e9c012fad5093545f65614ea42 config_hash: e63f2d098e5d12f63ae4cd8270aa5c3c diff --git a/CHANGELOG.md b/CHANGELOG.md index a296820f..abaf1677 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## 0.9.0 (2025-05-30) + +Full Changelog: [v0.8.0...v0.9.0](https://github.com/orbcorp/orb-ruby/compare/v0.8.0...v0.9.0) + +### Features + +* **api:** api update ([4c07dd1](https://github.com/orbcorp/orb-ruby/commit/4c07dd113926af678db91561fc501d17fa4da86e)) + + +### Chores + +* **internal:** version bump ([c9592f1](https://github.com/orbcorp/orb-ruby/commit/c9592f19f8f618117d4a5503a507d06b8abf7ac2)) + ## 0.8.0 (2025-05-29) Full Changelog: [v0.7.0...v0.8.0](https://github.com/orbcorp/orb-ruby/compare/v0.7.0...v0.8.0) diff --git a/Gemfile.lock b/Gemfile.lock index 6248467a..da19d776 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - orb-billing (0.7.0) + orb-billing (0.8.0) connection_pool GEM diff --git a/README.md b/README.md index 6a60554a..0e6598e0 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "orb-billing", "~> 0.8.0" +gem "orb-billing", "~> 0.9.0" ``` diff --git a/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb b/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb index 17431b8a..f909d63b 100644 --- a/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb @@ -112,8 +112,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel optional :memo, String, nil?: true # @!attribute require_successful_payment - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -131,7 +133,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # # @param memo [String, nil] An optional memo to display on the invoice. # - # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond end # The unit of expires_after. diff --git a/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb b/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb index 5fbcee8a..7ee593fc 100644 --- a/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb @@ -104,8 +104,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel optional :memo, String, nil?: true # @!attribute require_successful_payment - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -123,7 +125,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # # @param memo [String, nil] An optional memo to display on the invoice. # - # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond end # The unit of expires_after. diff --git a/lib/orb/models/customers/credits/top_up_create_params.rb b/lib/orb/models/customers/credits/top_up_create_params.rb index 3bc60ee6..f9bd8783 100644 --- a/lib/orb/models/customers/credits/top_up_create_params.rb +++ b/lib/orb/models/customers/credits/top_up_create_params.rb @@ -108,8 +108,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel optional :memo, String, nil?: true # @!attribute require_successful_payment - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -127,7 +129,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # # @param memo [String, nil] An optional memo to display on the invoice. # - # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond end # The unit of expires_after. diff --git a/lib/orb/models/customers/credits/top_up_create_response.rb b/lib/orb/models/customers/credits/top_up_create_response.rb index c22eee14..ae47776d 100644 --- a/lib/orb/models/customers/credits/top_up_create_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_response.rb @@ -102,8 +102,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel optional :memo, String, nil?: true # @!attribute require_successful_payment - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -121,7 +123,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # # @param memo [String, nil] An optional memo to display on the invoice. # - # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond end # The unit of expires_after. diff --git a/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb b/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb index e48ec058..6efce0ca 100644 --- a/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb @@ -104,8 +104,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel optional :memo, String, nil?: true # @!attribute require_successful_payment - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -123,7 +125,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # # @param memo [String, nil] An optional memo to display on the invoice. # - # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond end # The unit of expires_after. diff --git a/lib/orb/models/customers/credits/top_up_list_response.rb b/lib/orb/models/customers/credits/top_up_list_response.rb index 1f91864f..684eef88 100644 --- a/lib/orb/models/customers/credits/top_up_list_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_response.rb @@ -102,8 +102,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel optional :memo, String, nil?: true # @!attribute require_successful_payment - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -121,7 +123,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # # @param memo [String, nil] An optional memo to display on the invoice. # - # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond end # The unit of expires_after. diff --git a/lib/orb/models/event_ingest_params.rb b/lib/orb/models/event_ingest_params.rb index 2f3af9e7..7d7ef7b9 100644 --- a/lib/orb/models/event_ingest_params.rb +++ b/lib/orb/models/event_ingest_params.rb @@ -56,8 +56,8 @@ class Event < Orb::Internal::Type::BaseModel # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. # - # @return [Object] - required :properties, Orb::Internal::Type::Unknown + # @return [Hash{Symbol=>Object}] + required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown] # @!attribute timestamp # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -88,7 +88,7 @@ class Event < Orb::Internal::Type::BaseModel # # @param idempotency_key [String] A unique value, generated by the client, that is used to de-duplicate events. Ex # - # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo # # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen # diff --git a/lib/orb/models/event_search_response.rb b/lib/orb/models/event_search_response.rb index 38e5f6ed..4e736c50 100644 --- a/lib/orb/models/event_search_response.rb +++ b/lib/orb/models/event_search_response.rb @@ -50,8 +50,8 @@ class Data < Orb::Internal::Type::BaseModel # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. # - # @return [Object] - required :properties, Orb::Internal::Type::Unknown + # @return [Hash{Symbol=>Object}] + required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown] # @!attribute timestamp # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -79,7 +79,7 @@ class Data < Orb::Internal::Type::BaseModel # # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust # - # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo # # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen end diff --git a/lib/orb/models/event_update_params.rb b/lib/orb/models/event_update_params.rb index 9544e476..247d2af9 100644 --- a/lib/orb/models/event_update_params.rb +++ b/lib/orb/models/event_update_params.rb @@ -17,8 +17,8 @@ class EventUpdateParams < Orb::Internal::Type::BaseModel # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. # - # @return [Object] - required :properties, Orb::Internal::Type::Unknown + # @return [Hash{Symbol=>Object}] + required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown] # @!attribute timestamp # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -47,7 +47,7 @@ class EventUpdateParams < Orb::Internal::Type::BaseModel # # @param event_name [String] A name to meaningfully identify the action or event type. # - # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo # # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen # diff --git a/lib/orb/models/price_evaluate_multiple_params.rb b/lib/orb/models/price_evaluate_multiple_params.rb index 0ab2e469..955d4bcb 100644 --- a/lib/orb/models/price_evaluate_multiple_params.rb +++ b/lib/orb/models/price_evaluate_multiple_params.rb @@ -74,8 +74,8 @@ class Event < Orb::Internal::Type::BaseModel # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. # - # @return [Object] - required :properties, Orb::Internal::Type::Unknown + # @return [Hash{Symbol=>Object}] + required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown] # @!attribute timestamp # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -104,7 +104,7 @@ class Event < Orb::Internal::Type::BaseModel # # @param event_name [String] A name to meaningfully identify the action or event type. # - # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo # # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen # diff --git a/lib/orb/resources/events.rb b/lib/orb/resources/events.rb index c2207960..6944fa48 100644 --- a/lib/orb/resources/events.rb +++ b/lib/orb/resources/events.rb @@ -64,7 +64,7 @@ class Events # # @param event_name [String] A name to meaningfully identify the action or event type. # - # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo # # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen # diff --git a/lib/orb/version.rb b/lib/orb/version.rb index 154ca8ec..029dbc17 100644 --- a/lib/orb/version.rb +++ b/lib/orb/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Orb - VERSION = "0.8.0" + VERSION = "0.9.0" end diff --git a/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi b/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi index 753704bd..254651b5 100644 --- a/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +++ b/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi @@ -158,8 +158,10 @@ module Orb sig { returns(T.nilable(String)) } attr_accessor :memo - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -185,8 +187,10 @@ module Orb net_terms:, # An optional memo to display on the invoice. memo: nil, - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. require_successful_payment: nil ) end diff --git a/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi b/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi index 9594b293..afda906b 100644 --- a/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +++ b/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi @@ -148,8 +148,10 @@ module Orb sig { returns(T.nilable(String)) } attr_accessor :memo - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -175,8 +177,10 @@ module Orb net_terms:, # An optional memo to display on the invoice. memo: nil, - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. require_successful_payment: nil ) end diff --git a/rbi/orb/models/customers/credits/top_up_create_params.rbi b/rbi/orb/models/customers/credits/top_up_create_params.rbi index 7ad875c5..60b781c9 100644 --- a/rbi/orb/models/customers/credits/top_up_create_params.rbi +++ b/rbi/orb/models/customers/credits/top_up_create_params.rbi @@ -156,8 +156,10 @@ module Orb sig { returns(T.nilable(String)) } attr_accessor :memo - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -183,8 +185,10 @@ module Orb net_terms:, # An optional memo to display on the invoice. memo: nil, - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. require_successful_payment: nil ) end diff --git a/rbi/orb/models/customers/credits/top_up_create_response.rbi b/rbi/orb/models/customers/credits/top_up_create_response.rbi index 0892687a..1f161caa 100644 --- a/rbi/orb/models/customers/credits/top_up_create_response.rbi +++ b/rbi/orb/models/customers/credits/top_up_create_response.rbi @@ -148,8 +148,10 @@ module Orb sig { returns(T.nilable(String)) } attr_accessor :memo - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -175,8 +177,10 @@ module Orb net_terms:, # An optional memo to display on the invoice. memo: nil, - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. require_successful_payment: nil ) end diff --git a/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi b/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi index 200ebf13..a546e2e3 100644 --- a/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +++ b/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi @@ -148,8 +148,10 @@ module Orb sig { returns(T.nilable(String)) } attr_accessor :memo - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -175,8 +177,10 @@ module Orb net_terms:, # An optional memo to display on the invoice. memo: nil, - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. require_successful_payment: nil ) end diff --git a/rbi/orb/models/customers/credits/top_up_list_response.rbi b/rbi/orb/models/customers/credits/top_up_list_response.rbi index 6494d0ad..9aee538d 100644 --- a/rbi/orb/models/customers/credits/top_up_list_response.rbi +++ b/rbi/orb/models/customers/credits/top_up_list_response.rbi @@ -148,8 +148,10 @@ module Orb sig { returns(T.nilable(String)) } attr_accessor :memo - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -175,8 +177,10 @@ module Orb net_terms:, # An optional memo to display on the invoice. memo: nil, - # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # When true, credit blocks created by this top-up will require that the + # corresponding invoice is paid before they are drawn down from. If any topup + # block is pending payment, further automatic top-ups will be paused until the + # invoice is paid or voided. require_successful_payment: nil ) end diff --git a/rbi/orb/models/event_ingest_params.rbi b/rbi/orb/models/event_ingest_params.rbi index dbae7501..8df06e6d 100644 --- a/rbi/orb/models/event_ingest_params.rbi +++ b/rbi/orb/models/event_ingest_params.rbi @@ -74,7 +74,7 @@ module Orb # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. - sig { returns(T.anything) } + sig { returns(T::Hash[Symbol, T.anything]) } attr_accessor :properties # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -96,7 +96,7 @@ module Orb params( event_name: String, idempotency_key: String, - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time, customer_id: T.nilable(String), external_customer_id: T.nilable(String) @@ -129,7 +129,7 @@ module Orb { event_name: String, idempotency_key: String, - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time, customer_id: T.nilable(String), external_customer_id: T.nilable(String) diff --git a/rbi/orb/models/event_search_response.rbi b/rbi/orb/models/event_search_response.rbi index 0fa4bb69..ce74c3ed 100644 --- a/rbi/orb/models/event_search_response.rbi +++ b/rbi/orb/models/event_search_response.rbi @@ -61,7 +61,7 @@ module Orb # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. - sig { returns(T.anything) } + sig { returns(T::Hash[Symbol, T.anything]) } attr_accessor :properties # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -80,7 +80,7 @@ module Orb deprecated: T::Boolean, event_name: String, external_customer_id: T.nilable(String), - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time ).returns(T.attached_class) end @@ -116,7 +116,7 @@ module Orb deprecated: T::Boolean, event_name: String, external_customer_id: T.nilable(String), - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time } ) diff --git a/rbi/orb/models/event_update_params.rbi b/rbi/orb/models/event_update_params.rbi index 403fdd94..ad0ff639 100644 --- a/rbi/orb/models/event_update_params.rbi +++ b/rbi/orb/models/event_update_params.rbi @@ -15,7 +15,7 @@ module Orb # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. - sig { returns(T.anything) } + sig { returns(T::Hash[Symbol, T.anything]) } attr_accessor :properties # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -36,7 +36,7 @@ module Orb sig do params( event_name: String, - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time, customer_id: T.nilable(String), external_customer_id: T.nilable(String), @@ -66,7 +66,7 @@ module Orb override.returns( { event_name: String, - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time, customer_id: T.nilable(String), external_customer_id: T.nilable(String), diff --git a/rbi/orb/models/price_evaluate_multiple_params.rbi b/rbi/orb/models/price_evaluate_multiple_params.rbi index 7cdcd019..7f19b9f3 100644 --- a/rbi/orb/models/price_evaluate_multiple_params.rbi +++ b/rbi/orb/models/price_evaluate_multiple_params.rbi @@ -114,7 +114,7 @@ module Orb # A dictionary of custom properties. Values in this dictionary must be numeric, # boolean, or strings. Nested dictionaries are disallowed. - sig { returns(T.anything) } + sig { returns(T::Hash[Symbol, T.anything]) } attr_accessor :properties # An ISO 8601 format date with no timezone offset (i.e. UTC). This should @@ -135,7 +135,7 @@ module Orb sig do params( event_name: String, - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time, customer_id: T.nilable(String), external_customer_id: T.nilable(String) @@ -163,7 +163,7 @@ module Orb override.returns( { event_name: String, - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time, customer_id: T.nilable(String), external_customer_id: T.nilable(String) diff --git a/rbi/orb/resources/events.rbi b/rbi/orb/resources/events.rbi index b87f4d31..c158f0e9 100644 --- a/rbi/orb/resources/events.rbi +++ b/rbi/orb/resources/events.rbi @@ -58,7 +58,7 @@ module Orb params( event_id: String, event_name: String, - properties: T.anything, + properties: T::Hash[Symbol, T.anything], timestamp: Time, customer_id: T.nilable(String), external_customer_id: T.nilable(String), diff --git a/sig/orb/models/event_ingest_params.rbs b/sig/orb/models/event_ingest_params.rbs index 6ac5b4ec..2fee629b 100644 --- a/sig/orb/models/event_ingest_params.rbs +++ b/sig/orb/models/event_ingest_params.rbs @@ -38,7 +38,7 @@ module Orb { event_name: String, idempotency_key: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, customer_id: String?, external_customer_id: String? @@ -49,7 +49,7 @@ module Orb attr_accessor idempotency_key: String - attr_accessor properties: top + attr_accessor properties: ::Hash[Symbol, top] attr_accessor timestamp: Time @@ -60,7 +60,7 @@ module Orb def initialize: ( event_name: String, idempotency_key: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, ?customer_id: String?, ?external_customer_id: String? @@ -69,7 +69,7 @@ module Orb def to_hash: -> { event_name: String, idempotency_key: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, customer_id: String?, external_customer_id: String? diff --git a/sig/orb/models/event_search_response.rbs b/sig/orb/models/event_search_response.rbs index f159f268..32099e90 100644 --- a/sig/orb/models/event_search_response.rbs +++ b/sig/orb/models/event_search_response.rbs @@ -19,7 +19,7 @@ module Orb deprecated: bool, event_name: String, external_customer_id: String?, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time } @@ -34,7 +34,7 @@ module Orb attr_accessor external_customer_id: String? - attr_accessor properties: top + attr_accessor properties: ::Hash[Symbol, top] attr_accessor timestamp: Time @@ -44,7 +44,7 @@ module Orb deprecated: bool, event_name: String, external_customer_id: String?, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time ) -> void @@ -54,7 +54,7 @@ module Orb deprecated: bool, event_name: String, external_customer_id: String?, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time } end diff --git a/sig/orb/models/event_update_params.rbs b/sig/orb/models/event_update_params.rbs index f52792aa..0a310156 100644 --- a/sig/orb/models/event_update_params.rbs +++ b/sig/orb/models/event_update_params.rbs @@ -3,7 +3,7 @@ module Orb type event_update_params = { event_name: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, customer_id: String?, external_customer_id: String? @@ -16,7 +16,7 @@ module Orb attr_accessor event_name: String - attr_accessor properties: top + attr_accessor properties: ::Hash[Symbol, top] attr_accessor timestamp: Time @@ -26,7 +26,7 @@ module Orb def initialize: ( event_name: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, ?customer_id: String?, ?external_customer_id: String?, @@ -35,7 +35,7 @@ module Orb def to_hash: -> { event_name: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, customer_id: String?, external_customer_id: String?, diff --git a/sig/orb/models/price_evaluate_multiple_params.rbs b/sig/orb/models/price_evaluate_multiple_params.rbs index ff49ff9d..79671659 100644 --- a/sig/orb/models/price_evaluate_multiple_params.rbs +++ b/sig/orb/models/price_evaluate_multiple_params.rbs @@ -54,7 +54,7 @@ module Orb type event = { event_name: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, customer_id: String?, external_customer_id: String? @@ -63,7 +63,7 @@ module Orb class Event < Orb::Internal::Type::BaseModel attr_accessor event_name: String - attr_accessor properties: top + attr_accessor properties: ::Hash[Symbol, top] attr_accessor timestamp: Time @@ -73,7 +73,7 @@ module Orb def initialize: ( event_name: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, ?customer_id: String?, ?external_customer_id: String? @@ -81,7 +81,7 @@ module Orb def to_hash: -> { event_name: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, customer_id: String?, external_customer_id: String? diff --git a/sig/orb/resources/events.rbs b/sig/orb/resources/events.rbs index b3edc209..03f2d3b1 100644 --- a/sig/orb/resources/events.rbs +++ b/sig/orb/resources/events.rbs @@ -8,7 +8,7 @@ module Orb def update: ( String event_id, event_name: String, - properties: top, + properties: ::Hash[Symbol, top], timestamp: Time, ?customer_id: String?, ?external_customer_id: String?, diff --git a/test/orb/resources/events_test.rb b/test/orb/resources/events_test.rb index c99bd075..d6c8ee52 100644 --- a/test/orb/resources/events_test.rb +++ b/test/orb/resources/events_test.rb @@ -8,7 +8,7 @@ def test_update_required_params @orb.events.update( "event_id", event_name: "event_name", - properties: {}, + properties: {foo: "bar"}, timestamp: "2020-12-09T16:09:53Z" ) @@ -44,7 +44,7 @@ def test_ingest_required_params { event_name: "event_name", idempotency_key: "idempotency_key", - properties: {}, + properties: {foo: "bar"}, timestamp: "2020-12-09T16:09:53Z" } ]