recurly 4.37.0 → 4.39.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d9706f4db91fa66e91071dfd51171b9933576b04f081c161715bcee8a2457a95
4
- data.tar.gz: 85ba2a6dcc9c774c64c51a9c4ca088d473da7c9d5dae0926fa52f7fcd10ec0a1
3
+ metadata.gz: 9834825d05fc3ef9111a875a8fae61f5938d458f8127974130b2655e9c8aeb06
4
+ data.tar.gz: f206903d330ff561a2acb319410148bcfcd3e5824811f0ef637ddc45d9ee2c8d
5
5
  SHA512:
6
- metadata.gz: 8e609da5b5ae899f5bd0d2ac5b4651c4981d84b605b58dd1b9fab32223328d1a487c4583f2ca580806f345e269aaf5cb6a8235d7b4aa911254d321d8d34cc97a
7
- data.tar.gz: 218ac1808c50575ec60157116ed1f12d51de64a3b1159a249399a85f34f9b5b1daa72dec3f37b54cc4f0401078169bfc855e4f28c5a02e9277a96f10f6d065d2
6
+ metadata.gz: d2ae09ec231a22717cc08f125a0e0c89d1092c7653d04a3ad37abbb66af61589a8ce2ff46a0584d1f749184a4303f2eecb1799e08227bf1f5220e781567ef5b0
7
+ data.tar.gz: 4af28009963ed13fb24367ef7485bb92372296861af6391fa2555da4e79df605234063041fb568ff6c61dc834e082706ca1534616ad7d5d5ce6ff2a8136d27b9
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 4.37.0
2
+ current_version = 4.39.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
@@ -0,0 +1,27 @@
1
+ name: PR Review
2
+
3
+ on:
4
+ pull_request:
5
+ types:
6
+ - opened
7
+ - repoened
8
+ - edited
9
+ - synchronize
10
+ - labeled
11
+ - unlabeled
12
+
13
+ concurrency:
14
+ group: ${{ github.workflow }} - ${{ github.ref }}
15
+ cancel-in-progress: true
16
+
17
+ jobs:
18
+ label-checker:
19
+ runs-on: ubuntu-latest
20
+ name: Label Checker
21
+ steps:
22
+ - name: Check Labels
23
+ uses: docker://agilepathway/pull-request-label-checker:latest
24
+ with:
25
+ one_of: V4
26
+ repo_token: ${{ secrets.GITHUB_TOKEN }}
27
+
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.39.0](https://github.com/recurly/recurly-client-ruby/tree/4.39.0) (2023-07-26)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.38.0...4.39.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2021-02-25 (App Management - External Subscriptions) [#859](https://github.com/recurly/recurly-client-ruby/pull/859) ([recurly-integrations](https://github.com/recurly-integrations))
11
+
12
+
13
+
14
+ ## [4.38.0](https://github.com/recurly/recurly-client-ruby/tree/4.38.0) (2023-06-01)
15
+
16
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.37.0...4.38.0)
17
+
18
+
19
+ **Merged Pull Requests**
20
+
21
+ - 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))
22
+
23
+
24
+
3
25
  ## [4.37.0](https://github.com/recurly/recurly-client-ruby/tree/4.37.0) (2023-05-24)
4
26
 
5
27
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.36.0...4.37.0)
@@ -149,6 +171,9 @@
149
171
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.23.0...4.24.0)
150
172
 
151
173
 
174
+ **Merged Pull Requests**
175
+
176
+ - Add Webhooks::verify_signature [#794](https://github.com/recurly/recurly-client-ruby/pull/794) ([jguidry-recurly](https://github.com/jguidry-recurly))
152
177
 
153
178
 
154
179
 
data/GETTING_STARTED.md CHANGED
@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
5
5
  In your Gemfile, add `recurly` as a dependency.
6
6
 
7
7
  ```ruby
8
- gem 'recurly', '~> 4.37'
8
+ gem 'recurly', '~> 4.39'
9
9
  ```
10
10
 
11
11
  > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
@@ -4470,6 +4470,33 @@ module Recurly
4470
4470
  pager(path, **options)
4471
4471
  end
4472
4472
 
4473
+ # Fetch a business entity
4474
+ #
4475
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_business_entity get_business_entity api documentation}
4476
+ #
4477
+ # @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+.
4478
+ # @param params [Hash] Optional query string parameters:
4479
+ #
4480
+ # @return [Resources::BusinessEntity] Business entity details
4481
+ #
4482
+ def get_business_entity(business_entity_id:, **options)
4483
+ path = interpolate_path("/business_entities/{business_entity_id}", business_entity_id: business_entity_id)
4484
+ get(path, **options)
4485
+ end
4486
+
4487
+ # List business entities
4488
+ #
4489
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_business_entities list_business_entities api documentation}
4490
+ #
4491
+ # @param params [Hash] Optional query string parameters:
4492
+ #
4493
+ # @return [Pager<Resources::BusinessEntity>] List of all business entities on your site.
4494
+ #
4495
+ def list_business_entities(**options)
4496
+ path = "/business_entities"
4497
+ pager(path, **options)
4498
+ end
4499
+
4473
4500
  # List gift cards
4474
4501
  #
4475
4502
  # {https://developers.recurly.com/api/v2021-02-25#operation/list_gift_cards list_gift_cards api documentation}
@@ -4539,5 +4566,49 @@ module Recurly
4539
4566
  path = interpolate_path("/gift_cards/{redemption_code}/redeem", redemption_code: redemption_code)
4540
4567
  post(path, body, Requests::GiftCardRedeem, **options)
4541
4568
  end
4569
+
4570
+ # List a business entity's invoices
4571
+ #
4572
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_business_entity_invoices list_business_entity_invoices api documentation}
4573
+ #
4574
+ # @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+.
4575
+ # @param params [Hash] Optional query string parameters:
4576
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
4577
+ # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
4578
+ #
4579
+ # *Important notes:*
4580
+ #
4581
+ # * The +ids+ parameter cannot be used with any other ordering or filtering
4582
+ # parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
4583
+ # * Invalid or unknown IDs will be ignored, so you should check that the
4584
+ # results correspond to your request.
4585
+ # * Records are returned in an arbitrary order. Since results are all
4586
+ # returned at once you can sort the records yourself.
4587
+ #
4588
+ # :limit [Integer] Limit number of records 1-200.
4589
+ # :order [String] Sort order.
4590
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
4591
+ # order. In descending order updated records will move behind the cursor and could
4592
+ # prevent some records from being returned.
4593
+ #
4594
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
4595
+ # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
4596
+ #
4597
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
4598
+ # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
4599
+ #
4600
+ # :type [String] Filter by type when:
4601
+ # - +type=charge+, only charge invoices will be returned.
4602
+ # - +type=credit+, only credit invoices will be returned.
4603
+ # - +type=non-legacy+, only charge and credit invoices will be returned.
4604
+ # - +type=legacy+, only legacy invoices will be returned.
4605
+ #
4606
+ #
4607
+ # @return [Pager<Resources::Invoice>] A list of the business entity's invoices.
4608
+ #
4609
+ def list_business_entity_invoices(business_entity_id:, **options)
4610
+ path = interpolate_path("/business_entities/{business_entity_id}/invoices", business_entity_id: business_entity_id)
4611
+ pager(path, **options)
4612
+ end
4542
4613
  end
4543
4614
  end
@@ -66,6 +66,10 @@ module Recurly
66
66
  # @return [String]
67
67
  define_attribute :last_name, String
68
68
 
69
+ # @!attribute override_business_entity_id
70
+ # @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
71
+ define_attribute :override_business_entity_id, String
72
+
69
73
  # @!attribute parent_account_code
70
74
  # @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.
71
75
  define_attribute :parent_account_code, String
@@ -66,6 +66,10 @@ module Recurly
66
66
  # @return [String]
67
67
  define_attribute :last_name, String
68
68
 
69
+ # @!attribute override_business_entity_id
70
+ # @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
71
+ define_attribute :override_business_entity_id, String
72
+
69
73
  # @!attribute parent_account_code
70
74
  # @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.
71
75
  define_attribute :parent_account_code, String
@@ -54,6 +54,10 @@ module Recurly
54
54
  # @return [String]
55
55
  define_attribute :last_name, String
56
56
 
57
+ # @!attribute override_business_entity_id
58
+ # @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
59
+ define_attribute :override_business_entity_id, String
60
+
57
61
  # @!attribute parent_account_code
58
62
  # @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.
59
63
  define_attribute :parent_account_code, String
@@ -106,6 +106,10 @@ module Recurly
106
106
  # @return [String] Object type
107
107
  define_attribute :object, String
108
108
 
109
+ # @!attribute override_business_entity_id
110
+ # @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
111
+ define_attribute :override_business_entity_id, String
112
+
109
113
  # @!attribute parent_account_id
110
114
  # @return [String] The UUID of the parent account associated with this account.
111
115
  define_attribute :parent_account_id, String
@@ -0,0 +1,54 @@
1
+ # This file is automatically created by Recurly's OpenAPI generation process
2
+ # and thus any edits you make by hand will be lost. If you wish to make a
3
+ # change to this file, please create a Github issue explaining the changes you
4
+ # need and we will usher them to the appropriate places.
5
+ module Recurly
6
+ module Resources
7
+ class BusinessEntity < Resource
8
+
9
+ # @!attribute code
10
+ # @return [String] The entity code of the business entity.
11
+ define_attribute :code, String
12
+
13
+ # @!attribute created_at
14
+ # @return [DateTime] Created at
15
+ define_attribute :created_at, DateTime
16
+
17
+ # @!attribute default_registration_number
18
+ # @return [String] Registration number for the customer used on the invoice.
19
+ define_attribute :default_registration_number, String
20
+
21
+ # @!attribute default_vat_number
22
+ # @return [String] VAT number for the customer used on the invoice.
23
+ define_attribute :default_vat_number, String
24
+
25
+ # @!attribute id
26
+ # @return [String] Business entity ID
27
+ define_attribute :id, String
28
+
29
+ # @!attribute invoice_display_address
30
+ # @return [Address] Address information for the business entity that will appear on the invoice.
31
+ define_attribute :invoice_display_address, :Address
32
+
33
+ # @!attribute name
34
+ # @return [String] This name describes your business entity and will appear on the invoice.
35
+ define_attribute :name, String
36
+
37
+ # @!attribute object
38
+ # @return [String] Object type
39
+ define_attribute :object, String
40
+
41
+ # @!attribute subscriber_location_countries
42
+ # @return [Array[String]] List of countries for which the business entity will be used.
43
+ define_attribute :subscriber_location_countries, Array, { :item_type => String }
44
+
45
+ # @!attribute tax_address
46
+ # @return [Address] Address information for the business entity that will be used for calculating taxes.
47
+ define_attribute :tax_address, :Address
48
+
49
+ # @!attribute updated_at
50
+ # @return [DateTime] Last updated at
51
+ define_attribute :updated_at, DateTime
52
+ end
53
+ end
54
+ end
@@ -22,6 +22,10 @@ module Recurly
22
22
  # @return [Boolean] An indication of whether or not the external subscription will auto-renew at the expiration date.
23
23
  define_attribute :auto_renew, :Boolean
24
24
 
25
+ # @!attribute canceled_at
26
+ # @return [DateTime] When the external subscription was canceled in the external platform.
27
+ define_attribute :canceled_at, DateTime
28
+
25
29
  # @!attribute created_at
26
30
  # @return [DateTime] When the external subscription was created in Recurly.
27
31
  define_attribute :created_at, DateTime
@@ -42,6 +46,10 @@ module Recurly
42
46
  # @return [String] System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
43
47
  define_attribute :id, String
44
48
 
49
+ # @!attribute in_grace_period
50
+ # @return [Boolean] An indication of whether or not the external subscription is in a grace period.
51
+ define_attribute :in_grace_period, :Boolean
52
+
45
53
  # @!attribute last_purchased
46
54
  # @return [DateTime] When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
47
55
  define_attribute :last_purchased, DateTime
@@ -55,9 +63,17 @@ module Recurly
55
63
  define_attribute :quantity, Integer
56
64
 
57
65
  # @!attribute state
58
- # @return [String] External subscriptions can be active, canceled, expired, or future.
66
+ # @return [String] External subscriptions can be active, canceled, expired, or past_due.
59
67
  define_attribute :state, String
60
68
 
69
+ # @!attribute trial_ends_at
70
+ # @return [DateTime] When the external subscription trial period ends in the external platform.
71
+ define_attribute :trial_ends_at, DateTime
72
+
73
+ # @!attribute trial_started_at
74
+ # @return [DateTime] When the external subscription trial period started in the external platform.
75
+ define_attribute :trial_started_at, DateTime
76
+
61
77
  # @!attribute updated_at
62
78
  # @return [DateTime] When the external subscription was updated in Recurly.
63
79
  define_attribute :updated_at, DateTime
@@ -22,6 +22,10 @@ module Recurly
22
22
  # @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.
23
23
  define_attribute :billing_info_id, String
24
24
 
25
+ # @!attribute business_entity_id
26
+ # @return [String] Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled.
27
+ define_attribute :business_entity_id, String
28
+
25
29
  # @!attribute closed_at
26
30
  # @return [DateTime] Date invoice was marked paid or failed.
27
31
  define_attribute :closed_at, DateTime
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.37.0"
2
+ VERSION = "4.39.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -228,6 +228,7 @@ x-tagGroups:
228
228
  - custom_field_definition
229
229
  - shipping_method
230
230
  - dunning_campaigns
231
+ - business_entities
231
232
  tags:
232
233
  - name: site
233
234
  x-displayName: Site
@@ -374,6 +375,10 @@ tags:
374
375
  description: An account from an external resource that is not managed by the Recurly
375
376
  platform and instead is managed by third-party platforms like Apple App Store
376
377
  and Google Play Store.
378
+ - name: business_entities
379
+ x-displayName: Business Entities
380
+ description: Describes the business address that will be used for invoices and taxes
381
+ depending on settings and subscriber location.
377
382
  paths:
378
383
  "/sites":
379
384
  get:
@@ -15974,6 +15979,60 @@ paths:
15974
15979
  schema:
15975
15980
  "$ref": "#/components/schemas/Error"
15976
15981
  x-code-samples: []
15982
+ "/business_entities/{business_entity_id}":
15983
+ parameters:
15984
+ - "$ref": "#/components/parameters/business_entity_id"
15985
+ get:
15986
+ tags:
15987
+ - business_entities
15988
+ operationId: get_business_entity
15989
+ summary: Fetch a business entity
15990
+ responses:
15991
+ '200':
15992
+ description: Business entity details
15993
+ content:
15994
+ application/json:
15995
+ schema:
15996
+ "$ref": "#/components/schemas/BusinessEntity"
15997
+ '404':
15998
+ description: Incorrect site or business entity ID.
15999
+ content:
16000
+ application/json:
16001
+ schema:
16002
+ "$ref": "#/components/schemas/Error"
16003
+ default:
16004
+ description: Unexpected error.
16005
+ content:
16006
+ application/json:
16007
+ schema:
16008
+ "$ref": "#/components/schemas/Error"
16009
+ x-code-samples: []
16010
+ "/business_entities":
16011
+ get:
16012
+ tags:
16013
+ - business_entities
16014
+ operationId: list_business_entities
16015
+ summary: List business entities
16016
+ responses:
16017
+ '200':
16018
+ description: List of all business entities on your site.
16019
+ content:
16020
+ application/json:
16021
+ schema:
16022
+ "$ref": "#/components/schemas/BusinessEntityList"
16023
+ '404':
16024
+ description: Incorrect site.
16025
+ content:
16026
+ application/json:
16027
+ schema:
16028
+ "$ref": "#/components/schemas/Error"
16029
+ default:
16030
+ description: Unexpected error.
16031
+ content:
16032
+ application/json:
16033
+ schema:
16034
+ "$ref": "#/components/schemas/Error"
16035
+ x-code-samples: []
15977
16036
  "/gift_cards":
15978
16037
  get:
15979
16038
  tags:
@@ -16143,6 +16202,49 @@ paths:
16143
16202
  schema:
16144
16203
  "$ref": "#/components/schemas/Error"
16145
16204
  x-code-samples: []
16205
+ "/business_entities/{business_entity_id}/invoices":
16206
+ get:
16207
+ tags:
16208
+ - invoice
16209
+ operationId: list_business_entity_invoices
16210
+ summary: List a business entity's invoices
16211
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
16212
+ to learn how to use pagination in the API and Client Libraries.
16213
+ parameters:
16214
+ - "$ref": "#/components/parameters/business_entity_id"
16215
+ - "$ref": "#/components/parameters/ids"
16216
+ - "$ref": "#/components/parameters/limit"
16217
+ - "$ref": "#/components/parameters/order"
16218
+ - "$ref": "#/components/parameters/sort_dates"
16219
+ - "$ref": "#/components/parameters/filter_begin_time"
16220
+ - "$ref": "#/components/parameters/filter_end_time"
16221
+ - "$ref": "#/components/parameters/filter_invoice_type"
16222
+ responses:
16223
+ '200':
16224
+ description: A list of the business entity's invoices.
16225
+ content:
16226
+ application/json:
16227
+ schema:
16228
+ "$ref": "#/components/schemas/InvoiceList"
16229
+ '400':
16230
+ description: Invalid or unpermitted parameter.
16231
+ content:
16232
+ application/json:
16233
+ schema:
16234
+ "$ref": "#/components/schemas/Error"
16235
+ '404':
16236
+ description: Incorrect site or business entity ID.
16237
+ content:
16238
+ application/json:
16239
+ schema:
16240
+ "$ref": "#/components/schemas/Error"
16241
+ default:
16242
+ description: Unexpected error.
16243
+ content:
16244
+ application/json:
16245
+ schema:
16246
+ "$ref": "#/components/schemas/Error"
16247
+ x-code-samples: []
16146
16248
  servers:
16147
16249
  - url: https://v3.recurly.com
16148
16250
  - url: https://v3.eu.recurly.com
@@ -16180,6 +16282,14 @@ components:
16180
16282
  required: true
16181
16283
  schema:
16182
16284
  type: string
16285
+ business_entity_id:
16286
+ name: business_entity_id
16287
+ in: path
16288
+ description: Business Entity ID. For ID no prefix is used e.g. `e28zov4fw0v2`.
16289
+ For code use prefix `code-`, e.g. `code-entity1`.
16290
+ required: true
16291
+ schema:
16292
+ type: string
16183
16293
  usage_id:
16184
16294
  name: usage_id
16185
16295
  in: path
@@ -17101,6 +17211,11 @@ components:
17101
17211
  merchant has an integration for the Vertex tax provider, this optional
17102
17212
  value will be sent in any tax calculation requests for the account.
17103
17213
  maxLength: 30
17214
+ override_business_entity_id:
17215
+ type: string
17216
+ title: Override Business Entity ID
17217
+ description: Unique ID to identify the business entity assigned to the account.
17218
+ Available when the `Multiple Business Entities` feature is enabled.
17104
17219
  parent_account_code:
17105
17220
  type: string
17106
17221
  maxLength: 50
@@ -17169,6 +17284,11 @@ components:
17169
17284
  The customer will also use this email address to log into your hosted
17170
17285
  account management pages. This value does not need to be unique.
17171
17286
  maxLength: 255
17287
+ override_business_entity_id:
17288
+ type: string
17289
+ title: Override Business Entity ID
17290
+ description: Unique ID to identify the business entity assigned to the account.
17291
+ Available when the `Multiple Business Entities` feature is enabled.
17172
17292
  preferred_locale:
17173
17293
  description: Used to determine the language and locale of emails sent on
17174
17294
  behalf of the merchant to the customer.
@@ -19358,6 +19478,11 @@ components:
19358
19478
  type: boolean
19359
19479
  title: Final Dunning Event
19360
19480
  description: Last communication attempt.
19481
+ business_entity_id:
19482
+ type: string
19483
+ title: Business Entity ID
19484
+ description: Unique ID to identify the business entity assigned to the invoice.
19485
+ Available when the `Multiple Business Entities` feature is enabled.
19361
19486
  InvoiceCreate:
19362
19487
  type: object
19363
19488
  properties:
@@ -23640,6 +23765,12 @@ components:
23640
23765
  description: An indication of whether or not the external subscription will
23641
23766
  auto-renew at the expiration date.
23642
23767
  default: false
23768
+ in_grace_period:
23769
+ type: boolean
23770
+ title: In grace period
23771
+ description: An indication of whether or not the external subscription is
23772
+ in a grace period.
23773
+ default: false
23643
23774
  app_identifier:
23644
23775
  type: string
23645
23776
  title: App identifier
@@ -23653,18 +23784,37 @@ components:
23653
23784
  state:
23654
23785
  type: string
23655
23786
  description: External subscriptions can be active, canceled, expired, or
23656
- future.
23787
+ past_due.
23788
+ default: active
23657
23789
  activated_at:
23658
23790
  type: string
23659
23791
  format: date-time
23660
23792
  title: Activated at
23661
23793
  description: When the external subscription was activated in the external
23662
23794
  platform.
23795
+ canceled_at:
23796
+ type: string
23797
+ format: date-time
23798
+ title: Canceled at
23799
+ description: When the external subscription was canceled in the external
23800
+ platform.
23663
23801
  expires_at:
23664
23802
  type: string
23665
23803
  format: date-time
23666
23804
  title: Expires at
23667
23805
  description: When the external subscription expires in the external platform.
23806
+ trial_started_at:
23807
+ type: string
23808
+ format: date-time
23809
+ title: Trial started at
23810
+ description: When the external subscription trial period started in the
23811
+ external platform.
23812
+ trial_ends_at:
23813
+ type: string
23814
+ format: date-time
23815
+ title: Trial ends at
23816
+ description: When the external subscription trial period ends in the external
23817
+ platform.
23668
23818
  created_at:
23669
23819
  type: string
23670
23820
  format: date-time
@@ -23939,6 +24089,84 @@ components:
23939
24089
  type: string
23940
24090
  description: Username of the associated payment method. Currently only associated
23941
24091
  with Venmo.
24092
+ BusinessEntityList:
24093
+ type: object
24094
+ properties:
24095
+ object:
24096
+ type: string
24097
+ title: Object type
24098
+ description: Will always be List.
24099
+ has_more:
24100
+ type: boolean
24101
+ description: Indicates there are more results on subsequent pages.
24102
+ next:
24103
+ type: string
24104
+ description: Path to subsequent page of results.
24105
+ data:
24106
+ type: array
24107
+ items:
24108
+ "$ref": "#/components/schemas/BusinessEntity"
24109
+ BusinessEntity:
24110
+ type: object
24111
+ description: Business entity details
24112
+ properties:
24113
+ id:
24114
+ title: Business entity ID
24115
+ type: string
24116
+ maxLength: 13
24117
+ readOnly: true
24118
+ object:
24119
+ title: Object type
24120
+ type: string
24121
+ readOnly: true
24122
+ code:
24123
+ title: Business entity code
24124
+ type: string
24125
+ maxLength: 50
24126
+ description: The entity code of the business entity.
24127
+ name:
24128
+ type: string
24129
+ title: Name
24130
+ description: This name describes your business entity and will appear on
24131
+ the invoice.
24132
+ maxLength: 255
24133
+ invoice_display_address:
24134
+ title: Invoice display address
24135
+ description: Address information for the business entity that will appear
24136
+ on the invoice.
24137
+ "$ref": "#/components/schemas/Address"
24138
+ tax_address:
24139
+ title: Tax address
24140
+ description: Address information for the business entity that will be used
24141
+ for calculating taxes.
24142
+ "$ref": "#/components/schemas/Address"
24143
+ default_vat_number:
24144
+ type: string
24145
+ title: Default VAT number
24146
+ description: VAT number for the customer used on the invoice.
24147
+ maxLength: 20
24148
+ default_registration_number:
24149
+ type: string
24150
+ title: Default registration number
24151
+ description: Registration number for the customer used on the invoice.
24152
+ maxLength: 30
24153
+ subscriber_location_countries:
24154
+ type: array
24155
+ title: Subscriber location countries
24156
+ description: List of countries for which the business entity will be used.
24157
+ items:
24158
+ type: string
24159
+ title: Country code
24160
+ created_at:
24161
+ type: string
24162
+ format: date-time
24163
+ title: Created at
24164
+ readOnly: true
24165
+ updated_at:
24166
+ type: string
24167
+ format: date-time
24168
+ title: Last updated at
24169
+ readOnly: true
23942
24170
  GiftCardList:
23943
24171
  type: object
23944
24172
  properties:
@@ -24836,6 +25064,7 @@ components:
24836
25064
  - venmo
24837
25065
  - wire_transfer
24838
25066
  - braintree_v_zero
25067
+ - boleto
24839
25068
  CardTypeEnum:
24840
25069
  type: string
24841
25070
  enum:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: recurly
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.37.0
4
+ version: 4.39.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Recurly
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-24 00:00:00.000000000 Z
11
+ date: 2023-07-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -121,6 +121,7 @@ files:
121
121
  - ".github/ISSUE_TEMPLATE/question-or-other.md"
122
122
  - ".github/workflows/ci.yml"
123
123
  - ".github/workflows/docs.yml"
124
+ - ".github/workflows/pr-review.yml"
124
125
  - ".gitignore"
125
126
  - ".rspec"
126
127
  - ".yardopts"
@@ -241,6 +242,7 @@ files:
241
242
  - lib/recurly/resources/billing_info.rb
242
243
  - lib/recurly/resources/billing_info_updated_by.rb
243
244
  - lib/recurly/resources/binary_file.rb
245
+ - lib/recurly/resources/business_entity.rb
244
246
  - lib/recurly/resources/coupon.rb
245
247
  - lib/recurly/resources/coupon_discount.rb
246
248
  - lib/recurly/resources/coupon_discount_pricing.rb
@@ -343,7 +345,7 @@ metadata:
343
345
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
344
346
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
345
347
  homepage_uri: https://github.com/recurly/recurly-client-ruby
346
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.37.0
348
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.39.0
347
349
  post_install_message:
348
350
  rdoc_options: []
349
351
  require_paths: