recurly 4.37.0 → 4.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9706f4db91fa66e91071dfd51171b9933576b04f081c161715bcee8a2457a95
-  data.tar.gz: 85ba2a6dcc9c774c64c51a9c4ca088d473da7c9d5dae0926fa52f7fcd10ec0a1
+  metadata.gz: aa823beffdec114f5d986cfb91ec4bb6a5cba19405c8cfaca99ad2e86afce539
+  data.tar.gz: 210e3425783dce9f8fcb61e214e565341fe8baad3838010f40bce46cff32946a
 SHA512:
-  metadata.gz: 8e609da5b5ae899f5bd0d2ac5b4651c4981d84b605b58dd1b9fab32223328d1a487c4583f2ca580806f345e269aaf5cb6a8235d7b4aa911254d321d8d34cc97a
-  data.tar.gz: 218ac1808c50575ec60157116ed1f12d51de64a3b1159a249399a85f34f9b5b1daa72dec3f37b54cc4f0401078169bfc855e4f28c5a02e9277a96f10f6d065d2
+  metadata.gz: 65e58303ed5ed372250923908976d6be83697160dab1b45d499d6ef1a876d07f4b129faccf6ecb26005c1c0e18c08d80e5e16d5288731f9f600b2c3ceabaf72a
+  data.tar.gz: 810071a34225cbb1598730a1ff16b2cf8fad9a64bd6fc3c13a09dc3c23a496f5b788daffcb06eca9da0e380ae38eef589a0cf17c5315b1227e5199cb543c90d2

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.37.0
+current_version = 4.38.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [4.38.0](https://github.com/recurly/recurly-client-ruby/tree/4.38.0) (2023-06-01)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.37.0...4.38.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Multiple Business Entities) [#850](https://github.com/recurly/recurly-client-ruby/pull/850) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.37.0](https://github.com/recurly/recurly-client-ruby/tree/4.37.0) (2023-05-24)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.36.0...4.37.0)

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 4.37'
+gem 'recurly', '~> 4.38'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client/operations.rb

@@ -4470,6 +4470,33 @@ module Recurly
       pager(path, **options)
     end
 
+    # Fetch a business entity
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_business_entity get_business_entity api documentation}
+    #
+    # @param business_entity_id [String] Business Entity ID. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-entity1+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::BusinessEntity] Business entity details
+    #
+    def get_business_entity(business_entity_id:, **options)
+      path = interpolate_path("/business_entities/{business_entity_id}", business_entity_id: business_entity_id)
+      get(path, **options)
+    end
+
+    # List business entities
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_business_entities list_business_entities api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Pager<Resources::BusinessEntity>] List of all business entities on your site.
+    #
+    def list_business_entities(**options)
+      path = "/business_entities"
+      pager(path, **options)
+    end
+
     # List gift cards
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_gift_cards list_gift_cards api documentation}
@@ -4539,5 +4566,49 @@ module Recurly
       path = interpolate_path("/gift_cards/{redemption_code}/redeem", redemption_code: redemption_code)
       post(path, body, Requests::GiftCardRedeem, **options)
     end
+
+    # List a business entity's invoices
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_business_entity_invoices list_business_entity_invoices api documentation}
+    #
+    # @param business_entity_id [String] Business Entity ID. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-entity1+.
+    # @param params [Hash] Optional query string parameters:
+    #        :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
+    #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+    #
+    #   *Important notes:*
+    #
+    #   * The +ids+ parameter cannot be used with any other ordering or filtering
+    #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+    #   * Invalid or unknown IDs will be ignored, so you should check that the
+    #     results correspond to your request.
+    #   * Records are returned in an arbitrary order. Since results are all
+    #     returned at once you can sort the records yourself.
+    #
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    #   order. In descending order updated records will move behind the cursor and could
+    #   prevent some records from being returned.
+    #
+    #        :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+    #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+    #
+    #        :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+    #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+    #
+    #        :type [String] Filter by type when:
+    #   - +type=charge+, only charge invoices will be returned.
+    #   - +type=credit+, only credit invoices will be returned.
+    #   - +type=non-legacy+, only charge and credit invoices will be returned.
+    #   - +type=legacy+, only legacy invoices will be returned.
+    #
+    #
+    # @return [Pager<Resources::Invoice>] A list of the business entity's invoices.
+    #
+    def list_business_entity_invoices(business_entity_id:, **options)
+      path = interpolate_path("/business_entities/{business_entity_id}/invoices", business_entity_id: business_entity_id)
+      pager(path, **options)
+    end
   end
 end

data/lib/recurly/requests/account_create.rb

@@ -66,6 +66,10 @@ module Recurly
       #   @return [String]
       define_attribute :last_name, String
 
+      # @!attribute override_business_entity_id
+      #   @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
+      define_attribute :override_business_entity_id, String
+
       # @!attribute parent_account_code
       #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
       define_attribute :parent_account_code, String

data/lib/recurly/requests/account_purchase.rb

@@ -66,6 +66,10 @@ module Recurly
       #   @return [String]
       define_attribute :last_name, String
 
+      # @!attribute override_business_entity_id
+      #   @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
+      define_attribute :override_business_entity_id, String
+
       # @!attribute parent_account_code
       #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
       define_attribute :parent_account_code, String

data/lib/recurly/requests/account_update.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [String]
       define_attribute :last_name, String
 
+      # @!attribute override_business_entity_id
+      #   @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
+      define_attribute :override_business_entity_id, String
+
       # @!attribute parent_account_code
       #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
       define_attribute :parent_account_code, String

data/lib/recurly/resources/account.rb

@@ -106,6 +106,10 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!attribute override_business_entity_id
+      #   @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
+      define_attribute :override_business_entity_id, String
+
       # @!attribute parent_account_id
       #   @return [String] The UUID of the parent account associated with this account.
       define_attribute :parent_account_id, String

data/lib/recurly/resources/business_entity.rb

@@ -0,0 +1,54 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class BusinessEntity < Resource
+
+      # @!attribute code
+      #   @return [String] The entity code of the business entity.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute default_registration_number
+      #   @return [String] Registration number for the customer used on the invoice.
+      define_attribute :default_registration_number, String
+
+      # @!attribute default_vat_number
+      #   @return [String] VAT number for the customer used on the invoice.
+      define_attribute :default_vat_number, String
+
+      # @!attribute id
+      #   @return [String] Business entity ID
+      define_attribute :id, String
+
+      # @!attribute invoice_display_address
+      #   @return [Address] Address information for the business entity that will appear on the invoice.
+      define_attribute :invoice_display_address, :Address
+
+      # @!attribute name
+      #   @return [String] This name describes your business entity and will appear on the invoice.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute subscriber_location_countries
+      #   @return [Array[String]] List of countries for which the business entity will be used.
+      define_attribute :subscriber_location_countries, Array, { :item_type => String }
+
+      # @!attribute tax_address
+      #   @return [Address] Address information for the business entity that will be used for calculating taxes.
+      define_attribute :tax_address, :Address
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/invoice.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
       define_attribute :billing_info_id, String
 
+      # @!attribute business_entity_id
+      #   @return [String] Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled.
+      define_attribute :business_entity_id, String
+
       # @!attribute closed_at
       #   @return [DateTime] Date invoice was marked paid or failed.
       define_attribute :closed_at, DateTime

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.37.0"
+  VERSION = "4.38.0"
 end

data/openapi/api.yaml

@@ -228,6 +228,7 @@ x-tagGroups:
   - custom_field_definition
   - shipping_method
   - dunning_campaigns
+  - business_entities
 tags:
 - name: site
   x-displayName: Site
@@ -374,6 +375,10 @@ tags:
   description: An account from an external resource that is not managed by the Recurly
     platform and instead is managed by third-party platforms like Apple App Store
     and Google Play Store.
+- name: business_entities
+  x-displayName: Business Entities
+  description: Describes the business address that will be used for invoices and taxes
+    depending on settings and subscriber location.
 paths:
   "/sites":
     get:
@@ -15974,6 +15979,60 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/business_entities/{business_entity_id}":
+    parameters:
+    - "$ref": "#/components/parameters/business_entity_id"
+    get:
+      tags:
+      - business_entities
+      operationId: get_business_entity
+      summary: Fetch a business entity
+      responses:
+        '200':
+          description: Business entity details
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/BusinessEntity"
+        '404':
+          description: Incorrect site or business entity ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/business_entities":
+    get:
+      tags:
+      - business_entities
+      operationId: list_business_entities
+      summary: List business entities
+      responses:
+        '200':
+          description: List of all business entities on your site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/BusinessEntityList"
+        '404':
+          description: Incorrect site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/gift_cards":
     get:
       tags:
@@ -16143,6 +16202,49 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/business_entities/{business_entity_id}/invoices":
+    get:
+      tags:
+      - invoice
+      operationId: list_business_entity_invoices
+      summary: List a business entity's invoices
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/business_entity_id"
+      - "$ref": "#/components/parameters/ids"
+      - "$ref": "#/components/parameters/limit"
+      - "$ref": "#/components/parameters/order"
+      - "$ref": "#/components/parameters/sort_dates"
+      - "$ref": "#/components/parameters/filter_begin_time"
+      - "$ref": "#/components/parameters/filter_end_time"
+      - "$ref": "#/components/parameters/filter_invoice_type"
+      responses:
+        '200':
+          description: A list of the business entity's invoices.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/InvoiceList"
+        '400':
+          description: Invalid or unpermitted parameter.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site or business entity ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
 servers:
 - url: https://v3.recurly.com
 - url: https://v3.eu.recurly.com
@@ -16180,6 +16282,14 @@ components:
       required: true
       schema:
         type: string
+    business_entity_id:
+      name: business_entity_id
+      in: path
+      description: Business Entity ID. For ID no prefix is used e.g. `e28zov4fw0v2`.
+        For code use prefix `code-`, e.g. `code-entity1`.
+      required: true
+      schema:
+        type: string
     usage_id:
       name: usage_id
       in: path
@@ -17101,6 +17211,11 @@ components:
             merchant has an integration for the Vertex tax provider, this optional
             value will be sent in any tax calculation requests for the account.
           maxLength: 30
+        override_business_entity_id:
+          type: string
+          title: Override Business Entity ID
+          description: Unique ID to identify the business entity assigned to the account.
+            Available when the `Multiple Business Entities` feature is enabled.
         parent_account_code:
           type: string
           maxLength: 50
@@ -17169,6 +17284,11 @@ components:
             The customer will also use this email address to log into your hosted
             account management pages. This value does not need to be unique.
           maxLength: 255
+        override_business_entity_id:
+          type: string
+          title: Override Business Entity ID
+          description: Unique ID to identify the business entity assigned to the account.
+            Available when the `Multiple Business Entities` feature is enabled.
         preferred_locale:
           description: Used to determine the language and locale of emails sent on
             behalf of the merchant to the customer.
@@ -19358,6 +19478,11 @@ components:
           type: boolean
           title: Final Dunning Event
           description: Last communication attempt.
+        business_entity_id:
+          type: string
+          title: Business Entity ID
+          description: Unique ID to identify the business entity assigned to the invoice.
+            Available when the `Multiple Business Entities` feature is enabled.
     InvoiceCreate:
       type: object
       properties:
@@ -23939,6 +24064,84 @@ components:
           type: string
           description: Username of the associated payment method. Currently only associated
             with Venmo.
+    BusinessEntityList:
+      type: object
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be List.
+        has_more:
+          type: boolean
+          description: Indicates there are more results on subsequent pages.
+        next:
+          type: string
+          description: Path to subsequent page of results.
+        data:
+          type: array
+          items:
+            "$ref": "#/components/schemas/BusinessEntity"
+    BusinessEntity:
+      type: object
+      description: Business entity details
+      properties:
+        id:
+          title: Business entity ID
+          type: string
+          maxLength: 13
+          readOnly: true
+        object:
+          title: Object type
+          type: string
+          readOnly: true
+        code:
+          title: Business entity code
+          type: string
+          maxLength: 50
+          description: The entity code of the business entity.
+        name:
+          type: string
+          title: Name
+          description: This name describes your business entity and will appear on
+            the invoice.
+          maxLength: 255
+        invoice_display_address:
+          title: Invoice display address
+          description: Address information for the business entity that will appear
+            on the invoice.
+          "$ref": "#/components/schemas/Address"
+        tax_address:
+          title: Tax address
+          description: Address information for the business entity that will be used
+            for calculating taxes.
+          "$ref": "#/components/schemas/Address"
+        default_vat_number:
+          type: string
+          title: Default VAT number
+          description: VAT number for the customer used on the invoice.
+          maxLength: 20
+        default_registration_number:
+          type: string
+          title: Default registration number
+          description: Registration number for the customer used on the invoice.
+          maxLength: 30
+        subscriber_location_countries:
+          type: array
+          title: Subscriber location countries
+          description: List of countries for which the business entity will be used.
+          items:
+            type: string
+            title: Country code
+        created_at:
+          type: string
+          format: date-time
+          title: Created at
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          title: Last updated at
+          readOnly: true
     GiftCardList:
       type: object
       properties:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.37.0
+  version: 4.38.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -241,6 +241,7 @@ files:
 - lib/recurly/resources/billing_info.rb
 - lib/recurly/resources/billing_info_updated_by.rb
 - lib/recurly/resources/binary_file.rb
+- lib/recurly/resources/business_entity.rb
 - lib/recurly/resources/coupon.rb
 - lib/recurly/resources/coupon_discount.rb
 - lib/recurly/resources/coupon_discount_pricing.rb
@@ -343,7 +344,7 @@ metadata:
   changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
   documentation_uri: https://recurly.github.io/recurly-client-ruby/
   homepage_uri: https://github.com/recurly/recurly-client-ruby
-  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.37.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.38.0
 post_install_message: 
 rdoc_options: []
 require_paths: