recurly 4.29.0 → 4.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0a12c336abc5627ae6108c79356cc295fdab9e5417fc932a7bcf41192fc08e1a
4
- data.tar.gz: 4f2125b55ea52e1afe80feda3c48ad6e3688c879ffa1ccd954180f721a4bf4d2
3
+ metadata.gz: 84747761025eb90c7de66e7da62fe6cce9fd058e278adf1d6038eb6fc492b5f3
4
+ data.tar.gz: 441ffabcdcf6ae892d45d5074a44b56661a583701e543226bf8c2a70ccfce467
5
5
  SHA512:
6
- metadata.gz: 7e717e56f0f8fd73609e0c500f2dc6162450db20c20760d529e32e5c6c530169e1ff359a13d97c2a06fed6e059cec561a38db9142020b248854d7086108b45da
7
- data.tar.gz: 8f99005efd5625d1dfaa9fa9e1f56ea8128b85234b14990e8ba95f806fc52f79b1429c7f4d778d2cf94803b2b000354843687d2aa54b9b50ed0d0ee8cd3a4e61
6
+ metadata.gz: 4910840cf085df49e2209b71dfd623296a824dff3069711eccd8b2ccb50576d821b637fa4d6fd50341361a92d5d3d9a03af6d914b2dcd33266ccea38cb19a9cd
7
+ data.tar.gz: bb57c2e12770d33591b37589d89f26bf75f56c89ee005f28a4c05bb5535d0a48b7d6b767c99fb2929a2b696ed9b14a5343177f3d08642f92d4fd37b8b8d9c240
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 4.29.0
2
+ current_version = 4.31.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.31.0](https://github.com/recurly/recurly-client-ruby/tree/4.31.0) (2023-03-29)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.30.0...4.31.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2021-02-25 (External Invoices) [#831](https://github.com/recurly/recurly-client-ruby/pull/831) ([recurly-integrations](https://github.com/recurly-integrations))
11
+
12
+
13
+
14
+ ## [4.30.0](https://github.com/recurly/recurly-client-ruby/tree/4.30.0) (2023-02-22)
15
+
16
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.29.0...4.30.0)
17
+
18
+
19
+ **Merged Pull Requests**
20
+
21
+ - Generated Latest Changes for v2021-02-25 [#829](https://github.com/recurly/recurly-client-ruby/pull/829) ([recurly-integrations](https://github.com/recurly-integrations))
22
+
23
+
24
+
3
25
  ## [4.29.0](https://github.com/recurly/recurly-client-ruby/tree/4.29.0) (2023-02-07)
4
26
 
5
27
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.28.0...4.29.0)
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.29'
8
+ gem 'recurly', '~> 4.31'
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.
@@ -750,6 +750,26 @@ module Recurly
750
750
  pager(path, **options)
751
751
  end
752
752
 
753
+ # List the external invoices on an account
754
+ #
755
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_external_invoices list_account_external_invoices api documentation}
756
+ #
757
+ # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
758
+ # @param params [Hash] Optional query string parameters:
759
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
760
+ # order. In descending order updated records will move behind the cursor and could
761
+ # prevent some records from being returned.
762
+ #
763
+ # :limit [Integer] Limit number of records 1-200.
764
+ # :order [String] Sort order.
765
+ #
766
+ # @return [Pager<Resources::ExternalInvoice>] A list of the the external_invoices on an account.
767
+ #
768
+ def list_account_external_invoices(account_id:, **options)
769
+ path = interpolate_path("/accounts/{account_id}/external_invoices", account_id: account_id)
770
+ pager(path, **options)
771
+ end
772
+
753
773
  # List an account's invoices
754
774
  #
755
775
  # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api documentation}
@@ -2109,6 +2129,26 @@ module Recurly
2109
2129
  get(path, **options)
2110
2130
  end
2111
2131
 
2132
+ # List the external invoices on an external subscription
2133
+ #
2134
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscription_external_invoices list_external_subscription_external_invoices api documentation}
2135
+ #
2136
+ # @param external_subscription_id [String] External subscription id
2137
+ # @param params [Hash] Optional query string parameters:
2138
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2139
+ # order. In descending order updated records will move behind the cursor and could
2140
+ # prevent some records from being returned.
2141
+ #
2142
+ # :limit [Integer] Limit number of records 1-200.
2143
+ # :order [String] Sort order.
2144
+ #
2145
+ # @return [Pager<Resources::ExternalInvoice>] A list of the the external_invoices on a site.
2146
+ #
2147
+ def list_external_subscription_external_invoices(external_subscription_id:, **options)
2148
+ path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_invoices", external_subscription_id: external_subscription_id)
2149
+ pager(path, **options)
2150
+ end
2151
+
2112
2152
  # List a site's invoices
2113
2153
  #
2114
2154
  # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation}
@@ -4179,6 +4219,39 @@ module Recurly
4179
4219
  get(path, **options)
4180
4220
  end
4181
4221
 
4222
+ # List the external invoices on a site
4223
+ #
4224
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_invoices list_external_invoices api documentation}
4225
+ #
4226
+ # @param params [Hash] Optional query string parameters:
4227
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
4228
+ # order. In descending order updated records will move behind the cursor and could
4229
+ # prevent some records from being returned.
4230
+ #
4231
+ # :limit [Integer] Limit number of records 1-200.
4232
+ # :order [String] Sort order.
4233
+ #
4234
+ # @return [Pager<Resources::ExternalInvoice>] A list of the the external_invoices on a site.
4235
+ #
4236
+ def list_external_invoices(**options)
4237
+ path = "/external_invoices"
4238
+ pager(path, **options)
4239
+ end
4240
+
4241
+ # Fetch an external invoice
4242
+ #
4243
+ # {https://developers.recurly.com/api/v2021-02-25#operation/show_external_invoice show_external_invoice api documentation}
4244
+ #
4245
+ # @param external_invoice_id [String] External invoice ID, e.g. +e28zov4fw0v2+.
4246
+ # @param params [Hash] Optional query string parameters:
4247
+ #
4248
+ # @return [Resources::ExternalInvoice] Returns the external invoice
4249
+ #
4250
+ def show_external_invoice(external_invoice_id:, **options)
4251
+ path = interpolate_path("/external_invoices/{external_invoice_id}", external_invoice_id: external_invoice_id)
4252
+ get(path, **options)
4253
+ end
4254
+
4182
4255
  # List entitlements granted to an account
4183
4256
  #
4184
4257
  # {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}
@@ -43,7 +43,7 @@ module Recurly
43
43
  define_attribute :updated_at, DateTime
44
44
 
45
45
  # @!attribute user_access
46
- # @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
46
+ # @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
47
47
  define_attribute :user_access, String
48
48
  end
49
49
  end
@@ -0,0 +1,50 @@
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 ExternalCharge < Resource
8
+
9
+ # @!attribute account
10
+ # @return [AccountMini] Account mini details
11
+ define_attribute :account, :AccountMini
12
+
13
+ # @!attribute created_at
14
+ # @return [DateTime] When the external charge was created in Recurly.
15
+ define_attribute :created_at, DateTime
16
+
17
+ # @!attribute currency
18
+ # @return [String] 3-letter ISO 4217 currency code.
19
+ define_attribute :currency, String
20
+
21
+ # @!attribute description
22
+ # @return [String]
23
+ define_attribute :description, String
24
+
25
+ # @!attribute external_product_reference
26
+ # @return [ExternalProductReferenceMini] External Product Reference details
27
+ define_attribute :external_product_reference, :ExternalProductReferenceMini
28
+
29
+ # @!attribute id
30
+ # @return [String] System-generated unique identifier for an external charge ID, e.g. `e28zov4fw0v2`.
31
+ define_attribute :id, String
32
+
33
+ # @!attribute object
34
+ # @return [String] Object type
35
+ define_attribute :object, String
36
+
37
+ # @!attribute quantity
38
+ # @return [Integer]
39
+ define_attribute :quantity, Integer
40
+
41
+ # @!attribute unit_amount
42
+ # @return [Float] Unit Amount
43
+ define_attribute :unit_amount, Float
44
+
45
+ # @!attribute updated_at
46
+ # @return [DateTime] When the external charge was updated in Recurly.
47
+ define_attribute :updated_at, DateTime
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,58 @@
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 ExternalInvoice < Resource
8
+
9
+ # @!attribute account
10
+ # @return [AccountMini] Account mini details
11
+ define_attribute :account, :AccountMini
12
+
13
+ # @!attribute created_at
14
+ # @return [DateTime] When the external invoice was created in Recurly.
15
+ define_attribute :created_at, DateTime
16
+
17
+ # @!attribute currency
18
+ # @return [String] 3-letter ISO 4217 currency code.
19
+ define_attribute :currency, String
20
+
21
+ # @!attribute external_id
22
+ # @return [String] An identifier which associates the external invoice to a corresponding object in an external platform.
23
+ define_attribute :external_id, String
24
+
25
+ # @!attribute external_subscription
26
+ # @return [ExternalSubscription] Subscription from an external resource such as Apple App Store or Google Play Store.
27
+ define_attribute :external_subscription, :ExternalSubscription
28
+
29
+ # @!attribute id
30
+ # @return [String] System-generated unique identifier for an external invoice ID, e.g. `e28zov4fw0v2`.
31
+ define_attribute :id, String
32
+
33
+ # @!attribute line_items
34
+ # @return [Array[ExternalCharge]]
35
+ define_attribute :line_items, Array, { :item_type => :ExternalCharge }
36
+
37
+ # @!attribute object
38
+ # @return [String] Object type
39
+ define_attribute :object, String
40
+
41
+ # @!attribute purchased_at
42
+ # @return [DateTime] When the invoice was created in the external platform.
43
+ define_attribute :purchased_at, DateTime
44
+
45
+ # @!attribute state
46
+ # @return [String]
47
+ define_attribute :state, String
48
+
49
+ # @!attribute total
50
+ # @return [Float] Total
51
+ define_attribute :total, Float
52
+
53
+ # @!attribute updated_at
54
+ # @return [DateTime] When the external invoice was updated in Recurly.
55
+ define_attribute :updated_at, DateTime
56
+ end
57
+ end
58
+ end
@@ -30,14 +30,14 @@ module Recurly
30
30
  # @return [DateTime] When the external subscription expires in the external platform.
31
31
  define_attribute :expires_at, DateTime
32
32
 
33
+ # @!attribute external_id
34
+ # @return [String] The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.
35
+ define_attribute :external_id, String
36
+
33
37
  # @!attribute external_product_reference
34
38
  # @return [ExternalProductReferenceMini] External Product Reference details
35
39
  define_attribute :external_product_reference, :ExternalProductReferenceMini
36
40
 
37
- # @!attribute external_resource
38
- # @return [ExternalResourceMini] External Resource mini details
39
- define_attribute :external_resource, :ExternalResourceMini
40
-
41
41
  # @!attribute id
42
42
  # @return [String] System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
43
43
  define_attribute :id, String
@@ -54,6 +54,10 @@ module Recurly
54
54
  # @return [Integer] An indication of the quantity of a subscribed item's quantity.
55
55
  define_attribute :quantity, Integer
56
56
 
57
+ # @!attribute state
58
+ # @return [String] External subscriptions can be active, canceled, expired, or future.
59
+ define_attribute :state, String
60
+
57
61
  # @!attribute updated_at
58
62
  # @return [DateTime] When the external subscription was updated in Recurly.
59
63
  define_attribute :updated_at, DateTime
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.29.0"
2
+ VERSION = "4.31.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -200,6 +200,7 @@ x-tagGroups:
200
200
  - usage
201
201
  - automated_exports
202
202
  - external_subscriptions
203
+ - external_invoices
203
204
  - external_products
204
205
  - gift_cards
205
206
  - name: Products and Promotions
@@ -228,8 +229,8 @@ tags:
228
229
  x-displayName: Site
229
230
  - name: custom_field_definition
230
231
  x-displayName: Custom Field Definition
231
- description: Describes the fields that can use used as custom fields on accounts
232
- or subscriptions.
232
+ description: Describes the fields that can be used as custom fields on accounts,
233
+ items, line-items (one time charges), plans, or subscriptions.
233
234
  - name: item
234
235
  x-displayName: Item
235
236
  description: |-
@@ -346,6 +347,11 @@ tags:
346
347
  description: A subscription from an external resource that is not managed by the
347
348
  Recurly platform and instead is managed by third-party platforms like Apple App
348
349
  Store and Google Play Store.
350
+ - name: external_invoices
351
+ x-displayName: External Invoices
352
+ description: An invoice from an external resource that is not managed by the Recurly
353
+ platform and instead is managed by third-party platforms like Apple App Store
354
+ and Google Play Store.
349
355
  - name: external_products
350
356
  x-displayName: External Product
351
357
  description: A product from an external resource that is not managed by the Recurly
@@ -3244,6 +3250,40 @@ paths:
3244
3250
  := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed to retrieve next
3245
3251
  page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, creditPayment := range creditPayments.Data()
3246
3252
  {\n\t\tfmt.Printf(\"Account Credit Payment %3d: %s\\n\",\n\t\t\ti,\n\t\t\tcreditPayment.Id,\n\t\t)\n\t}\n}"
3253
+ "/accounts/{account_id}/external_invoices":
3254
+ parameters:
3255
+ - "$ref": "#/components/parameters/account_id"
3256
+ get:
3257
+ tags:
3258
+ - account
3259
+ operationId: list_account_external_invoices
3260
+ summary: List the external invoices on an account
3261
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3262
+ to learn how to use pagination in the API and Client Libraries.
3263
+ parameters:
3264
+ - "$ref": "#/components/parameters/sort_dates"
3265
+ - "$ref": "#/components/parameters/limit"
3266
+ - "$ref": "#/components/parameters/order"
3267
+ responses:
3268
+ '200':
3269
+ description: A list of the the external_invoices on an account.
3270
+ content:
3271
+ application/json:
3272
+ schema:
3273
+ "$ref": "#/components/schemas/ExternalInvoiceList"
3274
+ '404':
3275
+ description: Incorrect account.
3276
+ content:
3277
+ application/json:
3278
+ schema:
3279
+ "$ref": "#/components/schemas/Error"
3280
+ default:
3281
+ description: Unexpected error.
3282
+ content:
3283
+ application/json:
3284
+ schema:
3285
+ "$ref": "#/components/schemas/Error"
3286
+ x-code-samples: []
3247
3287
  "/accounts/{account_id}/invoices":
3248
3288
  get:
3249
3289
  tags:
@@ -7588,6 +7628,40 @@ paths:
7588
7628
  schema:
7589
7629
  "$ref": "#/components/schemas/Error"
7590
7630
  x-code-samples: []
7631
+ "/external_subscriptions/{external_subscription_id}/external_invoices":
7632
+ parameters:
7633
+ - "$ref": "#/components/parameters/external_subscription_id"
7634
+ get:
7635
+ tags:
7636
+ - external_subscriptions
7637
+ operationId: list_external_subscription_external_invoices
7638
+ summary: List the external invoices on an external subscription
7639
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
7640
+ to learn how to use pagination in the API and Client Libraries.
7641
+ parameters:
7642
+ - "$ref": "#/components/parameters/sort_dates"
7643
+ - "$ref": "#/components/parameters/limit"
7644
+ - "$ref": "#/components/parameters/order"
7645
+ responses:
7646
+ '200':
7647
+ description: A list of the the external_invoices on a site.
7648
+ content:
7649
+ application/json:
7650
+ schema:
7651
+ "$ref": "#/components/schemas/ExternalInvoiceList"
7652
+ '404':
7653
+ description: Incorrect site.
7654
+ content:
7655
+ application/json:
7656
+ schema:
7657
+ "$ref": "#/components/schemas/Error"
7658
+ default:
7659
+ description: Unexpected error.
7660
+ content:
7661
+ application/json:
7662
+ schema:
7663
+ "$ref": "#/components/schemas/Error"
7664
+ x-code-samples: []
7591
7665
  "/invoices":
7592
7666
  get:
7593
7667
  tags:
@@ -15346,6 +15420,72 @@ paths:
15346
15420
  schema:
15347
15421
  "$ref": "#/components/schemas/Error"
15348
15422
  x-code-samples: []
15423
+ "/external_invoices":
15424
+ get:
15425
+ tags:
15426
+ - external_invoices
15427
+ operationId: list_external_invoices
15428
+ summary: List the external invoices on a site
15429
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
15430
+ to learn how to use pagination in the API and Client Libraries.
15431
+ parameters:
15432
+ - "$ref": "#/components/parameters/sort_dates"
15433
+ - "$ref": "#/components/parameters/limit"
15434
+ - "$ref": "#/components/parameters/order"
15435
+ responses:
15436
+ '200':
15437
+ description: A list of the the external_invoices on a site.
15438
+ content:
15439
+ application/json:
15440
+ schema:
15441
+ "$ref": "#/components/schemas/ExternalInvoiceList"
15442
+ '404':
15443
+ description: Incorrect site.
15444
+ content:
15445
+ application/json:
15446
+ schema:
15447
+ "$ref": "#/components/schemas/Error"
15448
+ default:
15449
+ description: Unexpected error.
15450
+ content:
15451
+ application/json:
15452
+ schema:
15453
+ "$ref": "#/components/schemas/Error"
15454
+ x-code-samples: []
15455
+ "/external_invoices/{external_invoice_id}":
15456
+ parameters:
15457
+ - "$ref": "#/components/parameters/external_invoice_id"
15458
+ get:
15459
+ tags:
15460
+ - external_invoices
15461
+ operationId: show_external_invoice
15462
+ summary: Fetch an external invoice
15463
+ responses:
15464
+ '201':
15465
+ description: Returns the external invoice
15466
+ content:
15467
+ application/json:
15468
+ schema:
15469
+ "$ref": "#/components/schemas/ExternalInvoice"
15470
+ '400':
15471
+ description: Bad request; perhaps missing or invalid parameters.
15472
+ content:
15473
+ application/json:
15474
+ schema:
15475
+ "$ref": "#/components/schemas/Error"
15476
+ '404':
15477
+ description: External invoice cannot be found for the specified reason.
15478
+ content:
15479
+ application/json:
15480
+ schema:
15481
+ "$ref": "#/components/schemas/Error"
15482
+ default:
15483
+ description: Unexpected error.
15484
+ content:
15485
+ application/json:
15486
+ schema:
15487
+ "$ref": "#/components/schemas/Error"
15488
+ x-code-samples: []
15349
15489
  "/accounts/{account_id}/entitlements":
15350
15490
  parameters:
15351
15491
  - "$ref": "#/components/parameters/account_id"
@@ -15643,6 +15783,13 @@ components:
15643
15783
  required: true
15644
15784
  schema:
15645
15785
  type: string
15786
+ external_invoice_id:
15787
+ name: external_invoice_id
15788
+ in: path
15789
+ description: External invoice ID, e.g. `e28zov4fw0v2`.
15790
+ required: true
15791
+ schema:
15792
+ type: string
15646
15793
  external_product_id:
15647
15794
  name: external_product_id
15648
15795
  in: path
@@ -18211,6 +18358,7 @@ components:
18211
18358
  - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but
18212
18359
  editing will only be available via the API.
18213
18360
  - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
18361
+ - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
18214
18362
  "$ref": "#/components/schemas/UserAccessEnum"
18215
18363
  display_name:
18216
18364
  type: string
@@ -22846,10 +22994,13 @@ components:
22846
22994
  title: Object type
22847
22995
  account:
22848
22996
  "$ref": "#/components/schemas/AccountMini"
22849
- external_resource:
22850
- "$ref": "#/components/schemas/ExternalResourceMini"
22851
22997
  external_product_reference:
22852
22998
  "$ref": "#/components/schemas/ExternalProductReferenceMini"
22999
+ external_id:
23000
+ type: string
23001
+ title: External Id
23002
+ description: The id of the subscription in the external systems., I.e. Apple
23003
+ App Store or Google Play Store.
22853
23004
  last_purchased:
22854
23005
  type: string
22855
23006
  format: date-time
@@ -22872,6 +23023,10 @@ components:
22872
23023
  description: An indication of the quantity of a subscribed item's quantity.
22873
23024
  default: 1
22874
23025
  minimum: 0
23026
+ state:
23027
+ type: string
23028
+ description: External subscriptions can be active, canceled, expired, or
23029
+ future.
22875
23030
  activated_at:
22876
23031
  type: string
22877
23032
  format: date-time
@@ -22910,25 +23065,110 @@ components:
22910
23065
  type: array
22911
23066
  items:
22912
23067
  "$ref": "#/components/schemas/ExternalSubscription"
22913
- ExternalResourceMini:
23068
+ ExternalInvoice:
22914
23069
  type: object
22915
- title: External Resource mini details
23070
+ description: Invoice from an external resource such as Apple App Store or Google
23071
+ Play Store.
22916
23072
  properties:
22917
23073
  id:
22918
23074
  type: string
22919
- title: External resource ID
22920
- description: System-generated unique identifier for an external resource
23075
+ title: External invoice ID
23076
+ description: System-generated unique identifier for an external invoice
22921
23077
  ID, e.g. `e28zov4fw0v2`.
22922
23078
  object:
22923
23079
  type: string
22924
23080
  title: Object type
22925
- external_object_reference:
23081
+ account:
23082
+ "$ref": "#/components/schemas/AccountMini"
23083
+ external_subscription:
23084
+ "$ref": "#/components/schemas/ExternalSubscription"
23085
+ external_id:
22926
23086
  type: string
22927
- title: External Object Reference
22928
- description: Identifier or URL reference where the resource is canonically
22929
- available in the external platform.
22930
- maxLength: 255
22931
- readOnly: true
23087
+ description: An identifier which associates the external invoice to a corresponding
23088
+ object in an external platform.
23089
+ state:
23090
+ "$ref": "#/components/schemas/ExternalInvoiceStateEnum"
23091
+ total:
23092
+ type: number
23093
+ format: float
23094
+ title: Total
23095
+ currency:
23096
+ type: string
23097
+ title: Currency
23098
+ description: 3-letter ISO 4217 currency code.
23099
+ line_items:
23100
+ type: array
23101
+ items:
23102
+ "$ref": "#/components/schemas/ExternalCharge"
23103
+ purchased_at:
23104
+ type: string
23105
+ format: date-time
23106
+ description: When the invoice was created in the external platform.
23107
+ created_at:
23108
+ type: string
23109
+ format: date-time
23110
+ description: When the external invoice was created in Recurly.
23111
+ updated_at:
23112
+ type: string
23113
+ format: date-time
23114
+ title: Updated at
23115
+ description: When the external invoice was updated in Recurly.
23116
+ ExternalInvoiceList:
23117
+ type: object
23118
+ properties:
23119
+ object:
23120
+ type: string
23121
+ title: Object type
23122
+ description: Will always be List.
23123
+ has_more:
23124
+ type: boolean
23125
+ description: Indicates there are more results on subsequent pages.
23126
+ next:
23127
+ type: string
23128
+ description: Path to subsequent page of results.
23129
+ data:
23130
+ type: array
23131
+ items:
23132
+ "$ref": "#/components/schemas/ExternalInvoice"
23133
+ ExternalCharge:
23134
+ type: object
23135
+ description: Charge from an external resource such as Apple App Store or Google
23136
+ Play Store.
23137
+ properties:
23138
+ id:
23139
+ type: string
23140
+ title: External invoice ID
23141
+ description: System-generated unique identifier for an external charge ID,
23142
+ e.g. `e28zov4fw0v2`.
23143
+ object:
23144
+ type: string
23145
+ title: Object type
23146
+ account:
23147
+ "$ref": "#/components/schemas/AccountMini"
23148
+ currency:
23149
+ type: string
23150
+ title: Currency
23151
+ description: 3-letter ISO 4217 currency code.
23152
+ unit_amount:
23153
+ type: number
23154
+ format: float
23155
+ title: Unit Amount
23156
+ quantity:
23157
+ type: integer
23158
+ description:
23159
+ type: string
23160
+ external_product_reference:
23161
+ "$ref": "#/components/schemas/ExternalProductReferenceMini"
23162
+ created_at:
23163
+ type: string
23164
+ format: date-time
23165
+ title: Created at
23166
+ description: When the external charge was created in Recurly.
23167
+ updated_at:
23168
+ type: string
23169
+ format: date-time
23170
+ title: Updated at
23171
+ description: When the external charge was updated in Recurly.
22932
23172
  CustomerPermission:
22933
23173
  type: object
22934
23174
  properties:
@@ -23673,6 +23913,7 @@ components:
23673
23913
  - api_only
23674
23914
  - read_only
23675
23915
  - write
23916
+ - set_only
23676
23917
  PricingModelTypeEnum:
23677
23918
  type: string
23678
23919
  enum:
@@ -24286,3 +24527,7 @@ components:
24286
24527
  enum:
24287
24528
  - ideal
24288
24529
  - sofort
24530
+ ExternalInvoiceStateEnum:
24531
+ type: string
24532
+ enum:
24533
+ - paid
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.29.0
4
+ version: 4.31.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-02-07 00:00:00.000000000 Z
11
+ date: 2023-03-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -256,9 +256,10 @@ files:
256
256
  - lib/recurly/resources/export_dates.rb
257
257
  - lib/recurly/resources/export_file.rb
258
258
  - lib/recurly/resources/export_files.rb
259
+ - lib/recurly/resources/external_charge.rb
260
+ - lib/recurly/resources/external_invoice.rb
259
261
  - lib/recurly/resources/external_product.rb
260
262
  - lib/recurly/resources/external_product_reference_mini.rb
261
- - lib/recurly/resources/external_resource_mini.rb
262
263
  - lib/recurly/resources/external_subscription.rb
263
264
  - lib/recurly/resources/fraud_info.rb
264
265
  - lib/recurly/resources/gift_card.rb
@@ -332,7 +333,7 @@ metadata:
332
333
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
333
334
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
334
335
  homepage_uri: https://github.com/recurly/recurly-client-ruby
335
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.29.0
336
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.31.0
336
337
  post_install_message:
337
338
  rdoc_options: []
338
339
  require_paths:
@@ -1,22 +0,0 @@
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 ExternalResourceMini < Resource
8
-
9
- # @!attribute external_object_reference
10
- # @return [String] Identifier or URL reference where the resource is canonically available in the external platform.
11
- define_attribute :external_object_reference, String
12
-
13
- # @!attribute id
14
- # @return [String] System-generated unique identifier for an external resource ID, e.g. `e28zov4fw0v2`.
15
- define_attribute :id, String
16
-
17
- # @!attribute object
18
- # @return [String] Object type
19
- define_attribute :object, String
20
- end
21
- end
22
- end