Merge pull request #86 from oracle/property_24.4.0.0

Property 24.4.0.0
oracle · Dec 19, 2024 · 6a00208 · 6a00208
2 parents a0b840e + 3bd9b43
commit 6a00208
Show file tree

Hide file tree

Showing 43 changed files with 32,000 additions and 21,546 deletions.
diff --git a/rest-api-specs/property/act.json b/rest-api-specs/property/act.json
@@ -2,8 +2,8 @@
   "swagger": "2.0",
   "info": {
     "title": "OPERA Cloud Activity API",
-    "description": "APIs to cater for Sales Activity functionality in OPERA Cloud. <br /><br /> Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.<br /><br /> Compatible with OPERA Cloud release 24.2.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
-    "version": "24.2",
+    "description": "APIs to cater for Sales Activity functionality in OPERA Cloud. <br /><br /> Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.<br /><br /> Compatible with OPERA Cloud release 24.4.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
+    "version": "24.4",
     "termsOfService": "https://www.oracle.com/legal/terms.html",
     "contact": {
       "email": "[email protected]"
@@ -24,7 +24,7 @@
     "/activities": {
       "get": {
         "summary": "Get activities",
-        "description": "Use this API to retrieve activities for multiple hotels.  Results can be narrowed down by your search criteria in the request message. <p><strong>OperationId:</strong>getActivitiesByMultipleHotelIds</p>",
+        "description": "Use this API to retrieve activities for multiple hotels.  Results can be narrowed down by your search criteria in the request message. <p><strong>OperationId:</strong>getActivitiesByMultipleHotelIds</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>",
         "operationId": "getActivitiesByMultipleHotelIds",
         "parameters": [
           {
@@ -794,7 +794,7 @@
     "/activities/emails": {
       "get": {
         "summary": "Get Emails",
-        "description": "Use this API to retrieve emails which have been received from an external system and stored in OPERA. They are stored against accounts, contacts and blocks in OPERA. <p><strong>OperationId:</strong>getEmails</p>",
+        "description": "Use this API to retrieve emails which have been received from an external system and stored in OPERA. They are stored against accounts, contacts and blocks in OPERA. <p><strong>OperationId:</strong>getEmails</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p> <p>This API allows a time span of <strong>90</strong> days.</p>",
         "operationId": "getEmails",
         "parameters": [
           {
@@ -1398,7 +1398,7 @@
     "/hotels/{hotelId}/activities": {
       "get": {
         "summary": "Get activities by hotel",
-        "description": "You can use this API to retrieve multiple Activities for a hotel, you can narrow the results using different search criteria  <p><strong>OperationId:</strong>getActivities</p>",
+        "description": "You can use this API to retrieve multiple Activities for a hotel, you can narrow the results using different search criteria  <p><strong>OperationId:</strong>getActivities</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>",
         "operationId": "getActivities",
         "parameters": [
           {
@@ -3121,7 +3121,7 @@
     "/hotels/{hotelId}/activityLog": {
       "get": {
         "summary": "Get Activity Log",
-        "description": "You can use this API to view the changes log for a specified Activity. <p><strong>OperationId:</strong>getActivityLog</p>",
+        "description": "You can use this API to view the changes log for a specified Activity. <p><strong>OperationId:</strong>getActivityLog</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p> <p>This API allows a time span of <strong>90</strong> days.</p>",
         "operationId": "getActivityLog",
         "parameters": [
           {

diff --git a/rest-api-specs/property/actcfg.json b/rest-api-specs/property/actcfg.json
@@ -2,8 +2,8 @@
   "swagger": "2.0",
   "info": {
     "title": "OPERA Cloud Activity Management API",
-    "description": "APIs to cater for Activity Configuration functionality in OPERA Cloud. In this module you can retrieve, create, update Activity configuration codes, for example create a new Activity Type.<br /><br /> Compatible with OPERA Cloud release 24.2.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
-    "version": "24.2",
+    "description": "APIs to cater for Activity Configuration functionality in OPERA Cloud. In this module you can retrieve, create, update Activity configuration codes, for example create a new Activity Type.<br /><br /> Compatible with OPERA Cloud release 24.4.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
+    "version": "24.4",
     "termsOfService": "https://www.oracle.com/legal/terms.html",
     "contact": {
       "email": "[email protected]"
@@ -24,7 +24,7 @@
     "/activityResults": {
       "get": {
         "summary": "Get all Configured Activity Result Codes ",
-        "description": "Retrieve a list of all configured Activity Result codes and descriptions.  Activity Results appear on the Activities screen in the Results field after the Activity is completed.  And example could be Call Again - an activity is Completed but the result code as part of the completion is to Call Again. <p><strong>OperationId:</strong>getActivityResultsConfig</p>",
+        "description": "Retrieve a list of all configured Activity Result codes and descriptions.  Activity Results appear on the Activities screen in the Results field after the Activity is completed.  And example could be Call Again - an activity is Completed but the result code as part of the completion is to Call Again. <p><strong>OperationId:</strong>getActivityResultsConfig</p> <p>The maximum allowable limit for this API is <strong>25</strong>.</p>",
         "operationId": "getActivityResultsConfig",
         "parameters": [
           {
@@ -467,7 +467,7 @@
     "/autoTraceCodes": {
       "get": {
         "summary": "Get Auto Trace codes",
-        "description": "Retrieve a list of all configured Auto Trace Codes for a property. <p><strong>OperationId:</strong>getAutoTraceCodes</p>",
+        "description": "Retrieve a list of all configured Auto Trace Codes for a property. <p><strong>OperationId:</strong>getAutoTraceCodes</p> <p>The maximum allowable limit for this API is <strong>25</strong>.</p>",
         "operationId": "getAutoTraceCodes",
         "parameters": [
           {
@@ -1330,7 +1330,7 @@
     "/hotels/{hotelId}/activityTypes": {
       "get": {
         "summary": "Get all Activity Type Codes",
-        "description": "Retrieve all configured Activity types for a specified hotel. <p><strong>OperationId:</strong>getActivityTypes</p>",
+        "description": "Retrieve all configured Activity types for a specified hotel. <p><strong>OperationId:</strong>getActivityTypes</p> <p>The maximum allowable limit for this API is <strong>25</strong>.</p>",
         "operationId": "getActivityTypes",
         "parameters": [
           {
@@ -1801,7 +1801,7 @@
     "/hotels/{hotelId}/autoTraceDefinitions": {
       "get": {
         "summary": "Get a list of Auto Trace definition Codes",
-        "description": "Get a list of all Auto trace definitions for a property. <p><strong>OperationId:</strong>getAutoTraceDefinitions</p>",
+        "description": "Get a list of all Auto trace definitions for a property. <p><strong>OperationId:</strong>getAutoTraceDefinitions</p> <p>The maximum allowable limit for this API is <strong>25</strong>.</p>",
         "operationId": "getAutoTraceDefinitions",
         "parameters": [
           {
@@ -2178,7 +2178,7 @@
     "/hotels/{hotelId}/autoTraceOwnerAssignments": {
       "get": {
         "summary": "Get an Auto Trace owner mappings",
-        "description": "This API will provide a list of all configured Auto Trace Owner Mappings.   <p><strong>OperationId:</strong>getAutoTraceOwnerAssignments</p>",
+        "description": "This API will provide a list of all configured Auto Trace Owner Mappings.   <p><strong>OperationId:</strong>getAutoTraceOwnerAssignments</p> <p>The maximum allowable limit for this API is <strong>25</strong>.</p>",
         "operationId": "getAutoTraceOwnerAssignments",
         "parameters": [
           {

diff --git a/rest-api-specs/property/ars.json b/rest-api-specs/property/ars.json
@@ -2,8 +2,8 @@
   "swagger": "2.0",
   "info": {
     "title": "OPERA Cloud Accounts Receivables API",
-    "description": "APIs to cater for Accounts Receivables functionality in OPERA Cloud. <br /><br The OPERA Cloud Accounts Receivable module enables you to manage debtors' accounts, invoices, and remittance.<br /><br /> Compatible with OPERA Cloud release 24.2.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
-    "version": "24.2",
+    "description": "APIs to cater for Accounts Receivables functionality in OPERA Cloud. <br /><br The OPERA Cloud Accounts Receivable module enables you to manage debtors' accounts, invoices, and remittance.<br /><br /> Compatible with OPERA Cloud release 24.4.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
+    "version": "24.4",
     "termsOfService": "https://www.oracle.com/legal/terms.html",
     "contact": {
       "email": "[email protected]"
@@ -267,7 +267,7 @@
     "/accounts": {
       "get": {
         "summary": "Get given profile's account receivable detail",
-        "description": "Use this API to search for AR Accounts for a given OPERA Profile id. API returns contain a list of AR Accounts and their AR information. <p><strong>OperationId:</strong>getAccounts</p>",
+        "description": "Use this API to search for AR Accounts for a given OPERA Profile id. API returns contain a list of AR Accounts and their AR information. <p><strong>OperationId:</strong>getAccounts</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>",
         "operationId": "getAccounts",
         "parameters": [
           {
@@ -1926,7 +1926,7 @@
     "/arTransactions": {
       "get": {
         "summary": "Get AR transactions.",
-        "description": "Use this API to get list of transaction data for a given account receivable account number and list of hotels <p><strong>OperationId:</strong>getARTransactions</p>",
+        "description": "Use this API to get list of transaction data for a given account receivable account number and list of hotels <p><strong>OperationId:</strong>getARTransactions</p> <p>This API allows a time span of <strong>30</strong> days.</p>",
         "operationId": "getARTransactions",
         "parameters": [
           {
@@ -2240,7 +2240,7 @@
     "/hotels/{hotelId}/accounts/invoicesOnHold": {
       "get": {
         "summary": "Get list of hold invoices for account receivable",
-        "description": "Use this API to get list of account receivable invoices which are put on hold. <p><strong>OperationId:</strong>getInvoicesOnHold</p>",
+        "description": "Use this API to get list of account receivable invoices which are put on hold. <p><strong>OperationId:</strong>getInvoicesOnHold</p> <p>This API allows a time span of <strong>30</strong> days.</p>",
         "operationId": "getInvoicesOnHold",
         "parameters": [
           {
@@ -6896,7 +6896,7 @@
     "/hotels/{hotelId}/transactions/{transactionId}/creditcard/payments": {
       "get": {
         "summary": "Get account receivable folios which are paid using credit cards",
-        "description": "Use this API to get lists of folios for guests who checked out using a credit card payment transaction code that has an account receivable associated with it. It also lists payments made prior to check out if the payment was made using a credit card transaction code that has a an account receivable associated with it. <p><strong>OperationId:</strong>getARCreditCardPayments</p>",
+        "description": "Use this API to get lists of folios for guests who checked out using a credit card payment transaction code that has an account receivable associated with it. It also lists payments made prior to check out if the payment was made using a credit card transaction code that has a an account receivable associated with it. <p><strong>OperationId:</strong>getARCreditCardPayments</p> <p>The maximum allowable limit for this API is <strong>50</strong>.</p> <p>This API allows a time span of <strong>30</strong> days.</p>",
         "operationId": "getARCreditCardPayments",
         "parameters": [
           {
@@ -7283,7 +7283,7 @@
     "/invoicePayments/accounts/{accountId}": {
       "get": {
         "summary": "Get payment detail for account's invoices",
-        "description": "Use this API to get payment data for account receivable invoices. <p><strong>OperationId:</strong>getInvoicesPayments</p>",
+        "description": "Use this API to get payment data for account receivable invoices. <p><strong>OperationId:</strong>getInvoicesPayments</p> <p>The maximum allowable limit for this API is <strong>50</strong>.</p>",
         "operationId": "getInvoicesPayments",
         "parameters": [
           {
@@ -7589,7 +7589,7 @@
     "/invoicePostings": {
       "get": {
         "summary": "Get account receivable invoice postings",
-        "description": "Use this API to get account receivable postings. <p><strong>OperationId:</strong>getInvoicePostings</p>",
+        "description": "Use this API to get account receivable postings. <p><strong>OperationId:</strong>getInvoicePostings</p> <p>This API allows a time span of <strong>30</strong> days.</p>",
         "operationId": "getInvoicePostings",
         "parameters": [
           {