gohighlevel 0.0.1

data/lib/high_level/resources/objects.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/objects.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class Objects < Base
+      # Get Object Schema by key / id
+      #
+      # Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
+      def get_object_schema_by_key(key:, location_id: nil, fetch_properties: nil, **_opts)
+        request(
+          method: :get,
+          path: "/objects/#{key}",
+          security: ["bearer"],
+          params: { "locationId" => location_id, "fetchProperties" => fetch_properties }.compact
+        )
+      end
+
+      # Update Object Schema By Key / Id
+      #
+      # Update Custom Object Schema  or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
+      def update_custom_object(key:, body:, **_opts)
+        request(
+          method: :put,
+          path: "/objects/#{key}",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Get Record By Id
+      #
+      # Allows you to get a Standard Object like business and custom object record by Id
+      def get_record_by_id(schema_key:, id:, **_opts)
+        request(
+          method: :get,
+          path: "/objects/#{schema_key}/records/#{id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Update Record
+      #
+      # Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296
+      def update_object_record(schema_key:, id:, body:, location_id: nil, **_opts)
+        request(
+          method: :put,
+          path: "/objects/#{schema_key}/records/#{id}",
+          security: ["bearer"],
+          params: { "locationId" => location_id }.compact,
+          body: body
+        )
+      end
+
+      # Delete Record
+      #
+      # Delete Record By Id . Supported Objects are business and custom objects.
+      def delete_object_record(schema_key:, id:, **_opts)
+        request(
+          method: :delete,
+          path: "/objects/#{schema_key}/records/#{id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Create Record
+      #
+      # Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296
+      def create_object_record(schema_key:, body:, **_opts)
+        request(
+          method: :post,
+          path: "/objects/#{schema_key}/records",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Search Object Records
+      #
+      # Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336
+      def search_object_records(schema_key:, body:, **_opts)
+        request(
+          method: :post,
+          path: "/objects/#{schema_key}/records/search",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Get all objects for a location
+      #
+      # Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
+      def get_object_by_location_id(location_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/objects/",
+          security: ["bearer"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # Create Custom Object
+      #
+      # Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
+      def create_custom_object_schema(body:, **_opts)
+        request(
+          method: :post,
+          path: "/objects/",
+          security: ["Agency-Access"],
+          body: body
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/opportunities.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/opportunities.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class Opportunities < Base
+      # Get lost reason
+      def get_lost_reason(location_id: nil, name: nil, deleted: nil, query: nil, skip: nil, limit: nil, get_count: nil, **_opts)
+        request(
+          method: :get,
+          path: "/opportunities/lost-reason",
+          security: ["bearer"],
+          params: { "locationId" => location_id, "name" => name, "deleted" => deleted, "query" => query, "skip" => skip, "limit" => limit, "getCount" => get_count }.compact
+        )
+      end
+
+      # Search Opportunity
+      def search_opportunity(q: nil, location_id: nil, pipeline_id: nil, pipeline_stage_id: nil, contact_id: nil, status: nil, assigned_to: nil, campaign_id: nil, id: nil, order: nil, end_date: nil, start_after: nil, start_after_id: nil, date: nil, country: nil, page: nil, limit: nil, get_tasks: nil, get_notes: nil, get_calendar_events: nil, **_opts)
+        request(
+          method: :get,
+          path: "/opportunities/search",
+          security: ["bearer"],
+          params: { "q" => q, "location_id" => location_id, "pipeline_id" => pipeline_id, "pipeline_stage_id" => pipeline_stage_id, "contact_id" => contact_id, "status" => status, "assigned_to" => assigned_to, "campaignId" => campaign_id, "id" => id, "order" => order, "endDate" => end_date, "startAfter" => start_after, "startAfterId" => start_after_id, "date" => date, "country" => country, "page" => page, "limit" => limit, "getTasks" => get_tasks, "getNotes" => get_notes, "getCalendarEvents" => get_calendar_events }.compact
+        )
+      end
+
+      # Search Opportunities
+      #
+      # Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f
+      def search_opportunities_advanced(body:, **_opts)
+        request(
+          method: :post,
+          path: "/opportunities/search",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Get Pipelines
+      def get_pipelines(location_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/opportunities/pipelines",
+          security: ["bearer"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # Get Opportunity
+      def get_opportunity(id:, **_opts)
+        request(
+          method: :get,
+          path: "/opportunities/#{id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Update Opportunity
+      def update_opportunity(id:, body:, **_opts)
+        request(
+          method: :put,
+          path: "/opportunities/#{id}",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Delete Opportunity
+      def delete_opportunity(id:, **_opts)
+        request(
+          method: :delete,
+          path: "/opportunities/#{id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Update Opportunity Status
+      def update_opportunity_status(id:, body:, **_opts)
+        request(
+          method: :put,
+          path: "/opportunities/#{id}/status",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Upsert Opportunity
+      def upsert_opportunity(body:, **_opts)
+        request(
+          method: :post,
+          path: "/opportunities/upsert",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Add Followers
+      def add_followers_opportunity(id:, body:, **_opts)
+        request(
+          method: :post,
+          path: "/opportunities/#{id}/followers",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Remove Followers
+      #
+      # Allows removal of one or all followers from an opportunity.
+      def remove_followers_opportunity(id:, body:, is_remove_all_followers: nil, **_opts)
+        request(
+          method: :delete,
+          path: "/opportunities/#{id}/followers",
+          security: ["bearer"],
+          params: { "isRemoveAllFollowers" => is_remove_all_followers }.compact,
+          body: body
+        )
+      end
+
+      # Create Opportunity
+      def create_opportunity(body:, **_opts)
+        request(
+          method: :post,
+          path: "/opportunities/",
+          security: ["bearer"],
+          body: body
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/payments.rb

@@ -0,0 +1,289 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/payments.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class Payments < Base
+      # List White-label Integration Providers
+      #
+      # The "List White-label Integration Providers" API allows to retrieve a paginated list of integration providers. Customize your results by filtering whitelabel integration providers(which are built directly on top of Authorize.net or NMI) based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve integration provider information.
+      def list_integration_providers(alt_id: nil, alt_type: nil, limit: nil, offset: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/integrations/provider/whitelabel",
+          security: ["Location-Access"],
+          params: { "altId" => alt_id, "altType" => alt_type, "limit" => limit, "offset" => offset }.compact
+        )
+      end
+
+      # Create White-label Integration Provider
+      #
+      # The "Create White-label Integration Provider" API allows adding a new payment provider integration to the system which is built on top of Authorize.net or NMI. Use this endpoint to create a integration provider with the specified details. Ensure that the required information is provided in the request payload. This endpoint can be only invoked using marketplace-app token
+      def create_integration_provider(body:, **_opts)
+        request(
+          method: :post,
+          path: "/payments/integrations/provider/whitelabel",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # List Orders
+      #
+      # The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information.
+      def list_orders(location_id: nil, alt_id: nil, status: nil, payment_status: nil, payment_mode: nil, start_at: nil, end_at: nil, search: nil, contact_id: nil, funnel_product_ids: nil, source_id: nil, limit: nil, offset: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/orders",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "altId" => alt_id, "status" => status, "paymentStatus" => payment_status, "paymentMode" => payment_mode, "startAt" => start_at, "endAt" => end_at, "search" => search, "contactId" => contact_id, "funnelProductIds" => funnel_product_ids, "sourceId" => source_id, "limit" => limit, "offset" => offset }.compact
+        )
+      end
+
+      # Get Order by ID
+      #
+      # The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID.
+      def get_order_by_id(order_id:, location_id: nil, alt_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/orders/#{order_id}",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "altId" => alt_id }.compact
+        )
+      end
+
+      # Record Order Payment
+      #
+      # The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid".
+      def record_order_payment(order_id:, body:, **_opts)
+        request(
+          method: :post,
+          path: "/payments/orders/#{order_id}/record-payment",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # List fulfillment
+      #
+      # List all fulfillment history of an order
+      def list_order_fulfillment(order_id:, alt_id: nil, alt_type: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/orders/#{order_id}/fulfillments",
+          security: ["Location-Access"],
+          params: { "altId" => alt_id, "altType" => alt_type }.compact
+        )
+      end
+
+      # Create order fulfillment
+      #
+      # The "Order Fulfillment" API facilitates the process of fulfilling an order.
+      def create_order_fulfillment(order_id:, body:, **_opts)
+        request(
+          method: :post,
+          path: "/payments/orders/#{order_id}/fulfillments",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # List Order Notes
+      #
+      # List all notes of an order
+      def list_order_notes(order_id:, alt_id: nil, alt_type: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/orders/#{order_id}/notes",
+          security: ["Location-Access"],
+          params: { "altId" => alt_id, "altType" => alt_type }.compact
+        )
+      end
+
+      # List Transactions
+      #
+      # The "List Transactions" API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range, type of source, contact, subscription id, entity id or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve transaction information.
+      def list_transactions(location_id: nil, alt_id: nil, alt_type: nil, payment_mode: nil, start_at: nil, end_at: nil, entity_source_type: nil, entity_source_sub_type: nil, search: nil, subscription_id: nil, entity_id: nil, contact_id: nil, limit: nil, offset: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/transactions",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "altId" => alt_id, "altType" => alt_type, "paymentMode" => payment_mode, "startAt" => start_at, "endAt" => end_at, "entitySourceType" => entity_source_type, "entitySourceSubType" => entity_source_sub_type, "search" => search, "subscriptionId" => subscription_id, "entityId" => entity_id, "contactId" => contact_id, "limit" => limit, "offset" => offset }.compact
+        )
+      end
+
+      # Get Transaction by ID
+      #
+      # The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for a single transaction based on the provided transaction ID.
+      def get_transaction_by_id(transaction_id:, location_id: nil, alt_id: nil, alt_type: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/transactions/#{transaction_id}",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "altId" => alt_id, "altType" => alt_type }.compact
+        )
+      end
+
+      # List Subscriptions
+      #
+      # The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date range, type of source, contact, subscription id, entity id, contact or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve subscription information.
+      def list_subscriptions(alt_id: nil, alt_type: nil, entity_id: nil, payment_mode: nil, start_at: nil, end_at: nil, entity_source_type: nil, search: nil, contact_id: nil, id: nil, limit: nil, offset: nil, get_payments_collected_count: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/subscriptions",
+          security: ["Location-Access"],
+          params: { "altId" => alt_id, "altType" => alt_type, "entityId" => entity_id, "paymentMode" => payment_mode, "startAt" => start_at, "endAt" => end_at, "entitySourceType" => entity_source_type, "search" => search, "contactId" => contact_id, "id" => id, "limit" => limit, "offset" => offset, "getPaymentsCollectedCount" => get_payments_collected_count }.compact
+        )
+      end
+
+      # Get Subscription by ID
+      #
+      # The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provided subscription ID.
+      def get_subscription_by_id(subscription_id:, alt_id: nil, alt_type: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/subscriptions/#{subscription_id}",
+          security: ["Location-Access"],
+          params: { "altId" => alt_id, "altType" => alt_type }.compact
+        )
+      end
+
+      # List Coupons
+      #
+      # The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special discounts for your customers.
+      def list_coupons(alt_id: nil, alt_type: nil, limit: nil, offset: nil, status: nil, search: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/coupon/list",
+          security: ["Location-Access"],
+          params: { "altId" => alt_id, "altType" => alt_type, "limit" => limit, "offset" => offset, "status" => status, "search" => search }.compact
+        )
+      end
+
+      # Fetch Coupon
+      #
+      # The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods, and other promotional details.
+      def get_coupon(alt_id: nil, alt_type: nil, id: nil, code: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/coupon",
+          security: ["Location-Access"],
+          params: { "altId" => alt_id, "altType" => alt_type, "id" => id, "code" => code }.compact
+        )
+      end
+
+      # Create Coupon
+      #
+      # The "Create Coupon" API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and applicable products. Use this endpoint to set up promotional offers and special discounts for your customers.
+      def create_coupon(body:, **_opts)
+        request(
+          method: :post,
+          path: "/payments/coupon",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # Update Coupon
+      #
+      # The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters. Use this endpoint to adjust or extend promotional offers for your customers.
+      def update_coupon(body:, **_opts)
+        request(
+          method: :put,
+          path: "/payments/coupon",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # Delete Coupon
+      #
+      # The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone.
+      def delete_coupon(body:, **_opts)
+        request(
+          method: :delete,
+          path: "/payments/coupon",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # Create new integration
+      #
+      # API to create a new association for an app and location
+      def create_integration(body:, location_id: nil, **_opts)
+        request(
+          method: :post,
+          path: "/payments/custom-provider/provider",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id }.compact,
+          body: body
+        )
+      end
+
+      # Deleting an existing integration
+      #
+      # API to delete an association for an app and location
+      def delete_integration(location_id: nil, **_opts)
+        request(
+          method: :delete,
+          path: "/payments/custom-provider/provider",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # Fetch given provider config
+      #
+      # API for fetching an existing payment config for given location
+      def fetch_config(location_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/payments/custom-provider/connect",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # Create new provider config
+      #
+      # API to create a new payment config for given location
+      def create_config(body:, location_id: nil, **_opts)
+        request(
+          method: :post,
+          path: "/payments/custom-provider/connect",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id }.compact,
+          body: body
+        )
+      end
+
+      # Disconnect existing provider config
+      #
+      # API to disconnect an existing payment config for given location
+      def disconnect_config(body:, location_id: nil, **_opts)
+        request(
+          method: :post,
+          path: "/payments/custom-provider/disconnect",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id }.compact,
+          body: body
+        )
+      end
+
+      # Custom-provider marketplace app update capabilities
+      #
+      # Toggle capabilities for the marketplace app tied to the OAuth client
+      def custom_provider_marketplace_app_update_capabilities(body:, **_opts)
+        request(
+          method: :put,
+          path: "/payments/custom-provider/capabilities",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/phone_system.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/phone-system.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class PhoneSystem < Base
+      # List Number Pools
+      #
+      # Get list of number pools
+      def get_number_pool_list(location_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/phone-system/number-pools",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # List available phone numbers
+      #
+      # Search for available phone numbers to purchase for a specific location. Supports filtering by number pattern, type, and capabilities.
+      def available_numbers(location_id:, country_code: nil, number_types: nil, first_part: nil, last_part: nil, anywhere: nil, sms_enabled: nil, mms_enabled: nil, voice_enabled: nil, **_opts)
+        request(
+          method: :get,
+          path: "/phone-system/numbers/location/#{location_id}/available",
+          security: ["Location-Access"],
+          params: { "countryCode" => country_code, "numberTypes" => number_types, "firstPart" => first_part, "lastPart" => last_part, "anywhere" => anywhere, "smsEnabled" => sms_enabled, "mmsEnabled" => mms_enabled, "voiceEnabled" => voice_enabled }.compact
+        )
+      end
+
+      # Purchase a phone number
+      #
+      # Purchase a phone number for a specific location.
+      def purchase_phone_number(location_id:, body:, **_opts)
+        request(
+          method: :post,
+          path: "/phone-system/numbers/location/#{location_id}/purchase",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # List active numbers
+      #
+      # Retrieve a paginated list of active phone numbers for a specific location. Supports filtering, pagination, and optional exclusion of number pool assignments.
+      def active_numbers(location_id:, page_size: nil, page: nil, search_filter: nil, skip_number_pool: nil, **_opts)
+        request(
+          method: :get,
+          path: "/phone-system/numbers/location/#{location_id}",
+          security: ["Location-Access"],
+          params: { "pageSize" => page_size, "page" => page, "searchFilter" => search_filter, "skipNumberPool" => skip_number_pool }.compact
+        )
+      end
+    end
+  end
+end