vcita-platform-java-sdk

Platform API

API version: v2.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

Java 1.8+
Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.vcita.platform</groupId>
  <artifactId>vcita-platform-java-sdk</artifactId>
  <version>v2.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'vcita-platform-java-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'vcita-platform-java-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.vcita.platform:vcita-platform-java-sdk:v2.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

target/vcita-platform-java-sdk-v2.0.jar
target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.vcita.platform.client.ApiClient;
import com.vcita.platform.client.ApiException;
import com.vcita.platform.client.Configuration;
import com.vcita.platform.client.auth.*;
import com.vcita.platform.client.models.*;
import com.vcita.platform.client.api.ApplicationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://api.vcita.biz/platform/v1");
    
    // Configure OAuth2 access token for authorization: default
    OAuth default = (OAuth) defaultClient.getAuthentication("default");
    default.setAccessToken("YOUR ACCESS TOKEN");

    ApplicationsApi apiInstance = new ApplicationsApi(defaultClient);
    String authorization = "authorization_example"; // String | API Token. The resulting header should look like this: 'Authorization: \"Bearer API_TOKEN\"'
    try {
      AppsGet201Response result = apiInstance.appsGet(authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsApi#appsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://api.vcita.biz/platform/v1

Class	Method	HTTP request	Description
ApplicationsApi	appsGet	GET /apps	List of apps
ApplicationsApi	appsIdAssignPost	POST /apps/{id}/assign	Assign an app on directory or a business [Internal]
ApplicationsApi	appsIdGet	GET /apps/{id}	Read an app
ApplicationsApi	appsIdInstallAppPost	POST /apps/{id}/install_app	Install an app [Internal]
ApplicationsApi	appsIdPut	PUT /apps/{id}	Updates an app
ApplicationsApi	appsIdUnassignPost	POST /apps/{id}/unassign	Unassign an app on directory or a business [Internal]
ApplicationsApi	appsIdUninstallAppPost	POST /apps/{id}/uninstall_app	Uninstall an app [Internal]
ApplicationsApi	appsPost	POST /apps	Creates an app
AppointmentsApi	globalAppointmentsGet	GET /global/appointments	Get appointments list
AppointmentsApi	schedulingAppointmentsAppointmentIdGet	GET /scheduling/appointments/{appointment_id}	Get Appointment
AppointmentsApi	schedulingAppointmentsGet	GET /scheduling/appointments	Get Appointments List
AvailabilityApi	servicesServiceIdAvailabilityGet	GET /services/{service_id}/availability	Get Service availability By ID [Alpha]
BookingsApi	schedulingBookingsBookingUidUpdateRsvpStatePut	PUT /scheduling/bookings/{booking_uid}/update_rsvp_state	Update RSVP state
BookingsApi	schedulingBookingsCancelPost	POST /scheduling/bookings/cancel	Cancel a Booking [Alpha]
BookingsApi	schedulingBookingsGet	GET /scheduling/bookings	Get Bookings [Alpha]
BookingsApi	schedulingBookingsPost	POST /scheduling/bookings	Create New Booking [Alpha]
BookingsApi	schedulingWaitlistCancelPut	PUT /scheduling/waitlist/cancel	Cancel a Waitlist registration
BookingsApi	schedulingWaitlistPost	POST /scheduling/waitlist	Create event Waitlist
BusinessApi	businessesBusinessIdFeaturesGet	GET /businesses/{business_id}/features	Get Business Features
BusinessApi	businessesBusinessIdGet	GET /businesses/{business_id}	Get Business
BusinessApi	businessesBusinessIdPost	POST /businesses/{business_id}	Update Business
BusinessApi	businessesGet	GET /businesses	Get Business filtered by email or external_id
BusinessApi	businessesPost	POST /businesses	Create a Business
BusinessApi	businessesValidateLoginGet	GET /businesses/validate_login	Validate Login
BusinessApi	globalBusinessesGet	GET /global/businesses	Gets a list of businesses
CardApi	paymentCardsSyncCardPost	POST /payment/cards/sync_card	Create sync card
CategoriesApi	categoriesGet	GET /categories	Get Categories [Alpha]
ClientPackagesApi	clientsClientIdPaymentClientPackagesGet	GET /clients/{client_id}/payment/client_packages	Get Client Packages List Of Client [Alpha]
ClientPackagesApi	clientsPaymentClientPackagesUpdateUsagePost	POST /clients/payment/client_packages/update_usage	Use Client Package Credit [Alpha]
ClientPackagesApi	clientsPaymentClientPackagesValidateGet	GET /clients/payment/client_packages/validate	Validate Client Package has redemption [Alpha]
ClientPackagesApi	paymentClientPackagesPost	POST /payment/client_packages	Add package to client [Alpha]
ClientPackagesApi	paymentClientPackagesUpdateUsagePost	POST /payment/client_packages/update_usage	Use Client Package Credit [Alpha]
ClientsApi	clientsClientIdDelete	DELETE /clients/{client_id}	Deletes a Client by Id
ClientsApi	clientsClientIdGet	GET /clients/{client_id}	Retrieves a Client by Id
ClientsApi	clientsClientIdPut	PUT /clients/{client_id}	Updates a Client
ClientsApi	clientsGet	GET /clients	Get Clients
ClientsApi	clientsPost	POST /clients	Create a Client
ClientsApi	globalClientsGet	GET /global/clients	Gets a list of clients
ConversationsApi	clientsClientIdConversationsGet	GET /clients/{client_id}/conversations	Get Conversations For A Client
ConversationsApi	conversationsGet	GET /conversations	Get Conversations
DocumentsApi	clientsClientIdDocumentsGet	GET /clients/{client_id}/documents	Get Documents For A Client
EstimatesApi	clientsClientIdEstimatesGet	GET /clients/{client_id}/estimates	Get Estimates Of Client
EstimatesApi	estimatesGet	GET /estimates	Get Estimates List
EstimatesApi	estimatesPost	POST /estimates	Create New Estimate
EventAttendanceApi	globalEventAttendancesGet	GET /global/event_attendances	Gets a list of event attendances
EventInstanceApi	globalEventInstancesGet	GET /global/event_instances	Gets a list of event instances
EventInstanceApi	schedulingEventInstanceEventInstanceIdGet	GET /scheduling/event_instance/{event_instance_id}	Get Event Instance
FieldsApi	fieldsFieldIdDelete	DELETE /fields/{field_id}	Deletes a Field
FieldsApi	fieldsFieldIdGet	GET /fields/{field_id}	Get Field
FieldsApi	fieldsFieldIdPut	PUT /fields/{field_id}	Updates a Field
FieldsApi	fieldsGet	GET /fields	Get all Fields
FieldsApi	fieldsPost	POST /fields	Create a New Field
FormsApi	formsGet	GET /forms	Get Forms
FormsApi	formsPut	PUT /forms	Updates a Form
GlobalApi	globalClientPackagesGet	GET /global/client_packages	Gets a list of client packages
GlobalApi	globalConversationsGet	GET /global/conversations	Gets a list of conversations
GlobalApi	globalEstimatesGet	GET /global/estimates	Gets a list of estimates
GlobalApi	globalInvoicesGet	GET /global/invoices	Gets a list of invoices
GlobalApi	globalMattersGet	GET /global/matters	Gets a list of matters
GlobalApi	globalPackagesGet	GET /global/packages	Gets a list of packages
GlobalApi	globalProductsGet	GET /global/products	Gets a list of products
InvoicesApi	clientsClientIdInvoicesGet	GET /clients/{client_id}/invoices	Get Invoices Of Client
InvoicesApi	invoicesGet	GET /invoices	Get Invoices List
InvoicesApi	invoicesInvoiceIdGet	GET /invoices/{invoice_id}	Get Invoice By ID
InvoicesApi	invoicesPost	POST /invoices	Create New Invoice
LeadGenApi	leadgenPost	POST /leadgen	Creates a lead
MarketingApi	globalCampaignRecipientsGet	GET /global/campaign_recipients	Gets a list of campaign recipients
MarketingApi	globalCampaignsGet	GET /global/campaigns	Gets a list of campaigns
MarketingApi	globalScheduledCampaignsGet	GET /global/scheduled_campaigns	Gets a list of scheduled campaigns
MattersApi	clientsMergesMergeClientsPut	PUT /clients/merges/merge_clients	Merge duplicate clients into a primary client.
MattersApi	clientsMergesPossibleMergeMasterGet	GET /clients/merges/possible_merge_master	List of clients that can be used as primary for merge.
MessagesApi	messagesPost	POST /messages	Create a Message
PackagesApi	paymentPackagesGet	GET /payment/packages	Get all package of business
PackagesApi	paymentPackagesPackageIdGet	GET /payment/packages/{package_id}	Show package info
PackagesApi	paymentPackagesPackageIdPut	PUT /payment/packages/{package_id}	Update package [Alpha]
PackagesApi	paymentPackagesPost	POST /payment/packages	Create Package
PaymentCheckoutApi	paymentCheckoutPut	PUT /payment/checkout/	Send checkout update by webhook
PaymentCheckoutApi	paymentCheckoutUrlKeyGet	GET /payment/checkout/{url_key}	Get Open Checkout For Specific url_key
PaymentSettingsApi	paymentSettingsGet	GET /payment/settings	Get Current Payment Settings
PaymentSettingsApi	paymentSettingsPost	POST /payment/settings	Update Payment Settings
PaymentStatusesApi	paymentStatusesIdApplyCouponPut	PUT /payment_statuses/{id}/apply_coupon	Apply Coupon
PaymentStatusesApi	paymentStatusesIdValidateCouponGet	GET /payment_statuses/{id}/validate_coupon	Validate Coupon
PaymentsApi	clientsClientIdPaymentsGet	GET /clients/{client_id}/payments	Get Payments of Client
PaymentsApi	globalPaymentsGet	GET /global/payments	Gets a list of payments
PaymentsApi	paymentsGet	GET /payments	Get Payments List
PaymentsApi	paymentsPaymentUidMatchPost	POST /payments/{payment_uid}/match	Match Payment
PaymentsApi	paymentsPost	POST /payments	Create New Payment
SchedulingFormsApi	schedulingSchedulingFormsGetFormGet	GET /scheduling/scheduling_forms/get_form
ServicesApi	categoriesCategoryIdServicesGet	GET /categories/{category_id}/services	Get Services List by category [Alpha]
ServicesApi	globalServicesGet	GET /global/services	Gets a list of services
ServicesApi	servicesGet	GET /services	Get Services List [Alpha]
ServicesApi	servicesServiceIdGet	GET /services/{service_id}	Get Service By ID [Alpha]
StaffApi	businessesBusinessIdStaffsGet	GET /businesses/{business_id}/staffs	Get Staff Members
StaffApi	businessesBusinessIdStaffsPost	POST /businesses/{business_id}/staffs	Create Staff Member
StaffApi	businessesBusinessIdStaffsStaffIdDelete	DELETE /businesses/{business_id}/staffs/{staff_id}	Delete Staff Member
StaffApi	businessesBusinessIdStaffsStaffIdGet	GET /businesses/{business_id}/staffs/{staff_id}	Get Staff Member Details
StaffApi	globalStaffsGet	GET /global/staffs	Gets a list of staffs
StaffApi	schedulingStaffGet	GET /scheduling/staff	Get Staff List [Alpha]
StaffApi	schedulingStaffStaffIdGet	GET /scheduling/staff/{staff_id}	Get Staff By ID [Alpha]
TokenManagementApi	tokensGet	GET /tokens	Get tokens
TokenManagementApi	tokensPost	POST /tokens	Creates a token
TokenManagementApi	tokensRevokePost	POST /tokens/revoke	Revokes a token
WebhooksApi	webhookSubscribePost	POST /webhook/subscribe	Subscribe To Webhook
WebhooksApi	webhookUnsubscribePost	POST /webhook/unsubscribe	Unsubscribe from Webhook
WebhooksApi	webhooksGet	GET /webhooks	Get Webhooks List
WizardApi	businessesBusinessIdWizardsGet	GET /businesses/{business_id}/wizards	Gets a list of wizards
WizardApi	businessesBusinessIdWizardsWizardNameGet	GET /businesses/{business_id}/wizards/{wizard_name}	Gets a wizard by name
WizardApi	businessesBusinessIdWizardsWizardNamePut	PUT /businesses/{business_id}/wizards/{wizard_name}	Update a wizard

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

default

Type: OAuth
Flow: implicit
Authorization URL: https://ignore.myclients.io
Scopes:
- platform: All platform related operations
- platform_create: platform create scope
- platform_delete: platform delete scope
- platform_read: platform read scope
- platform_update: platform update scope

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

simonit / vcita-platform-java-sdk Goto Github PK