xero-ruby 2.8.1 → 2.8.2

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: eec58bb28471c43b81d1bed37d1201cab4f323a15c16eef399c36f3d17b83c2f
4
- data.tar.gz: ca0c2bcacb4cf2bdff3b21dd8942ff3fef968ce9dfa1aba7055409dd5b06125e
3
+ metadata.gz: 91ccbdaae622f0b53bfdc151848a3d007715f908a40011a43fee02b4b4fc5e94
4
+ data.tar.gz: b33bdd7f93264219a7cc1f7f3b3395e9977a537c73b7735cec432ad7cae89de6
5
5
  SHA512:
6
- metadata.gz: 9d647375ed88c3154a5bdcb1156c5da25ef1dd47c1d2d1485bfa4dd5326264d2d6d2e6cbaf11c98c7bfdc05aeec5a0acd3409a9c655ae8c1a6ea460320aa7123
7
- data.tar.gz: 5bcef855ca40c2175d801820a0ae17920382db45033a774959e05a080ede1ff4769ad129e8b5dcda0f3ae7c95fa03a9e86c09c2b6012bba1e0745002fe79f92f
6
+ metadata.gz: 706da5b8834ea82840406d239472ad87f3b7b7ac6168f08e93ce9f2fea2f66b4a3ff473f74172fead3465b91113c99867bd1c5ca5da16159a284e11abdae26c7
7
+ data.tar.gz: 249d873213e1e2cfec1d015ca0c112d9893a281ee71593f5cc6ebdda5e951dfe5ff9e742bd666d8f3a9b63b881347180db9e2e01e3ef22b2edcca7deff427c47
data/README.md CHANGED
@@ -6,19 +6,17 @@ Xero Ruby SDK for OAuth 2.0 generated from [Xero API OpenAPI Spec](https://githu
6
6
  # Documentation
7
7
  Xero Ruby SDK supports Xero's OAuth2.0 authentication and the following Xero API sets.
8
8
 
9
- ## API Client Docs
10
-
11
- * Core [Accounting Api Docs](https://xeroapi.github.io/xero-ruby/accounting/index.html)
9
+ ## SDK Documentation
10
+ * [API client methods](https://xeroapi.github.io/xero-ruby/accounting/index.html)
12
11
  ---
13
- * [Asset Api Docs](/docs/assets/AssetApi.md)
14
- * [Project Api Docs](docs/projects/ProjectApi.md)
15
- * [Files Api Docs](docs/files/FileApi.md)
16
- * [Payroll Docs (AU)](docs/payroll_au/PayrollAuApi.md)
17
- * [Payroll Docs (NZ)](docs/payroll_nz/PayrollNzApi.md)
18
- * [Payroll Docs (UK)](docs/payroll_uk/PayrollUkApi.md)
19
-
20
12
  ## API Model Docs
21
- * [XeroRuby Models Docs](/docs/)
13
+ * [Accounting Models](/docs/accounting)
14
+ * [Asset Api Docs](/docs/assets/)
15
+ * [Project Api Docs](docs/projects/)
16
+ * [Files Api Docs](docs/files/)
17
+ * [Payroll Docs (AU)](docs/payroll_au/)
18
+ * [Payroll Docs (NZ)](docs/payroll_nz/)
19
+ * [Payroll Docs (UK)](docs/payroll_uk/)
22
20
 
23
21
  ## Sample Apps
24
22
  We have two apps showing SDK usage.
@@ -183,7 +183,7 @@ module XeroRuby
183
183
  # Creates an attachment for a specific bank transaction by filename
184
184
  # @param xero_tenant_id [String] Xero identifier for Tenant
185
185
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
186
- # @param file_name [String] The name of the file being attached
186
+ # @param file_name [String] Name of the attachment
187
187
  # @param body [String] Byte array of file in body of request
188
188
  # @param [Hash] opts the optional parameters
189
189
  # @return [Attachments]
@@ -195,7 +195,7 @@ module XeroRuby
195
195
  # Creates an attachment for a specific bank transaction by filename
196
196
  # @param xero_tenant_id [String] Xero identifier for Tenant
197
197
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
198
- # @param file_name [String] The name of the file being attached
198
+ # @param file_name [String] Name of the attachment
199
199
  # @param body [String] Byte array of file in body of request
200
200
  # @param [Hash] opts the optional parameters
201
201
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -510,7 +510,7 @@ module XeroRuby
510
510
 
511
511
  # @param xero_tenant_id [String] Xero identifier for Tenant
512
512
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
513
- # @param file_name [String] The name of the file being attached to a Bank Transfer
513
+ # @param file_name [String] Name of the attachment
514
514
  # @param body [String] Byte array of file in body of request
515
515
  # @param [Hash] opts the optional parameters
516
516
  # @return [Attachments]
@@ -521,7 +521,7 @@ module XeroRuby
521
521
 
522
522
  # @param xero_tenant_id [String] Xero identifier for Tenant
523
523
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
524
- # @param file_name [String] The name of the file being attached to a Bank Transfer
524
+ # @param file_name [String] Name of the attachment
525
525
  # @param body [String] Byte array of file in body of request
526
526
  # @param [Hash] opts the optional parameters
527
527
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -921,7 +921,7 @@ module XeroRuby
921
921
 
922
922
  # @param xero_tenant_id [String] Xero identifier for Tenant
923
923
  # @param contact_id [String] Unique identifier for a Contact
924
- # @param file_name [String] Name for the file you are attaching
924
+ # @param file_name [String] Name of the attachment
925
925
  # @param body [String] Byte array of file in body of request
926
926
  # @param [Hash] opts the optional parameters
927
927
  # @return [Attachments]
@@ -932,7 +932,7 @@ module XeroRuby
932
932
 
933
933
  # @param xero_tenant_id [String] Xero identifier for Tenant
934
934
  # @param contact_id [String] Unique identifier for a Contact
935
- # @param file_name [String] Name for the file you are attaching
935
+ # @param file_name [String] Name of the attachment
936
936
  # @param body [String] Byte array of file in body of request
937
937
  # @param [Hash] opts the optional parameters
938
938
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -1412,7 +1412,7 @@ module XeroRuby
1412
1412
  # Creates an attachment for a specific credit note
1413
1413
  # @param xero_tenant_id [String] Xero identifier for Tenant
1414
1414
  # @param credit_note_id [String] Unique identifier for a Credit Note
1415
- # @param file_name [String] Name of the file you are attaching to Credit Note
1415
+ # @param file_name [String] Name of the attachment
1416
1416
  # @param body [String] Byte array of file in body of request
1417
1417
  # @param [Hash] opts the optional parameters
1418
1418
  # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice (default to false)
@@ -1425,7 +1425,7 @@ module XeroRuby
1425
1425
  # Creates an attachment for a specific credit note
1426
1426
  # @param xero_tenant_id [String] Xero identifier for Tenant
1427
1427
  # @param credit_note_id [String] Unique identifier for a Credit Note
1428
- # @param file_name [String] Name of the file you are attaching to Credit Note
1428
+ # @param file_name [String] Name of the attachment
1429
1429
  # @param body [String] Byte array of file in body of request
1430
1430
  # @param [Hash] opts the optional parameters
1431
1431
  # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice
@@ -1980,7 +1980,7 @@ module XeroRuby
1980
1980
  # Creates an attachment for a specific invoice or purchase bill by filename
1981
1981
  # @param xero_tenant_id [String] Xero identifier for Tenant
1982
1982
  # @param invoice_id [String] Unique identifier for an Invoice
1983
- # @param file_name [String] Name of the file you are attaching
1983
+ # @param file_name [String] Name of the attachment
1984
1984
  # @param body [String] Byte array of file in body of request
1985
1985
  # @param [Hash] opts the optional parameters
1986
1986
  # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice (default to false)
@@ -1993,7 +1993,7 @@ module XeroRuby
1993
1993
  # Creates an attachment for a specific invoice or purchase bill by filename
1994
1994
  # @param xero_tenant_id [String] Xero identifier for Tenant
1995
1995
  # @param invoice_id [String] Unique identifier for an Invoice
1996
- # @param file_name [String] Name of the file you are attaching
1996
+ # @param file_name [String] Name of the attachment
1997
1997
  # @param body [String] Byte array of file in body of request
1998
1998
  # @param [Hash] opts the optional parameters
1999
1999
  # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice
@@ -2475,7 +2475,7 @@ module XeroRuby
2475
2475
  # Creates a specific attachment for a specific manual journal by file name
2476
2476
  # @param xero_tenant_id [String] Xero identifier for Tenant
2477
2477
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
2478
- # @param file_name [String] The name of the file being attached to a ManualJournal
2478
+ # @param file_name [String] Name of the attachment
2479
2479
  # @param body [String] Byte array of file in body of request
2480
2480
  # @param [Hash] opts the optional parameters
2481
2481
  # @return [Attachments]
@@ -2487,7 +2487,7 @@ module XeroRuby
2487
2487
  # Creates a specific attachment for a specific manual journal by file name
2488
2488
  # @param xero_tenant_id [String] Xero identifier for Tenant
2489
2489
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
2490
- # @param file_name [String] The name of the file being attached to a ManualJournal
2490
+ # @param file_name [String] Name of the attachment
2491
2491
  # @param body [String] Byte array of file in body of request
2492
2492
  # @param [Hash] opts the optional parameters
2493
2493
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -2562,7 +2562,7 @@ module XeroRuby
2562
2562
 
2563
2563
  # Creates a history record for a specific manual journal
2564
2564
  # @param xero_tenant_id [String] Xero identifier for Tenant
2565
- # @param manual_journal_id [String] Xero generated unique identifier for a manual journal
2565
+ # @param manual_journal_id [String] Unique identifier for a ManualJournal
2566
2566
  # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
2567
2567
  # @param [Hash] opts the optional parameters
2568
2568
  # @return [HistoryRecords]
@@ -2573,7 +2573,7 @@ module XeroRuby
2573
2573
 
2574
2574
  # Creates a history record for a specific manual journal
2575
2575
  # @param xero_tenant_id [String] Xero identifier for Tenant
2576
- # @param manual_journal_id [String] Xero generated unique identifier for a manual journal
2576
+ # @param manual_journal_id [String] Unique identifier for a ManualJournal
2577
2577
  # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
2578
2578
  # @param [Hash] opts the optional parameters
2579
2579
  # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers
@@ -3203,7 +3203,7 @@ module XeroRuby
3203
3203
 
3204
3204
  # Allows you to create an Allocation for prepayments
3205
3205
  # @param xero_tenant_id [String] Xero identifier for Tenant
3206
- # @param prepayment_id [String] Unique identifier for Prepayment
3206
+ # @param prepayment_id [String] Unique identifier for a PrePayment
3207
3207
  # @param allocations [Allocations] Allocations with an array of Allocation object in body of request
3208
3208
  # @param [Hash] opts the optional parameters
3209
3209
  # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false)
@@ -3215,7 +3215,7 @@ module XeroRuby
3215
3215
 
3216
3216
  # Allows you to create an Allocation for prepayments
3217
3217
  # @param xero_tenant_id [String] Xero identifier for Tenant
3218
- # @param prepayment_id [String] Unique identifier for Prepayment
3218
+ # @param prepayment_id [String] Unique identifier for a PrePayment
3219
3219
  # @param allocations [Allocations] Allocations with an array of Allocation object in body of request
3220
3220
  # @param [Hash] opts the optional parameters
3221
3221
  # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors
@@ -3370,7 +3370,7 @@ module XeroRuby
3370
3370
 
3371
3371
  # Creates attachment for a specific purchase order
3372
3372
  # @param xero_tenant_id [String] Xero identifier for Tenant
3373
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
3373
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
3374
3374
  # @param file_name [String] Name of the attachment
3375
3375
  # @param body [String] Byte array of file in body of request
3376
3376
  # @param [Hash] opts the optional parameters
@@ -3382,7 +3382,7 @@ module XeroRuby
3382
3382
 
3383
3383
  # Creates attachment for a specific purchase order
3384
3384
  # @param xero_tenant_id [String] Xero identifier for Tenant
3385
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
3385
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
3386
3386
  # @param file_name [String] Name of the attachment
3387
3387
  # @param body [String] Byte array of file in body of request
3388
3388
  # @param [Hash] opts the optional parameters
@@ -3458,7 +3458,7 @@ module XeroRuby
3458
3458
 
3459
3459
  # Creates a history record for a specific purchase orders
3460
3460
  # @param xero_tenant_id [String] Xero identifier for Tenant
3461
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
3461
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
3462
3462
  # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
3463
3463
  # @param [Hash] opts the optional parameters
3464
3464
  # @return [HistoryRecords]
@@ -3469,7 +3469,7 @@ module XeroRuby
3469
3469
 
3470
3470
  # Creates a history record for a specific purchase orders
3471
3471
  # @param xero_tenant_id [String] Xero identifier for Tenant
3472
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
3472
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
3473
3473
  # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
3474
3474
  # @param [Hash] opts the optional parameters
3475
3475
  # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers
@@ -3619,7 +3619,7 @@ module XeroRuby
3619
3619
 
3620
3620
  # Creates attachment for a specific quote
3621
3621
  # @param xero_tenant_id [String] Xero identifier for Tenant
3622
- # @param quote_id [String] Unique identifier for Quote object
3622
+ # @param quote_id [String] Unique identifier for an Quote
3623
3623
  # @param file_name [String] Name of the attachment
3624
3624
  # @param body [String] Byte array of file in body of request
3625
3625
  # @param [Hash] opts the optional parameters
@@ -3631,7 +3631,7 @@ module XeroRuby
3631
3631
 
3632
3632
  # Creates attachment for a specific quote
3633
3633
  # @param xero_tenant_id [String] Xero identifier for Tenant
3634
- # @param quote_id [String] Unique identifier for Quote object
3634
+ # @param quote_id [String] Unique identifier for an Quote
3635
3635
  # @param file_name [String] Name of the attachment
3636
3636
  # @param body [String] Byte array of file in body of request
3637
3637
  # @param [Hash] opts the optional parameters
@@ -3948,7 +3948,7 @@ module XeroRuby
3948
3948
  # Creates an attachment on a specific expense claim receipts by file name
3949
3949
  # @param xero_tenant_id [String] Xero identifier for Tenant
3950
3950
  # @param receipt_id [String] Unique identifier for a Receipt
3951
- # @param file_name [String] The name of the file being attached to the Receipt
3951
+ # @param file_name [String] Name of the attachment
3952
3952
  # @param body [String] Byte array of file in body of request
3953
3953
  # @param [Hash] opts the optional parameters
3954
3954
  # @return [Attachments]
@@ -3960,7 +3960,7 @@ module XeroRuby
3960
3960
  # Creates an attachment on a specific expense claim receipts by file name
3961
3961
  # @param xero_tenant_id [String] Xero identifier for Tenant
3962
3962
  # @param receipt_id [String] Unique identifier for a Receipt
3963
- # @param file_name [String] The name of the file being attached to the Receipt
3963
+ # @param file_name [String] Name of the attachment
3964
3964
  # @param body [String] Byte array of file in body of request
3965
3965
  # @param [Hash] opts the optional parameters
3966
3966
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -4118,7 +4118,7 @@ module XeroRuby
4118
4118
  # Creates an attachment from a specific repeating invoices by file name
4119
4119
  # @param xero_tenant_id [String] Xero identifier for Tenant
4120
4120
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
4121
- # @param file_name [String] The name of the file being attached to a Repeating Invoice
4121
+ # @param file_name [String] Name of the attachment
4122
4122
  # @param body [String] Byte array of file in body of request
4123
4123
  # @param [Hash] opts the optional parameters
4124
4124
  # @return [Attachments]
@@ -4130,7 +4130,7 @@ module XeroRuby
4130
4130
  # Creates an attachment from a specific repeating invoices by file name
4131
4131
  # @param xero_tenant_id [String] Xero identifier for Tenant
4132
4132
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
4133
- # @param file_name [String] The name of the file being attached to a Repeating Invoice
4133
+ # @param file_name [String] Name of the attachment
4134
4134
  # @param body [String] Byte array of file in body of request
4135
4135
  # @param [Hash] opts the optional parameters
4136
4136
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -4521,7 +4521,7 @@ module XeroRuby
4521
4521
 
4522
4522
  # Deletes a chart of accounts
4523
4523
  # @param xero_tenant_id [String] Xero identifier for Tenant
4524
- # @param account_id [String] Unique identifier for retrieving single object
4524
+ # @param account_id [String] Unique identifier for Account object
4525
4525
  # @param [Hash] opts the optional parameters
4526
4526
  # @return [Accounts]
4527
4527
  def delete_account(xero_tenant_id, account_id, opts = {})
@@ -4531,7 +4531,7 @@ module XeroRuby
4531
4531
 
4532
4532
  # Deletes a chart of accounts
4533
4533
  # @param xero_tenant_id [String] Xero identifier for Tenant
4534
- # @param account_id [String] Unique identifier for retrieving single object
4534
+ # @param account_id [String] Unique identifier for Account object
4535
4535
  # @param [Hash] opts the optional parameters
4536
4536
  # @return [Array<(Accounts, Integer, Hash)>] Accounts data, response status code and response headers
4537
4537
  def delete_account_with_http_info(xero_tenant_id, account_id, opts = {})
@@ -5213,7 +5213,7 @@ module XeroRuby
5213
5213
 
5214
5214
  # Retrieves a single chart of accounts by using a unique account Id
5215
5215
  # @param xero_tenant_id [String] Xero identifier for Tenant
5216
- # @param account_id [String] Unique identifier for retrieving single object
5216
+ # @param account_id [String] Unique identifier for Account object
5217
5217
  # @param [Hash] opts the optional parameters
5218
5218
  # @return [Accounts]
5219
5219
  def get_account(xero_tenant_id, account_id, opts = {})
@@ -5223,7 +5223,7 @@ module XeroRuby
5223
5223
 
5224
5224
  # Retrieves a single chart of accounts by using a unique account Id
5225
5225
  # @param xero_tenant_id [String] Xero identifier for Tenant
5226
- # @param account_id [String] Unique identifier for retrieving single object
5226
+ # @param account_id [String] Unique identifier for Account object
5227
5227
  # @param [Hash] opts the optional parameters
5228
5228
  # @return [Array<(Accounts, Integer, Hash)>] Accounts data, response status code and response headers
5229
5229
  def get_account_with_http_info(xero_tenant_id, account_id, opts = {})
@@ -5690,7 +5690,7 @@ module XeroRuby
5690
5690
  # Retrieves a specific attachment from a specific bank transaction by filename
5691
5691
  # @param xero_tenant_id [String] Xero identifier for Tenant
5692
5692
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
5693
- # @param file_name [String] The name of the file being attached
5693
+ # @param file_name [String] Name of the attachment
5694
5694
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
5695
5695
  # @param [Hash] opts the optional parameters
5696
5696
  # @return [File]
@@ -5702,7 +5702,7 @@ module XeroRuby
5702
5702
  # Retrieves a specific attachment from a specific bank transaction by filename
5703
5703
  # @param xero_tenant_id [String] Xero identifier for Tenant
5704
5704
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
5705
- # @param file_name [String] The name of the file being attached
5705
+ # @param file_name [String] Name of the attachment
5706
5706
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
5707
5707
  # @param [Hash] opts the optional parameters
5708
5708
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -5777,7 +5777,7 @@ module XeroRuby
5777
5777
  # Retrieves specific attachments from a specific BankTransaction using a unique attachment Id
5778
5778
  # @param xero_tenant_id [String] Xero identifier for Tenant
5779
5779
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
5780
- # @param attachment_id [String] Xero generated unique identifier for an attachment
5780
+ # @param attachment_id [String] Unique identifier for Attachment object
5781
5781
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
5782
5782
  # @param [Hash] opts the optional parameters
5783
5783
  # @return [File]
@@ -5789,7 +5789,7 @@ module XeroRuby
5789
5789
  # Retrieves specific attachments from a specific BankTransaction using a unique attachment Id
5790
5790
  # @param xero_tenant_id [String] Xero identifier for Tenant
5791
5791
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
5792
- # @param attachment_id [String] Xero generated unique identifier for an attachment
5792
+ # @param attachment_id [String] Unique identifier for Attachment object
5793
5793
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
5794
5794
  # @param [Hash] opts the optional parameters
5795
5795
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -6169,7 +6169,7 @@ module XeroRuby
6169
6169
  # Retrieves a specific attachment on a specific bank transfer by file name
6170
6170
  # @param xero_tenant_id [String] Xero identifier for Tenant
6171
6171
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
6172
- # @param file_name [String] The name of the file being attached to a Bank Transfer
6172
+ # @param file_name [String] Name of the attachment
6173
6173
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
6174
6174
  # @param [Hash] opts the optional parameters
6175
6175
  # @return [File]
@@ -6181,7 +6181,7 @@ module XeroRuby
6181
6181
  # Retrieves a specific attachment on a specific bank transfer by file name
6182
6182
  # @param xero_tenant_id [String] Xero identifier for Tenant
6183
6183
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
6184
- # @param file_name [String] The name of the file being attached to a Bank Transfer
6184
+ # @param file_name [String] Name of the attachment
6185
6185
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
6186
6186
  # @param [Hash] opts the optional parameters
6187
6187
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -6256,7 +6256,7 @@ module XeroRuby
6256
6256
  # Retrieves a specific attachment from a specific bank transfer using a unique attachment ID
6257
6257
  # @param xero_tenant_id [String] Xero identifier for Tenant
6258
6258
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
6259
- # @param attachment_id [String] Xero generated unique identifier for an Attachment to a bank transfer
6259
+ # @param attachment_id [String] Unique identifier for Attachment object
6260
6260
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
6261
6261
  # @param [Hash] opts the optional parameters
6262
6262
  # @return [File]
@@ -6268,7 +6268,7 @@ module XeroRuby
6268
6268
  # Retrieves a specific attachment from a specific bank transfer using a unique attachment ID
6269
6269
  # @param xero_tenant_id [String] Xero identifier for Tenant
6270
6270
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
6271
- # @param attachment_id [String] Xero generated unique identifier for an Attachment to a bank transfer
6271
+ # @param attachment_id [String] Unique identifier for Attachment object
6272
6272
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
6273
6273
  # @param [Hash] opts the optional parameters
6274
6274
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -7009,7 +7009,7 @@ module XeroRuby
7009
7009
  # Retrieves a specific attachment from a specific contact by file name
7010
7010
  # @param xero_tenant_id [String] Xero identifier for Tenant
7011
7011
  # @param contact_id [String] Unique identifier for a Contact
7012
- # @param file_name [String] Name for the file you are attaching
7012
+ # @param file_name [String] Name of the attachment
7013
7013
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7014
7014
  # @param [Hash] opts the optional parameters
7015
7015
  # @return [File]
@@ -7021,7 +7021,7 @@ module XeroRuby
7021
7021
  # Retrieves a specific attachment from a specific contact by file name
7022
7022
  # @param xero_tenant_id [String] Xero identifier for Tenant
7023
7023
  # @param contact_id [String] Unique identifier for a Contact
7024
- # @param file_name [String] Name for the file you are attaching
7024
+ # @param file_name [String] Name of the attachment
7025
7025
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7026
7026
  # @param [Hash] opts the optional parameters
7027
7027
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -7096,7 +7096,7 @@ module XeroRuby
7096
7096
  # Retrieves a specific attachment from a specific contact using a unique attachment Id
7097
7097
  # @param xero_tenant_id [String] Xero identifier for Tenant
7098
7098
  # @param contact_id [String] Unique identifier for a Contact
7099
- # @param attachment_id [String] Unique identifier for a Attachment
7099
+ # @param attachment_id [String] Unique identifier for Attachment object
7100
7100
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7101
7101
  # @param [Hash] opts the optional parameters
7102
7102
  # @return [File]
@@ -7108,7 +7108,7 @@ module XeroRuby
7108
7108
  # Retrieves a specific attachment from a specific contact using a unique attachment Id
7109
7109
  # @param xero_tenant_id [String] Xero identifier for Tenant
7110
7110
  # @param contact_id [String] Unique identifier for a Contact
7111
- # @param attachment_id [String] Unique identifier for a Attachment
7111
+ # @param attachment_id [String] Unique identifier for Attachment object
7112
7112
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7113
7113
  # @param [Hash] opts the optional parameters
7114
7114
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -7864,7 +7864,7 @@ module XeroRuby
7864
7864
  # Retrieves a specific attachment on a specific credit note by file name
7865
7865
  # @param xero_tenant_id [String] Xero identifier for Tenant
7866
7866
  # @param credit_note_id [String] Unique identifier for a Credit Note
7867
- # @param file_name [String] Name of the file you are attaching to Credit Note
7867
+ # @param file_name [String] Name of the attachment
7868
7868
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7869
7869
  # @param [Hash] opts the optional parameters
7870
7870
  # @return [File]
@@ -7876,7 +7876,7 @@ module XeroRuby
7876
7876
  # Retrieves a specific attachment on a specific credit note by file name
7877
7877
  # @param xero_tenant_id [String] Xero identifier for Tenant
7878
7878
  # @param credit_note_id [String] Unique identifier for a Credit Note
7879
- # @param file_name [String] Name of the file you are attaching to Credit Note
7879
+ # @param file_name [String] Name of the attachment
7880
7880
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7881
7881
  # @param [Hash] opts the optional parameters
7882
7882
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -7951,7 +7951,7 @@ module XeroRuby
7951
7951
  # Retrieves a specific attachment from a specific credit note using a unique attachment Id
7952
7952
  # @param xero_tenant_id [String] Xero identifier for Tenant
7953
7953
  # @param credit_note_id [String] Unique identifier for a Credit Note
7954
- # @param attachment_id [String] Unique identifier for a Attachment
7954
+ # @param attachment_id [String] Unique identifier for Attachment object
7955
7955
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7956
7956
  # @param [Hash] opts the optional parameters
7957
7957
  # @return [File]
@@ -7963,7 +7963,7 @@ module XeroRuby
7963
7963
  # Retrieves a specific attachment from a specific credit note using a unique attachment Id
7964
7964
  # @param xero_tenant_id [String] Xero identifier for Tenant
7965
7965
  # @param credit_note_id [String] Unique identifier for a Credit Note
7966
- # @param attachment_id [String] Unique identifier for a Attachment
7966
+ # @param attachment_id [String] Unique identifier for Attachment object
7967
7967
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
7968
7968
  # @param [Hash] opts the optional parameters
7969
7969
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -8870,7 +8870,7 @@ module XeroRuby
8870
8870
  # Retrieves an attachment from a specific invoice or purchase bill by filename
8871
8871
  # @param xero_tenant_id [String] Xero identifier for Tenant
8872
8872
  # @param invoice_id [String] Unique identifier for an Invoice
8873
- # @param file_name [String] Name of the file you are attaching
8873
+ # @param file_name [String] Name of the attachment
8874
8874
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
8875
8875
  # @param [Hash] opts the optional parameters
8876
8876
  # @return [File]
@@ -8882,7 +8882,7 @@ module XeroRuby
8882
8882
  # Retrieves an attachment from a specific invoice or purchase bill by filename
8883
8883
  # @param xero_tenant_id [String] Xero identifier for Tenant
8884
8884
  # @param invoice_id [String] Unique identifier for an Invoice
8885
- # @param file_name [String] Name of the file you are attaching
8885
+ # @param file_name [String] Name of the attachment
8886
8886
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
8887
8887
  # @param [Hash] opts the optional parameters
8888
8888
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -8957,7 +8957,7 @@ module XeroRuby
8957
8957
  # Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
8958
8958
  # @param xero_tenant_id [String] Xero identifier for Tenant
8959
8959
  # @param invoice_id [String] Unique identifier for an Invoice
8960
- # @param attachment_id [String] Unique identifier for an Attachment
8960
+ # @param attachment_id [String] Unique identifier for Attachment object
8961
8961
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
8962
8962
  # @param [Hash] opts the optional parameters
8963
8963
  # @return [File]
@@ -8969,7 +8969,7 @@ module XeroRuby
8969
8969
  # Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
8970
8970
  # @param xero_tenant_id [String] Xero identifier for Tenant
8971
8971
  # @param invoice_id [String] Unique identifier for an Invoice
8972
- # @param attachment_id [String] Unique identifier for an Attachment
8972
+ # @param attachment_id [String] Unique identifier for Attachment object
8973
8973
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
8974
8974
  # @param [Hash] opts the optional parameters
8975
8975
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -9268,7 +9268,7 @@ module XeroRuby
9268
9268
  # @option opts [Array<String>] :contact_i_ds Filter by a comma-separated list of ContactIDs.
9269
9269
  # @option opts [Array<String>] :statuses Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
9270
9270
  # @option opts [Integer] :page e.g. page&#x3D;1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
9271
- # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
9271
+ # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Invoices with a status of ARCHIVED will be included in the response
9272
9272
  # @option opts [Boolean] :created_by_my_app When set to true you&#39;ll only retrieve Invoices created by your app
9273
9273
  # @option opts [Integer] :unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
9274
9274
  # @return [Invoices]
@@ -9288,7 +9288,7 @@ module XeroRuby
9288
9288
  # @option opts [Array<String>] :contact_i_ds Filter by a comma-separated list of ContactIDs.
9289
9289
  # @option opts [Array<String>] :statuses Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
9290
9290
  # @option opts [Integer] :page e.g. page&#x3D;1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
9291
- # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
9291
+ # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Invoices with a status of ARCHIVED will be included in the response
9292
9292
  # @option opts [Boolean] :created_by_my_app When set to true you&#39;ll only retrieve Invoices created by your app
9293
9293
  # @option opts [Integer] :unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
9294
9294
  # @return [Array<(Invoices, Integer, Hash)>] Invoices data, response status code and response headers
@@ -9977,7 +9977,7 @@ module XeroRuby
9977
9977
  # Retrieves a specific attachment from a specific manual journal by file name
9978
9978
  # @param xero_tenant_id [String] Xero identifier for Tenant
9979
9979
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
9980
- # @param file_name [String] The name of the file being attached to a ManualJournal
9980
+ # @param file_name [String] Name of the attachment
9981
9981
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
9982
9982
  # @param [Hash] opts the optional parameters
9983
9983
  # @return [File]
@@ -9989,7 +9989,7 @@ module XeroRuby
9989
9989
  # Retrieves a specific attachment from a specific manual journal by file name
9990
9990
  # @param xero_tenant_id [String] Xero identifier for Tenant
9991
9991
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
9992
- # @param file_name [String] The name of the file being attached to a ManualJournal
9992
+ # @param file_name [String] Name of the attachment
9993
9993
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
9994
9994
  # @param [Hash] opts the optional parameters
9995
9995
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -10064,7 +10064,7 @@ module XeroRuby
10064
10064
  # Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
10065
10065
  # @param xero_tenant_id [String] Xero identifier for Tenant
10066
10066
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
10067
- # @param attachment_id [String] Unique identifier for a Attachment
10067
+ # @param attachment_id [String] Unique identifier for Attachment object
10068
10068
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
10069
10069
  # @param [Hash] opts the optional parameters
10070
10070
  # @return [File]
@@ -10076,7 +10076,7 @@ module XeroRuby
10076
10076
  # Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
10077
10077
  # @param xero_tenant_id [String] Xero identifier for Tenant
10078
10078
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
10079
- # @param attachment_id [String] Unique identifier for a Attachment
10079
+ # @param attachment_id [String] Unique identifier for Attachment object
10080
10080
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
10081
10081
  # @param [Hash] opts the optional parameters
10082
10082
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -10304,7 +10304,7 @@ module XeroRuby
10304
10304
 
10305
10305
  # Retrieves history for a specific manual journal
10306
10306
  # @param xero_tenant_id [String] Xero identifier for Tenant
10307
- # @param manual_journal_id [String] Xero generated unique identifier for a manual journal
10307
+ # @param manual_journal_id [String] Unique identifier for a ManualJournal
10308
10308
  # @param [Hash] opts the optional parameters
10309
10309
  # @return [HistoryRecords]
10310
10310
  def get_manual_journals_history(xero_tenant_id, manual_journal_id, opts = {})
@@ -10314,7 +10314,7 @@ module XeroRuby
10314
10314
 
10315
10315
  # Retrieves history for a specific manual journal
10316
10316
  # @param xero_tenant_id [String] Xero identifier for Tenant
10317
- # @param manual_journal_id [String] Xero generated unique identifier for a manual journal
10317
+ # @param manual_journal_id [String] Unique identifier for a ManualJournal
10318
10318
  # @param [Hash] opts the optional parameters
10319
10319
  # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers
10320
10320
  def get_manual_journals_history_with_http_info(xero_tenant_id, manual_journal_id, opts = {})
@@ -11420,7 +11420,7 @@ module XeroRuby
11420
11420
 
11421
11421
  # Retrieves a specific purchase order using a unique purchase order Id
11422
11422
  # @param xero_tenant_id [String] Xero identifier for Tenant
11423
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
11423
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11424
11424
  # @param [Hash] opts the optional parameters
11425
11425
  # @return [PurchaseOrders]
11426
11426
  def get_purchase_order(xero_tenant_id, purchase_order_id, opts = {})
@@ -11430,7 +11430,7 @@ module XeroRuby
11430
11430
 
11431
11431
  # Retrieves a specific purchase order using a unique purchase order Id
11432
11432
  # @param xero_tenant_id [String] Xero identifier for Tenant
11433
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
11433
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11434
11434
  # @param [Hash] opts the optional parameters
11435
11435
  # @return [Array<(PurchaseOrders, Integer, Hash)>] PurchaseOrders data, response status code and response headers
11436
11436
  def get_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, opts = {})
@@ -11568,7 +11568,7 @@ module XeroRuby
11568
11568
 
11569
11569
  # Retrieves a specific attachment for a specific purchase order by filename
11570
11570
  # @param xero_tenant_id [String] Xero identifier for Tenant
11571
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
11571
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11572
11572
  # @param file_name [String] Name of the attachment
11573
11573
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
11574
11574
  # @param [Hash] opts the optional parameters
@@ -11580,7 +11580,7 @@ module XeroRuby
11580
11580
 
11581
11581
  # Retrieves a specific attachment for a specific purchase order by filename
11582
11582
  # @param xero_tenant_id [String] Xero identifier for Tenant
11583
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
11583
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11584
11584
  # @param file_name [String] Name of the attachment
11585
11585
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
11586
11586
  # @param [Hash] opts the optional parameters
@@ -11655,7 +11655,7 @@ module XeroRuby
11655
11655
 
11656
11656
  # Retrieves specific attachment for a specific purchase order using a unique attachment Id
11657
11657
  # @param xero_tenant_id [String] Xero identifier for Tenant
11658
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
11658
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11659
11659
  # @param attachment_id [String] Unique identifier for Attachment object
11660
11660
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
11661
11661
  # @param [Hash] opts the optional parameters
@@ -11667,7 +11667,7 @@ module XeroRuby
11667
11667
 
11668
11668
  # Retrieves specific attachment for a specific purchase order using a unique attachment Id
11669
11669
  # @param xero_tenant_id [String] Xero identifier for Tenant
11670
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
11670
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11671
11671
  # @param attachment_id [String] Unique identifier for Attachment object
11672
11672
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
11673
11673
  # @param [Hash] opts the optional parameters
@@ -11742,7 +11742,7 @@ module XeroRuby
11742
11742
 
11743
11743
  # Retrieves attachments for a specific purchase order
11744
11744
  # @param xero_tenant_id [String] Xero identifier for Tenant
11745
- # @param purchase_order_id [String] Unique identifier for Purchase Orders object
11745
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11746
11746
  # @param [Hash] opts the optional parameters
11747
11747
  # @return [Attachments]
11748
11748
  def get_purchase_order_attachments(xero_tenant_id, purchase_order_id, opts = {})
@@ -11752,7 +11752,7 @@ module XeroRuby
11752
11752
 
11753
11753
  # Retrieves attachments for a specific purchase order
11754
11754
  # @param xero_tenant_id [String] Xero identifier for Tenant
11755
- # @param purchase_order_id [String] Unique identifier for Purchase Orders object
11755
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11756
11756
  # @param [Hash] opts the optional parameters
11757
11757
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
11758
11758
  def get_purchase_order_attachments_with_http_info(xero_tenant_id, purchase_order_id, opts = {})
@@ -11890,7 +11890,7 @@ module XeroRuby
11890
11890
 
11891
11891
  # Retrieves history for a specific purchase order
11892
11892
  # @param xero_tenant_id [String] Xero identifier for Tenant
11893
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
11893
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11894
11894
  # @param [Hash] opts the optional parameters
11895
11895
  # @return [HistoryRecords]
11896
11896
  def get_purchase_order_history(xero_tenant_id, purchase_order_id, opts = {})
@@ -11900,7 +11900,7 @@ module XeroRuby
11900
11900
 
11901
11901
  # Retrieves history for a specific purchase order
11902
11902
  # @param xero_tenant_id [String] Xero identifier for Tenant
11903
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
11903
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
11904
11904
  # @param [Hash] opts the optional parameters
11905
11905
  # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers
11906
11906
  def get_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, opts = {})
@@ -12202,7 +12202,7 @@ module XeroRuby
12202
12202
 
12203
12203
  # Retrieves a specific attachment from a specific quote by filename
12204
12204
  # @param xero_tenant_id [String] Xero identifier for Tenant
12205
- # @param quote_id [String] Unique identifier for Quote object
12205
+ # @param quote_id [String] Unique identifier for an Quote
12206
12206
  # @param file_name [String] Name of the attachment
12207
12207
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12208
12208
  # @param [Hash] opts the optional parameters
@@ -12214,7 +12214,7 @@ module XeroRuby
12214
12214
 
12215
12215
  # Retrieves a specific attachment from a specific quote by filename
12216
12216
  # @param xero_tenant_id [String] Xero identifier for Tenant
12217
- # @param quote_id [String] Unique identifier for Quote object
12217
+ # @param quote_id [String] Unique identifier for an Quote
12218
12218
  # @param file_name [String] Name of the attachment
12219
12219
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12220
12220
  # @param [Hash] opts the optional parameters
@@ -12289,7 +12289,7 @@ module XeroRuby
12289
12289
 
12290
12290
  # Retrieves a specific attachment from a specific quote using a unique attachment Id
12291
12291
  # @param xero_tenant_id [String] Xero identifier for Tenant
12292
- # @param quote_id [String] Unique identifier for Quote object
12292
+ # @param quote_id [String] Unique identifier for an Quote
12293
12293
  # @param attachment_id [String] Unique identifier for Attachment object
12294
12294
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12295
12295
  # @param [Hash] opts the optional parameters
@@ -12301,7 +12301,7 @@ module XeroRuby
12301
12301
 
12302
12302
  # Retrieves a specific attachment from a specific quote using a unique attachment Id
12303
12303
  # @param xero_tenant_id [String] Xero identifier for Tenant
12304
- # @param quote_id [String] Unique identifier for Quote object
12304
+ # @param quote_id [String] Unique identifier for an Quote
12305
12305
  # @param attachment_id [String] Unique identifier for Attachment object
12306
12306
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12307
12307
  # @param [Hash] opts the optional parameters
@@ -12376,7 +12376,7 @@ module XeroRuby
12376
12376
 
12377
12377
  # Retrieves attachments for a specific quote
12378
12378
  # @param xero_tenant_id [String] Xero identifier for Tenant
12379
- # @param quote_id [String] Unique identifier for Quote object
12379
+ # @param quote_id [String] Unique identifier for an Quote
12380
12380
  # @param [Hash] opts the optional parameters
12381
12381
  # @return [Attachments]
12382
12382
  def get_quote_attachments(xero_tenant_id, quote_id, opts = {})
@@ -12386,7 +12386,7 @@ module XeroRuby
12386
12386
 
12387
12387
  # Retrieves attachments for a specific quote
12388
12388
  # @param xero_tenant_id [String] Xero identifier for Tenant
12389
- # @param quote_id [String] Unique identifier for Quote object
12389
+ # @param quote_id [String] Unique identifier for an Quote
12390
12390
  # @param [Hash] opts the optional parameters
12391
12391
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
12392
12392
  def get_quote_attachments_with_http_info(xero_tenant_id, quote_id, opts = {})
@@ -12700,7 +12700,7 @@ module XeroRuby
12700
12700
  # Retrieves a specific attachment from a specific expense claim receipts by file name
12701
12701
  # @param xero_tenant_id [String] Xero identifier for Tenant
12702
12702
  # @param receipt_id [String] Unique identifier for a Receipt
12703
- # @param file_name [String] The name of the file being attached to the Receipt
12703
+ # @param file_name [String] Name of the attachment
12704
12704
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12705
12705
  # @param [Hash] opts the optional parameters
12706
12706
  # @return [File]
@@ -12712,7 +12712,7 @@ module XeroRuby
12712
12712
  # Retrieves a specific attachment from a specific expense claim receipts by file name
12713
12713
  # @param xero_tenant_id [String] Xero identifier for Tenant
12714
12714
  # @param receipt_id [String] Unique identifier for a Receipt
12715
- # @param file_name [String] The name of the file being attached to the Receipt
12715
+ # @param file_name [String] Name of the attachment
12716
12716
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12717
12717
  # @param [Hash] opts the optional parameters
12718
12718
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -12787,7 +12787,7 @@ module XeroRuby
12787
12787
  # Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
12788
12788
  # @param xero_tenant_id [String] Xero identifier for Tenant
12789
12789
  # @param receipt_id [String] Unique identifier for a Receipt
12790
- # @param attachment_id [String] Unique identifier for a Attachment
12790
+ # @param attachment_id [String] Unique identifier for Attachment object
12791
12791
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12792
12792
  # @param [Hash] opts the optional parameters
12793
12793
  # @return [File]
@@ -12799,7 +12799,7 @@ module XeroRuby
12799
12799
  # Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
12800
12800
  # @param xero_tenant_id [String] Xero identifier for Tenant
12801
12801
  # @param receipt_id [String] Unique identifier for a Receipt
12802
- # @param attachment_id [String] Unique identifier for a Attachment
12802
+ # @param attachment_id [String] Unique identifier for Attachment object
12803
12803
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
12804
12804
  # @param [Hash] opts the optional parameters
12805
12805
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -13176,7 +13176,7 @@ module XeroRuby
13176
13176
  # Retrieves a specific attachment from a specific repeating invoices by file name
13177
13177
  # @param xero_tenant_id [String] Xero identifier for Tenant
13178
13178
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
13179
- # @param file_name [String] The name of the file being attached to a Repeating Invoice
13179
+ # @param file_name [String] Name of the attachment
13180
13180
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
13181
13181
  # @param [Hash] opts the optional parameters
13182
13182
  # @return [File]
@@ -13188,7 +13188,7 @@ module XeroRuby
13188
13188
  # Retrieves a specific attachment from a specific repeating invoices by file name
13189
13189
  # @param xero_tenant_id [String] Xero identifier for Tenant
13190
13190
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
13191
- # @param file_name [String] The name of the file being attached to a Repeating Invoice
13191
+ # @param file_name [String] Name of the attachment
13192
13192
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
13193
13193
  # @param [Hash] opts the optional parameters
13194
13194
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -13263,7 +13263,7 @@ module XeroRuby
13263
13263
  # Retrieves a specific attachment from a specific repeating invoice
13264
13264
  # @param xero_tenant_id [String] Xero identifier for Tenant
13265
13265
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
13266
- # @param attachment_id [String] Unique identifier for a Attachment
13266
+ # @param attachment_id [String] Unique identifier for Attachment object
13267
13267
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
13268
13268
  # @param [Hash] opts the optional parameters
13269
13269
  # @return [File]
@@ -13275,7 +13275,7 @@ module XeroRuby
13275
13275
  # Retrieves a specific attachment from a specific repeating invoice
13276
13276
  # @param xero_tenant_id [String] Xero identifier for Tenant
13277
13277
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
13278
- # @param attachment_id [String] Unique identifier for a Attachment
13278
+ # @param attachment_id [String] Unique identifier for Attachment object
13279
13279
  # @param content_type [String] The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
13280
13280
  # @param [Hash] opts the optional parameters
13281
13281
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -13574,8 +13574,8 @@ module XeroRuby
13574
13574
  # @param contact_id [String] Unique identifier for a Contact
13575
13575
  # @param [Hash] opts the optional parameters
13576
13576
  # @option opts [Date] :date The date of the Aged Payables By Contact report
13577
- # @option opts [Date] :from_date The from date of the Aged Payables By Contact report
13578
- # @option opts [Date] :to_date The to date of the Aged Payables By Contact report
13577
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
13578
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
13579
13579
  # @return [ReportWithRows]
13580
13580
  def get_report_aged_payables_by_contact(xero_tenant_id, contact_id, opts = {})
13581
13581
  data, _status_code, _headers = get_report_aged_payables_by_contact_with_http_info(xero_tenant_id, contact_id, opts)
@@ -13587,8 +13587,8 @@ module XeroRuby
13587
13587
  # @param contact_id [String] Unique identifier for a Contact
13588
13588
  # @param [Hash] opts the optional parameters
13589
13589
  # @option opts [Date] :date The date of the Aged Payables By Contact report
13590
- # @option opts [Date] :from_date The from date of the Aged Payables By Contact report
13591
- # @option opts [Date] :to_date The to date of the Aged Payables By Contact report
13590
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
13591
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
13592
13592
  # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
13593
13593
  def get_report_aged_payables_by_contact_with_http_info(xero_tenant_id, contact_id, opts = {})
13594
13594
  if @api_client.config.debugging
@@ -13658,8 +13658,8 @@ module XeroRuby
13658
13658
  # @param contact_id [String] Unique identifier for a Contact
13659
13659
  # @param [Hash] opts the optional parameters
13660
13660
  # @option opts [Date] :date The date of the Aged Receivables By Contact report
13661
- # @option opts [Date] :from_date The from date of the Aged Receivables By Contact report
13662
- # @option opts [Date] :to_date The to date of the Aged Receivables By Contact report
13661
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
13662
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
13663
13663
  # @return [ReportWithRows]
13664
13664
  def get_report_aged_receivables_by_contact(xero_tenant_id, contact_id, opts = {})
13665
13665
  data, _status_code, _headers = get_report_aged_receivables_by_contact_with_http_info(xero_tenant_id, contact_id, opts)
@@ -13671,8 +13671,8 @@ module XeroRuby
13671
13671
  # @param contact_id [String] Unique identifier for a Contact
13672
13672
  # @param [Hash] opts the optional parameters
13673
13673
  # @option opts [Date] :date The date of the Aged Receivables By Contact report
13674
- # @option opts [Date] :from_date The from date of the Aged Receivables By Contact report
13675
- # @option opts [Date] :to_date The to date of the Aged Receivables By Contact report
13674
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
13675
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
13676
13676
  # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
13677
13677
  def get_report_aged_receivables_by_contact_with_http_info(xero_tenant_id, contact_id, opts = {})
13678
13678
  if @api_client.config.debugging
@@ -13975,8 +13975,8 @@ module XeroRuby
13975
13975
  # Retrieves report for bank summary
13976
13976
  # @param xero_tenant_id [String] Xero identifier for Tenant
13977
13977
  # @param [Hash] opts the optional parameters
13978
- # @option opts [Date] :from_date The from date for the Bank Summary report e.g. 2018-03-31
13979
- # @option opts [Date] :to_date The to date for the Bank Summary report e.g. 2018-03-31
13978
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
13979
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
13980
13980
  # @return [ReportWithRows]
13981
13981
  def get_report_bank_summary(xero_tenant_id, opts = {})
13982
13982
  data, _status_code, _headers = get_report_bank_summary_with_http_info(xero_tenant_id, opts)
@@ -13986,8 +13986,8 @@ module XeroRuby
13986
13986
  # Retrieves report for bank summary
13987
13987
  # @param xero_tenant_id [String] Xero identifier for Tenant
13988
13988
  # @param [Hash] opts the optional parameters
13989
- # @option opts [Date] :from_date The from date for the Bank Summary report e.g. 2018-03-31
13990
- # @option opts [Date] :to_date The to date for the Bank Summary report e.g. 2018-03-31
13989
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
13990
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
13991
13991
  # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
13992
13992
  def get_report_bank_summary_with_http_info(xero_tenant_id, opts = {})
13993
13993
  if @api_client.config.debugging
@@ -14197,8 +14197,8 @@ module XeroRuby
14197
14197
  # Retrieves report for profit and loss
14198
14198
  # @param xero_tenant_id [String] Xero identifier for Tenant
14199
14199
  # @param [Hash] opts the optional parameters
14200
- # @option opts [Date] :from_date The from date for the ProfitAndLoss report e.g. 2018-03-31
14201
- # @option opts [Date] :to_date The to date for the ProfitAndLoss report e.g. 2018-03-31
14200
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
14201
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
14202
14202
  # @option opts [Integer] :periods The number of periods to compare (integer between 1 and 12)
14203
14203
  # @option opts [String] :timeframe The period size to compare to (MONTH, QUARTER, YEAR)
14204
14204
  # @option opts [String] :tracking_category_id The trackingCategory 1 for the ProfitAndLoss report
@@ -14216,8 +14216,8 @@ module XeroRuby
14216
14216
  # Retrieves report for profit and loss
14217
14217
  # @param xero_tenant_id [String] Xero identifier for Tenant
14218
14218
  # @param [Hash] opts the optional parameters
14219
- # @option opts [Date] :from_date The from date for the ProfitAndLoss report e.g. 2018-03-31
14220
- # @option opts [Date] :to_date The to date for the ProfitAndLoss report e.g. 2018-03-31
14219
+ # @option opts [Date] :from_date filter by the from date of the report e.g. 2021-02-01
14220
+ # @option opts [Date] :to_date filter by the to date of the report e.g. 2021-02-28
14221
14221
  # @option opts [Integer] :periods The number of periods to compare (integer between 1 and 12)
14222
14222
  # @option opts [String] :timeframe The period size to compare to (MONTH, QUARTER, YEAR)
14223
14223
  # @option opts [String] :tracking_category_id The trackingCategory 1 for the ProfitAndLoss report
@@ -14898,7 +14898,7 @@ module XeroRuby
14898
14898
 
14899
14899
  # Updates a chart of accounts
14900
14900
  # @param xero_tenant_id [String] Xero identifier for Tenant
14901
- # @param account_id [String] Unique identifier for retrieving single object
14901
+ # @param account_id [String] Unique identifier for Account object
14902
14902
  # @param accounts [Accounts] Request of type Accounts array with one Account
14903
14903
  # @param [Hash] opts the optional parameters
14904
14904
  # @return [Accounts]
@@ -14909,7 +14909,7 @@ module XeroRuby
14909
14909
 
14910
14910
  # Updates a chart of accounts
14911
14911
  # @param xero_tenant_id [String] Xero identifier for Tenant
14912
- # @param account_id [String] Unique identifier for retrieving single object
14912
+ # @param account_id [String] Unique identifier for Account object
14913
14913
  # @param accounts [Accounts] Request of type Accounts array with one Account
14914
14914
  # @param [Hash] opts the optional parameters
14915
14915
  # @return [Array<(Accounts, Integer, Hash)>] Accounts data, response status code and response headers
@@ -15154,7 +15154,7 @@ module XeroRuby
15154
15154
  # Updates a specific attachment from a specific bank transaction by filename
15155
15155
  # @param xero_tenant_id [String] Xero identifier for Tenant
15156
15156
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
15157
- # @param file_name [String] The name of the file being attached
15157
+ # @param file_name [String] Name of the attachment
15158
15158
  # @param body [String] Byte array of file in body of request
15159
15159
  # @param [Hash] opts the optional parameters
15160
15160
  # @return [Attachments]
@@ -15166,7 +15166,7 @@ module XeroRuby
15166
15166
  # Updates a specific attachment from a specific bank transaction by filename
15167
15167
  # @param xero_tenant_id [String] Xero identifier for Tenant
15168
15168
  # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
15169
- # @param file_name [String] The name of the file being attached
15169
+ # @param file_name [String] Name of the attachment
15170
15170
  # @param body [String] Byte array of file in body of request
15171
15171
  # @param [Hash] opts the optional parameters
15172
15172
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -15241,7 +15241,7 @@ module XeroRuby
15241
15241
 
15242
15242
  # @param xero_tenant_id [String] Xero identifier for Tenant
15243
15243
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
15244
- # @param file_name [String] The name of the file being attached to a Bank Transfer
15244
+ # @param file_name [String] Name of the attachment
15245
15245
  # @param body [String] Byte array of file in body of request
15246
15246
  # @param [Hash] opts the optional parameters
15247
15247
  # @return [Attachments]
@@ -15252,7 +15252,7 @@ module XeroRuby
15252
15252
 
15253
15253
  # @param xero_tenant_id [String] Xero identifier for Tenant
15254
15254
  # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
15255
- # @param file_name [String] The name of the file being attached to a Bank Transfer
15255
+ # @param file_name [String] Name of the attachment
15256
15256
  # @param body [String] Byte array of file in body of request
15257
15257
  # @param [Hash] opts the optional parameters
15258
15258
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -15409,7 +15409,7 @@ module XeroRuby
15409
15409
 
15410
15410
  # @param xero_tenant_id [String] Xero identifier for Tenant
15411
15411
  # @param contact_id [String] Unique identifier for a Contact
15412
- # @param file_name [String] Name for the file you are attaching
15412
+ # @param file_name [String] Name of the attachment
15413
15413
  # @param body [String] Byte array of file in body of request
15414
15414
  # @param [Hash] opts the optional parameters
15415
15415
  # @return [Attachments]
@@ -15420,7 +15420,7 @@ module XeroRuby
15420
15420
 
15421
15421
  # @param xero_tenant_id [String] Xero identifier for Tenant
15422
15422
  # @param contact_id [String] Unique identifier for a Contact
15423
- # @param file_name [String] Name for the file you are attaching
15423
+ # @param file_name [String] Name of the attachment
15424
15424
  # @param body [String] Byte array of file in body of request
15425
15425
  # @param [Hash] opts the optional parameters
15426
15426
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -15663,7 +15663,7 @@ module XeroRuby
15663
15663
  # Updates attachments on a specific credit note by file name
15664
15664
  # @param xero_tenant_id [String] Xero identifier for Tenant
15665
15665
  # @param credit_note_id [String] Unique identifier for a Credit Note
15666
- # @param file_name [String] Name of the file you are attaching to Credit Note
15666
+ # @param file_name [String] Name of the attachment
15667
15667
  # @param body [String] Byte array of file in body of request
15668
15668
  # @param [Hash] opts the optional parameters
15669
15669
  # @return [Attachments]
@@ -15675,7 +15675,7 @@ module XeroRuby
15675
15675
  # Updates attachments on a specific credit note by file name
15676
15676
  # @param xero_tenant_id [String] Xero identifier for Tenant
15677
15677
  # @param credit_note_id [String] Unique identifier for a Credit Note
15678
- # @param file_name [String] Name of the file you are attaching to Credit Note
15678
+ # @param file_name [String] Name of the attachment
15679
15679
  # @param body [String] Byte array of file in body of request
15680
15680
  # @param [Hash] opts the optional parameters
15681
15681
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -15918,7 +15918,7 @@ module XeroRuby
15918
15918
  # Updates an attachment from a specific invoices or purchase bill by filename
15919
15919
  # @param xero_tenant_id [String] Xero identifier for Tenant
15920
15920
  # @param invoice_id [String] Unique identifier for an Invoice
15921
- # @param file_name [String] Name of the file you are attaching
15921
+ # @param file_name [String] Name of the attachment
15922
15922
  # @param body [String] Byte array of file in body of request
15923
15923
  # @param [Hash] opts the optional parameters
15924
15924
  # @return [Attachments]
@@ -15930,7 +15930,7 @@ module XeroRuby
15930
15930
  # Updates an attachment from a specific invoices or purchase bill by filename
15931
15931
  # @param xero_tenant_id [String] Xero identifier for Tenant
15932
15932
  # @param invoice_id [String] Unique identifier for an Invoice
15933
- # @param file_name [String] Name of the file you are attaching
15933
+ # @param file_name [String] Name of the attachment
15934
15934
  # @param body [String] Byte array of file in body of request
15935
15935
  # @param [Hash] opts the optional parameters
15936
15936
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -16255,7 +16255,7 @@ module XeroRuby
16255
16255
  # Updates a specific attachment from a specific manual journal by file name
16256
16256
  # @param xero_tenant_id [String] Xero identifier for Tenant
16257
16257
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
16258
- # @param file_name [String] The name of the file being attached to a ManualJournal
16258
+ # @param file_name [String] Name of the attachment
16259
16259
  # @param body [String] Byte array of file in body of request
16260
16260
  # @param [Hash] opts the optional parameters
16261
16261
  # @return [Attachments]
@@ -16267,7 +16267,7 @@ module XeroRuby
16267
16267
  # Updates a specific attachment from a specific manual journal by file name
16268
16268
  # @param xero_tenant_id [String] Xero identifier for Tenant
16269
16269
  # @param manual_journal_id [String] Unique identifier for a ManualJournal
16270
- # @param file_name [String] The name of the file being attached to a ManualJournal
16270
+ # @param file_name [String] Name of the attachment
16271
16271
  # @param body [String] Byte array of file in body of request
16272
16272
  # @param [Hash] opts the optional parameters
16273
16273
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -17065,7 +17065,7 @@ module XeroRuby
17065
17065
 
17066
17066
  # Updates a specific purchase order
17067
17067
  # @param xero_tenant_id [String] Xero identifier for Tenant
17068
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
17068
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
17069
17069
  # @param purchase_orders [PurchaseOrders]
17070
17070
  # @param [Hash] opts the optional parameters
17071
17071
  # @return [PurchaseOrders]
@@ -17076,7 +17076,7 @@ module XeroRuby
17076
17076
 
17077
17077
  # Updates a specific purchase order
17078
17078
  # @param xero_tenant_id [String] Xero identifier for Tenant
17079
- # @param purchase_order_id [String] Unique identifier for a PurchaseOrder
17079
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
17080
17080
  # @param purchase_orders [PurchaseOrders]
17081
17081
  # @param [Hash] opts the optional parameters
17082
17082
  # @return [Array<(PurchaseOrders, Integer, Hash)>] PurchaseOrders data, response status code and response headers
@@ -17147,7 +17147,7 @@ module XeroRuby
17147
17147
 
17148
17148
  # Updates a specific attachment for a specific purchase order by filename
17149
17149
  # @param xero_tenant_id [String] Xero identifier for Tenant
17150
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
17150
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
17151
17151
  # @param file_name [String] Name of the attachment
17152
17152
  # @param body [String] Byte array of file in body of request
17153
17153
  # @param [Hash] opts the optional parameters
@@ -17159,7 +17159,7 @@ module XeroRuby
17159
17159
 
17160
17160
  # Updates a specific attachment for a specific purchase order by filename
17161
17161
  # @param xero_tenant_id [String] Xero identifier for Tenant
17162
- # @param purchase_order_id [String] Unique identifier for Purchase Order object
17162
+ # @param purchase_order_id [String] Unique identifier for an Purchase Order
17163
17163
  # @param file_name [String] Name of the attachment
17164
17164
  # @param body [String] Byte array of file in body of request
17165
17165
  # @param [Hash] opts the optional parameters
@@ -17317,7 +17317,7 @@ module XeroRuby
17317
17317
 
17318
17318
  # Updates a specific attachment from a specific quote by filename
17319
17319
  # @param xero_tenant_id [String] Xero identifier for Tenant
17320
- # @param quote_id [String] Unique identifier for Quote object
17320
+ # @param quote_id [String] Unique identifier for an Quote
17321
17321
  # @param file_name [String] Name of the attachment
17322
17322
  # @param body [String] Byte array of file in body of request
17323
17323
  # @param [Hash] opts the optional parameters
@@ -17329,7 +17329,7 @@ module XeroRuby
17329
17329
 
17330
17330
  # Updates a specific attachment from a specific quote by filename
17331
17331
  # @param xero_tenant_id [String] Xero identifier for Tenant
17332
- # @param quote_id [String] Unique identifier for Quote object
17332
+ # @param quote_id [String] Unique identifier for an Quote
17333
17333
  # @param file_name [String] Name of the attachment
17334
17334
  # @param body [String] Byte array of file in body of request
17335
17335
  # @param [Hash] opts the optional parameters
@@ -17491,7 +17491,7 @@ module XeroRuby
17491
17491
  # Updates a specific attachment on a specific expense claim receipts by file name
17492
17492
  # @param xero_tenant_id [String] Xero identifier for Tenant
17493
17493
  # @param receipt_id [String] Unique identifier for a Receipt
17494
- # @param file_name [String] The name of the file being attached to the Receipt
17494
+ # @param file_name [String] Name of the attachment
17495
17495
  # @param body [String] Byte array of file in body of request
17496
17496
  # @param [Hash] opts the optional parameters
17497
17497
  # @return [Attachments]
@@ -17503,7 +17503,7 @@ module XeroRuby
17503
17503
  # Updates a specific attachment on a specific expense claim receipts by file name
17504
17504
  # @param xero_tenant_id [String] Xero identifier for Tenant
17505
17505
  # @param receipt_id [String] Unique identifier for a Receipt
17506
- # @param file_name [String] The name of the file being attached to the Receipt
17506
+ # @param file_name [String] Name of the attachment
17507
17507
  # @param body [String] Byte array of file in body of request
17508
17508
  # @param [Hash] opts the optional parameters
17509
17509
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -17579,7 +17579,7 @@ module XeroRuby
17579
17579
  # Updates a specific attachment from a specific repeating invoices by file name
17580
17580
  # @param xero_tenant_id [String] Xero identifier for Tenant
17581
17581
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
17582
- # @param file_name [String] The name of the file being attached to a Repeating Invoice
17582
+ # @param file_name [String] Name of the attachment
17583
17583
  # @param body [String] Byte array of file in body of request
17584
17584
  # @param [Hash] opts the optional parameters
17585
17585
  # @return [Attachments]
@@ -17591,7 +17591,7 @@ module XeroRuby
17591
17591
  # Updates a specific attachment from a specific repeating invoices by file name
17592
17592
  # @param xero_tenant_id [String] Xero identifier for Tenant
17593
17593
  # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
17594
- # @param file_name [String] The name of the file being attached to a Repeating Invoice
17594
+ # @param file_name [String] Name of the attachment
17595
17595
  # @param body [String] Byte array of file in body of request
17596
17596
  # @param [Hash] opts the optional parameters
17597
17597
  # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers
@@ -16,6 +16,7 @@ require 'tempfile'
16
16
  require 'find'
17
17
  require 'faraday'
18
18
  require 'base64'
19
+ require 'cgi'
19
20
 
20
21
  module XeroRuby
21
22
  class ApiClient
@@ -46,7 +47,7 @@ module XeroRuby
46
47
  end
47
48
 
48
49
  def authorization_url
49
- url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{@scopes}"
50
+ url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{CGI.escape(@scopes)}"
50
51
  url << "&state=#{@state}" if @state
51
52
  return url
52
53
  end
@@ -7,9 +7,9 @@ Contact: api@xero.com
7
7
  Generated by: https://openapi-generator.tech
8
8
  OpenAPI Generator version: 4.3.1
9
9
 
10
- The version of the XeroOpenAPI document: 2.10.3
10
+ The version of the XeroOpenAPI document: 2.10.4
11
11
  =end
12
12
 
13
13
  module XeroRuby
14
- VERSION = '2.8.1'
14
+ VERSION = '2.8.2'
15
15
  end
@@ -1,4 +1,4 @@
1
- require './spec_helper'
1
+ require 'spec_helper'
2
2
 
3
3
  describe XeroRuby::ApiClient do
4
4
  context 'initialization' do
@@ -47,7 +47,7 @@ describe XeroRuby::ApiClient do
47
47
  state: 'i-am-customer-state'
48
48
  }
49
49
  api_client = XeroRuby::ApiClient.new(credentials: creds)
50
- expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid profile email accounting.transactions accounting.settings&state=i-am-customer-state')
50
+ expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid+profile+email+accounting.transactions+accounting.settings&state=i-am-customer-state')
51
51
  end
52
52
 
53
53
  it "Does not append state if it is not provided" do
@@ -58,7 +58,7 @@ describe XeroRuby::ApiClient do
58
58
  scopes: 'openid profile email accounting.transactions accounting.settings'
59
59
  }
60
60
  api_client = XeroRuby::ApiClient.new(credentials: creds)
61
- expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid profile email accounting.transactions accounting.settings')
61
+ expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid+profile+email+accounting.transactions+accounting.settings')
62
62
  end
63
63
  end
64
64
  end
@@ -1,4 +1,4 @@
1
- require './spec_helper'
1
+ require 'spec_helper'
2
2
 
3
3
  describe XeroRuby::ApiError do
4
4
  context 'initialization' do
@@ -1,6 +1,6 @@
1
- require './spec_helper'
1
+ require 'spec_helper'
2
2
 
3
- describe 'shared helper methdods' do
3
+ describe 'shared helper methods' do
4
4
 
5
5
  describe '#parse_date' do
6
6
  let(:model_instance) {XeroRuby::Accounting::Account.new}
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: xero-ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.8.1
4
+ version: 2.8.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Xero API Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-25 00:00:00.000000000 Z
11
+ date: 2021-04-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday