diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index e1a8bc7d92..593c3d1c15 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -8640,10 +8640,28 @@ paths: summary: "List credits" description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available" operationId: getCredits + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $credits = $ninja->credits->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/credits \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of credits" @@ -8729,6 +8747,18 @@ paths: summary: "Show credit" description: "Displays an credit by id" operationId: showCredit + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $credit = $ninja->credits->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -8819,6 +8849,18 @@ paths: summary: "Delete credit" description: "Handles the deletion of an credit by id" operationId: deleteCredit + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->credits->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -9134,6 +9176,8 @@ paths: - $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/per_page_meta' + - $ref: '#/components/parameters/page_meta' - name: name in: query description: | @@ -9626,6 +9670,9 @@ paths: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/updated_at" @@ -9860,6 +9907,18 @@ paths: summary: "Show recurring invoice" description: "Displays an RecurringInvoice by id" operationId: showRecurringInvoice + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $recurringInvoice = $ninja->recurringInvoices->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/recurring_invoices/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -10301,11 +10360,29 @@ paths: summary: "List tasks" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" operationId: getTasks + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $tasks = $ninja->tasks->all([ + 'per_page' => 10, + 'page' => 1, + 'client_id' => 'D2J234DFA' + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of tasks" @@ -10421,6 +10498,18 @@ paths: summary: "Show task" description: "Displays a task by id" operationId: showTask + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $task = $ninja->tasks->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -10540,6 +10629,18 @@ paths: summary: "Delete task" description: "Handles the deletion of a task by id" operationId: deleteTask + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->tasks->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -10581,6 +10682,18 @@ paths: summary: "Edit task" description: "Displays a task by id" operationId: editTask + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $task = $ninja->tasks->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA/edit \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -10626,6 +10739,18 @@ paths: summary: "Blank task" description: "Returns a blank task with default values" operationId: getTasksCreate + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $task = $ninja->tasks->model(); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks/create \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -10859,8 +10984,12 @@ paths: --header 'Accept: application/json' operationId: getQuotes parameters: + - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" @@ -11708,6 +11837,9 @@ paths: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" @@ -12725,11 +12857,28 @@ paths: summary: "List projects" description: "Lists projects" operationId: getProjects + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $projects = $ninja->projects->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of projects" @@ -12845,6 +12994,18 @@ paths: summary: "Show project" description: "Displays a project by id" operationId: showProject + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $project = $ninja->projects->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -12964,6 +13125,18 @@ paths: summary: "Delete project" description: "Handles the deletion of a project by id" operationId: deleteProject + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->projects->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13005,6 +13178,18 @@ paths: summary: "Edit project" description: "Displays a project by id" operationId: editProject + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $project = $ninja->projects->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA/edit \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13050,6 +13235,18 @@ paths: summary: "Blank project" description: "Returns a blank object with default values" operationId: getProjectsCreate + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $project = $ninja->projects->model(); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects/create \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13197,11 +13394,28 @@ paths: summary: "List vendors" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" operationId: getVendors + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendors = $ninja->vendors->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of vendors" @@ -13341,6 +13555,18 @@ paths: summary: "Show vendor" description: "Displays a vendor by id" operationId: showVendor + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendor = $ninja->vendors->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13462,6 +13688,18 @@ paths: summary: "Delete vendor" description: "Handles the deletion of a vendor by id" operationId: deleteVendor + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->vendors->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13503,6 +13741,18 @@ paths: summary: "Edit vendor" description: "Displays a vendor by id" operationId: editVendor + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendor = $ninja->vendors->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA/edit \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13548,6 +13798,18 @@ paths: summary: "Blank vendor" description: "Returns a blank vendor with default values" operationId: getVendorsCreate + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendor = $ninja->vendors->model(); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors/create \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13695,10 +13957,28 @@ paths: summary: "List payments" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" operationId: getPayments + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $payments = $ninja->payments->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/payments \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" @@ -13846,6 +14126,18 @@ paths: summary: "Show payment" description: "Displays an Payment by id" operationId: showPayment + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $payment = $ninja->payments->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -13934,6 +14226,18 @@ paths: summary: "Delete payment" description: "Handles the deletion of an Payment by id" operationId: deletePayment + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->payments->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -14323,6 +14627,8 @@ paths: - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/client_include' - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/per_page_meta' + - $ref: '#/components/parameters/page_meta' - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/updated_at" @@ -15349,6 +15655,18 @@ paths: Emails are suppressed by PostMark, when they receive a Hard bounce / Spam Complaint. This endpoint allows you to remove the suppression and send emails to the user again. operationId: reactivateEmail + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->clients->reactivateEmail("bounce_id_123"); + - lang: curl + label: curl + source: | + curl -X POST https://demo.invoiceninja.com/api/v1/reactivate_email/bounce_id_123 \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-Requested-With' @@ -15397,6 +15715,32 @@ paths: Updates the clients tax data - if their address has changed operationId: updateClientTaxData + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->clients->updateTaxData("D2J234DFA", [ + 'address1' => '123 New Street', + 'city' => 'New York', + 'state' => 'NY', + 'postal_code' => '10001', + 'country_id' => '1' + ]); + - lang: curl + label: curl + source: | + curl -X POST https://demo.invoiceninja.com/api/v1/clients/D2J234DFA/updateTaxData \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "Content-Type: application/json" \ + -H "X-Requested-With: XMLHttpRequest" \ + -d '{ + "address1": "123 New Street", + "city": "New York", + "state": "NY", + "postal_code": "10001", + "country_id": "1" + }' parameters: - $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-Requested-With' @@ -15441,10 +15785,28 @@ paths: summary: "List purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $purchaseOrders = $ninja->purchaseOrders->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/purchase_orders \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of purchase orders" @@ -16053,6 +16415,9 @@ paths: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml index b1d5c54c5c..b7c2b2a4f9 100644 --- a/openapi/paths/clients.yaml +++ b/openapi/paths/clients.yaml @@ -62,6 +62,8 @@ - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/client_include' - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/per_page_meta' + - $ref: '#/components/parameters/page_meta' - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/updated_at" @@ -1088,6 +1090,18 @@ Emails are suppressed by PostMark, when they receive a Hard bounce / Spam Complaint. This endpoint allows you to remove the suppression and send emails to the user again. operationId: reactivateEmail + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->clients->reactivateEmail("bounce_id_123"); + - lang: curl + label: curl + source: | + curl -X POST https://demo.invoiceninja.com/api/v1/reactivate_email/bounce_id_123 \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-Requested-With' @@ -1136,6 +1150,32 @@ Updates the clients tax data - if their address has changed operationId: updateClientTaxData + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->clients->updateTaxData("D2J234DFA", [ + 'address1' => '123 New Street', + 'city' => 'New York', + 'state' => 'NY', + 'postal_code' => '10001', + 'country_id' => '1' + ]); + - lang: curl + label: curl + source: | + curl -X POST https://demo.invoiceninja.com/api/v1/clients/D2J234DFA/updateTaxData \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "Content-Type: application/json" \ + -H "X-Requested-With: XMLHttpRequest" \ + -d '{ + "address1": "123 New Street", + "city": "New York", + "state": "NY", + "postal_code": "10001", + "country_id": "1" + }' parameters: - $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-Requested-With' diff --git a/openapi/paths/credits.yaml b/openapi/paths/credits.yaml index c76e472536..1f6999909a 100644 --- a/openapi/paths/credits.yaml +++ b/openapi/paths/credits.yaml @@ -5,10 +5,28 @@ summary: "List credits" description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available" operationId: getCredits + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $credits = $ninja->credits->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/credits \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of credits" @@ -94,6 +112,18 @@ summary: "Show credit" description: "Displays an credit by id" operationId: showCredit + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $credit = $ninja->credits->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -184,6 +214,18 @@ summary: "Delete credit" description: "Handles the deletion of an credit by id" operationId: deleteCredit + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->credits->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" diff --git a/openapi/paths/invoices.yaml b/openapi/paths/invoices.yaml index 6215682601..e5c2660e97 100644 --- a/openapi/paths/invoices.yaml +++ b/openapi/paths/invoices.yaml @@ -30,6 +30,9 @@ - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" diff --git a/openapi/paths/locations.yaml b/openapi/paths/locations.yaml index 8e58372719..135846cd7f 100644 --- a/openapi/paths/locations.yaml +++ b/openapi/paths/locations.yaml @@ -45,6 +45,8 @@ - $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/per_page_meta' + - $ref: '#/components/parameters/page_meta' - name: name in: query description: | diff --git a/openapi/paths/payments.yaml b/openapi/paths/payments.yaml index a568031fb8..b967e9462d 100644 --- a/openapi/paths/payments.yaml +++ b/openapi/paths/payments.yaml @@ -5,10 +5,28 @@ summary: "List payments" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" operationId: getPayments + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $payments = $ninja->payments->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/payments \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" @@ -156,6 +174,18 @@ summary: "Show payment" description: "Displays an Payment by id" operationId: showPayment + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $payment = $ninja->payments->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -244,6 +274,18 @@ summary: "Delete payment" description: "Handles the deletion of an Payment by id" operationId: deletePayment + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->payments->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index cf47ee45d0..bff7d9f10d 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -32,6 +32,9 @@ - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" diff --git a/openapi/paths/projects.yaml b/openapi/paths/projects.yaml index 979e3d50b7..f610ef4550 100644 --- a/openapi/paths/projects.yaml +++ b/openapi/paths/projects.yaml @@ -5,11 +5,28 @@ summary: "List projects" description: "Lists projects" operationId: getProjects + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $projects = $ninja->projects->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of projects" @@ -125,6 +142,18 @@ summary: "Show project" description: "Displays a project by id" operationId: showProject + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $project = $ninja->projects->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -244,6 +273,18 @@ summary: "Delete project" description: "Handles the deletion of a project by id" operationId: deleteProject + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->projects->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -285,6 +326,18 @@ summary: "Edit project" description: "Displays a project by id" operationId: editProject + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $project = $ninja->projects->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA/edit \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -330,6 +383,18 @@ summary: "Blank project" description: "Returns a blank object with default values" operationId: getProjectsCreate + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $project = $ninja->projects->model(); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/projects/create \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" diff --git a/openapi/paths/purchase_orders.yaml b/openapi/paths/purchase_orders.yaml index 6b0e49557f..1a8dd42108 100644 --- a/openapi/paths/purchase_orders.yaml +++ b/openapi/paths/purchase_orders.yaml @@ -5,10 +5,28 @@ summary: "List purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $purchaseOrders = $ninja->purchaseOrders->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/purchase_orders \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of purchase orders" diff --git a/openapi/paths/quotes.yaml b/openapi/paths/quotes.yaml index d0f4513b85..6d138e1b12 100644 --- a/openapi/paths/quotes.yaml +++ b/openapi/paths/quotes.yaml @@ -29,8 +29,12 @@ --header 'Accept: application/json' operationId: getQuotes parameters: + - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/status" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" diff --git a/openapi/paths/recurring_invoices.yaml b/openapi/paths/recurring_invoices.yaml index a3fe3d7ae2..c20ef3fb85 100644 --- a/openapi/paths/recurring_invoices.yaml +++ b/openapi/paths/recurring_invoices.yaml @@ -29,6 +29,9 @@ - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" - $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/updated_at" @@ -263,6 +266,18 @@ summary: "Show recurring invoice" description: "Displays an RecurringInvoice by id" operationId: showRecurringInvoice + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $recurringInvoice = $ninja->recurringInvoices->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/recurring_invoices/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" diff --git a/openapi/paths/tasks.yaml b/openapi/paths/tasks.yaml index 4f56d56161..29b343778d 100644 --- a/openapi/paths/tasks.yaml +++ b/openapi/paths/tasks.yaml @@ -5,11 +5,29 @@ summary: "List tasks" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" operationId: getTasks + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $tasks = $ninja->tasks->all([ + 'per_page' => 10, + 'page' => 1, + 'client_id' => 'D2J234DFA' + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of tasks" @@ -125,6 +143,18 @@ summary: "Show task" description: "Displays a task by id" operationId: showTask + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $task = $ninja->tasks->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -244,6 +274,18 @@ summary: "Delete task" description: "Handles the deletion of a task by id" operationId: deleteTask + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->tasks->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -285,6 +327,18 @@ summary: "Edit task" description: "Displays a task by id" operationId: editTask + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $task = $ninja->tasks->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA/edit \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -330,6 +384,18 @@ summary: "Blank task" description: "Returns a blank task with default values" operationId: getTasksCreate + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $task = $ninja->tasks->model(); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/tasks/create \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" diff --git a/openapi/paths/vendors.yaml b/openapi/paths/vendors.yaml index cdbfa8126f..a55283cc60 100644 --- a/openapi/paths/vendors.yaml +++ b/openapi/paths/vendors.yaml @@ -5,11 +5,28 @@ summary: "List vendors" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" operationId: getVendors + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendors = $ninja->vendors->all([ + 'per_page' => 10, + 'page' => 1 + ]); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: description: "A list of vendors" @@ -149,6 +166,18 @@ summary: "Show vendor" description: "Displays a vendor by id" operationId: showVendor + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendor = $ninja->vendors->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -270,6 +299,18 @@ summary: "Delete vendor" description: "Handles the deletion of a vendor by id" operationId: deleteVendor + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $ninja->vendors->delete("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X DELETE https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -311,6 +352,18 @@ summary: "Edit vendor" description: "Displays a vendor by id" operationId: editVendor + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendor = $ninja->vendors->show("D2J234DFA"); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA/edit \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" @@ -356,6 +409,18 @@ summary: "Blank vendor" description: "Returns a blank vendor with default values" operationId: getVendorsCreate + x-codeSamples: + - lang: php + label: php + source: | + $ninja = new InvoiceNinja("YOUR-TOKEN"); + $vendor = $ninja->vendors->model(); + - lang: curl + label: curl + source: | + curl -X GET https://demo.invoiceninja.com/api/v1/vendors/create \ + -H "X-API-TOKEN: YOUR-TOKEN" \ + -H "X-Requested-With: XMLHttpRequest" parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With"