phraseapp-ruby 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d9dc0440453570884c48f8f79637de7c4924ec4
-  data.tar.gz: b6b643ca67f10a0b7110f27af458bd1dae412849
+  metadata.gz: 25921bb893225a9ef21c85046e647de542557af1
+  data.tar.gz: d29d544f6d6d34cc9cf8ae81b1a9c283a70279cb
 SHA512:
-  metadata.gz: b570fd7082d4a48f350d27c65d45961864570e1d70d2b4a6a62f588dc686573ac7131a4d0fa3a630f3bc397044b36d247b9013a0e0bfd42c3984a07c4ecca525
-  data.tar.gz: 9deeac180cb9a314f7cb3cfefdf5a4c5dc3347120e68f4a8f1cb7bd9b6adc50c4812452e95a0e7f52d8c51cec2a595ee44fe9f61f4ab22f96944b2cf8ffbe9df
+  metadata.gz: 23735c1093ad73ff464026f1fbdf144ab722932dd7cce774aebff95c58d2faf6f7342ea5531292d719baa83095eee08e2f3d73b2d5e78cd03a69a16fb6a48f8f
+  data.tar.gz: f96913fc0719528415c33878cbba35bea3c97c4c07074c7a61ff8675a146b6b22f1d3e36396280a6a79e0c7c78859d769b91cddaaa50a13ed2ec9f70177b99e8

data/lib/phraseapp-ruby.rb

@@ -1,7 +1,6 @@
 
-# revision_docs:d104be46bd36f220e2df166ba7d3adb7ee9b1005
-# revision_generator:HEAD/2016-04-20T163945/sacry1
-
+# revision_docs:4fc36062055363b8fc3e56e08ff53a29eed057ad
+# revision_generator:8509abb5f6ffe365e0c33db40f00f3db0a450671
 require 'ostruct'
 require 'net/https'
 require 'uri'
@@ -30,15 +29,7 @@ module PhraseApp
 
 module ResponseObjects
     class Account < ::OpenStruct
-      #created_at, id, name, updated_at, 
-      def initialize(hash)
-        super(hash)
-        PhraseApp.handle_times(self)
-      end
-    end
-
-    class AccountPreview < ::OpenStruct
-      #created_at, id, name, updated_at, 
+      #company, created_at, id, name, updated_at, 
       def initialize(hash)
         super(hash)
         PhraseApp.handle_times(self)
@@ -101,6 +92,14 @@ module ResponseObjects
       end
     end
 
+    class Invitation < ::OpenStruct
+      #accepted_at, created_at, email, id, locales, projects, role, state, updated_at, 
+      def initialize(hash)
+        super(hash)
+        PhraseApp.handle_times(self)
+      end
+    end
+
     class KeyPreview < ::OpenStruct
       #id, name, plural, 
       def initialize(hash)
@@ -141,6 +140,14 @@ module ResponseObjects
       end
     end
 
+    class Member < ::OpenStruct
+      #email, id, projects, role, username, 
+      def initialize(hash)
+        super(hash)
+        PhraseApp.handle_times(self)
+      end
+    end
+
     class Project < ::OpenStruct
       #account, created_at, id, main_format, name, updated_at, 
       def initialize(hash)
@@ -157,6 +164,22 @@ module ResponseObjects
       end
     end
 
+    class ProjectShort < ::OpenStruct
+      #created_at, id, main_format, name, updated_at, 
+      def initialize(hash)
+        super(hash)
+        PhraseApp.handle_times(self)
+      end
+    end
+
+    class ProjectLocales < ProjectShort
+      #locales, 
+      def initialize(hash)
+        super(hash)
+        PhraseApp.handle_times(self)
+      end
+    end
+
     class StatisticsListItem < ::OpenStruct
       #locale, statistics, 
       def initialize(hash)
@@ -530,6 +553,10 @@ module RequestParams
   #   Indicates whether locale is a RTL (Right-to-Left) locale.
   # source_locale_id::
   #   Source locale. Can be the name or public id of the locale. Preferred is the public id.
+  # unverify_new_translations::
+  #   Indicates that new translations for this locale should be marked as unverified.
+  # unverify_updated_translations::
+  #   Indicates that updated translations for this locale should be marked as unverified.
   class LocaleParams < ::OpenStruct
 
     def code=(val)
@@ -574,6 +601,26 @@ module RequestParams
       super(val)
     end
 
+    def unverify_new_translations=(val)
+      if val.is_a?(TrueClass)
+        super(true)
+      elsif val.is_a?(FalseClass)
+        return
+      else
+        PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
+      end
+    end
+
+    def unverify_updated_translations=(val)
+      if val.is_a?(TrueClass)
+        super(true)
+      elsif val.is_a?(FalseClass)
+        return
+      else
+        PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
+      end
+    end
+
     def validate
       
       if code == nil || code == "" 
@@ -1148,6 +1195,83 @@ module PhraseApp
 
   
 
+module RequestParams
+  # InvitationCreateParams
+  # == Parameters:
+  # email::
+  #   The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email.
+  # locale_ids::
+  #   List of locale ids the invited user has access to.
+  # project_ids::
+  #   List of project ids the invited user has access to.
+  # role::
+  #   Invitiation role, can be any of Manager, Developer, Translator.
+  class InvitationCreateParams < ::OpenStruct
+
+    def email=(val)
+      super(val)
+    end
+
+    def locale_ids=(val)
+      super(val)
+    end
+
+    def project_ids=(val)
+      super(val)
+    end
+
+    def role=(val)
+      super(val)
+    end
+
+    def validate
+      
+      if email == nil || email == "" 
+        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"email\" of \"invitation_createParams\" not set")
+      end
+      if role == nil || role == "" 
+        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"role\" of \"invitation_createParams\" not set")
+      end
+    end
+
+  end
+end
+
+
+module RequestParams
+  # InvitationUpdateParams
+  # == Parameters:
+  # locale_ids::
+  #   List of locale ids the invited user has access to
+  # project_ids::
+  #   List of project ids the invited user has access to
+  # role::
+  #   Invitiation role, can be any of Manager, Developer, Translator
+  class InvitationUpdateParams < ::OpenStruct
+
+    def locale_ids=(val)
+      super(val)
+    end
+
+    def project_ids=(val)
+      super(val)
+    end
+
+    def role=(val)
+      super(val)
+    end
+
+    def validate
+      
+      if role == nil || role == "" 
+        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"role\" of \"invitation_updateParams\" not set")
+      end
+    end
+
+  end
+end
+
+
 module RequestParams
   # KeysDeleteParams
   # == Parameters:
@@ -1409,6 +1533,40 @@ module RequestParams
 end
 
 
+module RequestParams
+  # MemberUpdateParams
+  # == Parameters:
+  # locale_ids::
+  #   List of locale ids the user has access to.
+  # project_ids::
+  #   List of project ids the user has access to. 
+  # role::
+  #   Member role, can be any of of Manager, Developer, Translator
+  class MemberUpdateParams < ::OpenStruct
+
+    def locale_ids=(val)
+      super(val)
+    end
+
+    def project_ids=(val)
+      super(val)
+    end
+
+    def role=(val)
+      super(val)
+    end
+
+    def validate
+      
+      if role == nil || role == "" 
+        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"role\" of \"member_updateParams\" not set")
+      end
+    end
+
+  end
+end
+
+
 module RequestParams
   # TranslationUpdateParams
   # == Parameters:
@@ -1730,6 +1888,50 @@ end
     end
 
   
+    # Get details on a single account.
+    # API Path: /v2/accounts/:id
+    # == Parameters:
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Account
+    #   err
+    def account_show(id)
+      path = sprintf("/api/v2/accounts/%s", id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Account.new(JSON.load(rc.body)), err
+    end
+  
+    # List all accounts the current user has access to.
+    # API Path: /v2/accounts
+    # == Parameters:
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Account
+    #   err
+    def accounts_list(page, per_page)
+      path = sprintf("/api/v2/accounts")
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page)
+      if err != nil
+        return nil, err
+      end
+      
+      return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Account.new(item) }, err
+    end
+  
     # Create a new authorization.
     # API Path: /v2/authorizations
     # == Parameters:
@@ -2267,6 +2469,177 @@ end
       return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Format.new(item) }, err
     end
   
+    # Invite a person to an account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them.
+    # API Path: /v2/accounts/:account_id/invitations
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # params::
+    #   Parameters of type PhraseApp::RequestParams::InvitationCreateParams
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Invitation
+    #   err
+    def invitation_create(account_id, params)
+      path = sprintf("/api/v2/accounts/%s/invitations", account_id)
+      data_hash = {}
+      post_body = nil
+  
+      if params.present?
+        unless params.kind_of?(PhraseApp::RequestParams::InvitationCreateParams)
+          raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::InvitationCreateParams")
+        end
+      end
+  
+      data_hash = params.to_h
+      err = params.validate
+      if err != nil
+        return nil, err
+      end
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err
+    end
+  
+    # Delete an existing invitation (must not be accepted yet).
+    # API Path: /v2/accounts/:account_id/invitations/:id
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   err
+    def invitation_delete(account_id, id)
+      path = sprintf("/api/v2/accounts/%s/invitations/%s", account_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204)
+      if err != nil
+        return nil, err
+      end
+      
+      return err
+    end
+  
+    # Resend the invitation email (must not be accepted yet).
+    # API Path: /v2/accounts/:account_id/invitations/:id/resend
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Invitation
+    #   err
+    def invitation_resend(account_id, id)
+      path = sprintf("/api/v2/accounts/%s/invitations/%s/resend", account_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err
+    end
+  
+    # Get details on a single invitation.
+    # API Path: /v2/accounts/:account_id/invitations/:id
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Invitation
+    #   err
+    def invitation_show(account_id, id)
+      path = sprintf("/api/v2/accounts/%s/invitations/%s", account_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err
+    end
+  
+    # Update an existing invitation (must not be accepted yet). The <code>email</code> cannot be updated. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them.
+    # API Path: /v2/accounts/:account_id/invitations/:id
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # id::
+    #   id
+    # params::
+    #   Parameters of type PhraseApp::RequestParams::InvitationUpdateParams
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Invitation
+    #   err
+    def invitation_update(account_id, id, params)
+      path = sprintf("/api/v2/accounts/%s/invitations/%s", account_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      if params.present?
+        unless params.kind_of?(PhraseApp::RequestParams::InvitationUpdateParams)
+          raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::InvitationUpdateParams")
+        end
+      end
+  
+      data_hash = params.to_h
+      err = params.validate
+      if err != nil
+        return nil, err
+      end
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err
+    end
+  
+    # List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used.
+    # API Path: /v2/accounts/:account_id/invitations
+    # == Parameters:
+    # account_id::
+    #   account_id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Invitation
+    #   err
+    def invitations_list(account_id, page, per_page)
+      path = sprintf("/api/v2/accounts/%s/invitations", account_id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page)
+      if err != nil
+        return nil, err
+      end
+      
+      return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Invitation.new(item) }, err
+    end
+  
     # Create a new key.
     # API Path: /v2/projects/:project_id/keys
     # == Parameters:
@@ -2869,6 +3242,116 @@ end
       return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Locale.new(item) }, err
     end
   
+    # Remove a user from the account. The user will be removed from the account but not deleted from PhraseApp.
+    # API Path: /v2/accounts/:account_id/members/:id
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   err
+    def member_delete(account_id, id)
+      path = sprintf("/api/v2/accounts/%s/members/%s", account_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204)
+      if err != nil
+        return nil, err
+      end
+      
+      return err
+    end
+  
+    # Get details on a single user in the account.
+    # API Path: /v2/accounts/:account_id/members/:id
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Member
+    #   err
+    def member_show(account_id, id)
+      path = sprintf("/api/v2/accounts/%s/members/%s", account_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Member.new(JSON.load(rc.body)), err
+    end
+  
+    # Update user permissions in the account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them.
+    # API Path: /v2/accounts/:account_id/members/:id
+    # == Parameters:
+    # account_id::
+    #   account_id
+    # id::
+    #   id
+    # params::
+    #   Parameters of type PhraseApp::RequestParams::MemberUpdateParams
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Member
+    #   err
+    def member_update(account_id, id, params)
+      path = sprintf("/api/v2/accounts/%s/members/%s", account_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      if params.present?
+        unless params.kind_of?(PhraseApp::RequestParams::MemberUpdateParams)
+          raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::MemberUpdateParams")
+        end
+      end
+  
+      data_hash = params.to_h
+      err = params.validate
+      if err != nil
+        return nil, err
+      end
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Member.new(JSON.load(rc.body)), err
+    end
+  
+    # Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used.
+    # API Path: /v2/accounts/:account_id/members
+    # == Parameters:
+    # account_id::
+    #   account_id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Member
+    #   err
+    def members_list(account_id, page, per_page)
+      path = sprintf("/api/v2/accounts/%s/members", account_id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page)
+      if err != nil
+        return nil, err
+      end
+      
+      return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Member.new(item) }, err
+    end
+  
     # Confirm an existing order and send it to the provider for translation. Same constraints as for create.
     # API Path: /v2/projects/:project_id/orders/:id/confirm
     # == Parameters:

data/lib/phraseapp-ruby/version.rb

@@ -1,3 +1,3 @@
 module PhraseApp
-  VERSION = '1.2.7'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0
 platform: ruby
 authors:
 - PhraseApp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies: []
 description: PhraseApp API client libary
 email:
@@ -41,9 +41,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Interact with the PhraseApp API
 test_files: []
-has_rdoc: