postboost 1.0.0 → 1.14.0

data/lib/postboost/api/posting_schedule_api.rb

@@ -0,0 +1,389 @@
+=begin
+#PostBoost API
+
+#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
+
+The version of the OpenAPI document: 1.14.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module PostBoost
+  class PostingScheduleApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get the posting schedule
+    # The queue's posting times: per weekday, a list of clock times in the schedule's timezone. `account_id=0` is the workspace schedule. An account without its own schedule follows the workspace one (`inherited: true`, `source_account_id: 0`). Posts added to the queue take the next free time. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`. (default to 0)
+    # @return [GetPostingSchedule200Response]
+    def get_posting_schedule(workspace_uuid, opts = {})
+      data, _status_code, _headers = get_posting_schedule_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # Get the posting schedule
+    # The queue's posting times: per weekday, a list of clock times in the schedule's timezone. `account_id=0` is the workspace schedule. An account without its own schedule follows the workspace one (`inherited: true`, `source_account_id: 0`). Posts added to the queue take the next free time. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`. (default to 0)
+    # @return [Array<(GetPostingSchedule200Response, Integer, Hash)>] GetPostingSchedule200Response data, response status code and response headers
+    def get_posting_schedule_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostingScheduleApi.get_posting_schedule ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling PostingScheduleApi.get_posting_schedule"
+      end
+      if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling PostingScheduleApi.get_posting_schedule, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/{workspaceUuid}/posting-schedule'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetPostingSchedule200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostingScheduleApi.get_posting_schedule",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostingScheduleApi#get_posting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get recommended posting times
+    # Suggested posting times from past engagement, in the schedule's timezone. `has_data` is false until there is enough analytics history. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id &#x60;0&#x60; (default) for the workspace schedule, or an account &#x60;id&#x60;. (default to 0)
+    # @option opts [Integer] :slots_per_day Times to suggest per day (1 to 6).
+    # @return [RecommendedPostingTimes]
+    def get_recommended_posting_times(workspace_uuid, opts = {})
+      data, _status_code, _headers = get_recommended_posting_times_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # Get recommended posting times
+    # Suggested posting times from past engagement, in the schedule&#39;s timezone. &#x60;has_data&#x60; is false until there is enough analytics history. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id &#x60;0&#x60; (default) for the workspace schedule, or an account &#x60;id&#x60;. (default to 0)
+    # @option opts [Integer] :slots_per_day Times to suggest per day (1 to 6).
+    # @return [Array<(RecommendedPostingTimes, Integer, Hash)>] RecommendedPostingTimes data, response status code and response headers
+    def get_recommended_posting_times_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostingScheduleApi.get_recommended_posting_times ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling PostingScheduleApi.get_recommended_posting_times"
+      end
+      if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling PostingScheduleApi.get_recommended_posting_times, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'slots_per_day'].nil? && opts[:'slots_per_day'] > 6
+        fail ArgumentError, 'invalid value for "opts[:"slots_per_day"]" when calling PostingScheduleApi.get_recommended_posting_times, must be smaller than or equal to 6.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'slots_per_day'].nil? && opts[:'slots_per_day'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"slots_per_day"]" when calling PostingScheduleApi.get_recommended_posting_times, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/{workspaceUuid}/posting-schedule/recommended'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      query_params[:'slots_per_day'] = opts[:'slots_per_day'] if !opts[:'slots_per_day'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RecommendedPostingTimes'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostingScheduleApi.get_recommended_posting_times",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostingScheduleApi#get_recommended_posting_times\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List upcoming queue slots
+    # The queue read forward: upcoming posting times, filled by scheduled posts where they land on one. Page with `after` set to the previous `next_cursor`. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id &#x60;0&#x60; (default) for the workspace schedule, or an account &#x60;id&#x60;. (default to 0)
+    # @option opts [String] :after Start after this time (&#x60;Y-m-d H:i:s&#x60;, UTC), from &#x60;next_cursor&#x60;.
+    # @return [QueueSlots]
+    def list_queue_slots(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_queue_slots_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List upcoming queue slots
+    # The queue read forward: upcoming posting times, filled by scheduled posts where they land on one. Page with &#x60;after&#x60; set to the previous &#x60;next_cursor&#x60;. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id &#x60;0&#x60; (default) for the workspace schedule, or an account &#x60;id&#x60;. (default to 0)
+    # @option opts [String] :after Start after this time (&#x60;Y-m-d H:i:s&#x60;, UTC), from &#x60;next_cursor&#x60;.
+    # @return [Array<(QueueSlots, Integer, Hash)>] QueueSlots data, response status code and response headers
+    def list_queue_slots_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostingScheduleApi.list_queue_slots ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling PostingScheduleApi.list_queue_slots"
+      end
+      if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling PostingScheduleApi.list_queue_slots, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/{workspaceUuid}/queue/slots'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'QueueSlots'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostingScheduleApi.list_queue_slots",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostingScheduleApi#list_queue_slots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reset an account schedule
+    # Removes the account's own schedule so it follows the workspace schedule again. Workspace admins only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_id [Integer] The account &#x60;id&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [GetPostingSchedule200Response]
+    def reset_account_posting_schedule(workspace_uuid, account_id, opts = {})
+      data, _status_code, _headers = reset_account_posting_schedule_with_http_info(workspace_uuid, account_id, opts)
+      data
+    end
+
+    # Reset an account schedule
+    # Removes the account&#39;s own schedule so it follows the workspace schedule again. Workspace admins only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_id [Integer] The account &#x60;id&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetPostingSchedule200Response, Integer, Hash)>] GetPostingSchedule200Response data, response status code and response headers
+    def reset_account_posting_schedule_with_http_info(workspace_uuid, account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostingScheduleApi.reset_account_posting_schedule ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling PostingScheduleApi.reset_account_posting_schedule"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling PostingScheduleApi.reset_account_posting_schedule"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/posting-schedule/{accountId}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetPostingSchedule200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostingScheduleApi.reset_account_posting_schedule",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostingScheduleApi#reset_account_posting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set the posting schedule
+    # Sets the workspace schedule (`account_id: 0`) or gives one account its own schedule. Send all seven weekdays (ids 1 to 6 for Monday to Saturday, 0 for Sunday). Workspace admins only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param posting_schedule_input [PostingScheduleInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetPostingSchedule200Response]
+    def update_posting_schedule(workspace_uuid, posting_schedule_input, opts = {})
+      data, _status_code, _headers = update_posting_schedule_with_http_info(workspace_uuid, posting_schedule_input, opts)
+      data
+    end
+
+    # Set the posting schedule
+    # Sets the workspace schedule (&#x60;account_id: 0&#x60;) or gives one account its own schedule. Send all seven weekdays (ids 1 to 6 for Monday to Saturday, 0 for Sunday). Workspace admins only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param posting_schedule_input [PostingScheduleInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetPostingSchedule200Response, Integer, Hash)>] GetPostingSchedule200Response data, response status code and response headers
+    def update_posting_schedule_with_http_info(workspace_uuid, posting_schedule_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostingScheduleApi.update_posting_schedule ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling PostingScheduleApi.update_posting_schedule"
+      end
+      # verify the required parameter 'posting_schedule_input' is set
+      if @api_client.config.client_side_validation && posting_schedule_input.nil?
+        fail ArgumentError, "Missing the required parameter 'posting_schedule_input' when calling PostingScheduleApi.update_posting_schedule"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/posting-schedule'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(posting_schedule_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetPostingSchedule200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostingScheduleApi.update_posting_schedule",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostingScheduleApi#update_posting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end